|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.quartercode.quarterbukkit.util.Metrics
public class Metrics
The metrics class obtains data about a plugin and submits statistics about it to the metrics backend.
Public methods provided by this class:
Graph createGraph(String name);
void addCustomData(BukkitMetrics.Plotter plotter);
void start();
Nested Class Summary | |
---|---|
static class |
Metrics.Graph
Represents a custom graph on the website |
static class |
Metrics.Plotter
Interface used to collect custom data for a plugin |
Constructor Summary | |
---|---|
Metrics(org.bukkit.plugin.Plugin plugin)
|
Method Summary | |
---|---|
void |
addCustomData(Metrics.Plotter plotter)
Adds a custom data plotter to the default graph |
void |
addGraph(Metrics.Graph graph)
Add a Graph object to BukkitMetrics that represents data for the plugin that should be sent to the backend |
Metrics.Graph |
createGraph(java.lang.String name)
Construct and create a Graph that can be used to separate specific plotters to their own graphs on the metrics website. |
void |
disable()
Disables metrics for the server by setting "opt-out" to true in the config file and canceling the metrics task. |
void |
enable()
Enables metrics for the server by setting "opt-out" to false in the config file and starting the metrics task. |
java.io.File |
getConfigFile()
Gets the File object of the config file that should be used to store data such as the GUID and opt-out status |
boolean |
isOptOut()
Has the server owner denied plugin metrics? |
boolean |
start()
Start measuring statistics. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public Metrics(org.bukkit.plugin.Plugin plugin) throws java.io.IOException
java.io.IOException
Method Detail |
---|
public Metrics.Graph createGraph(java.lang.String name)
name
- The name of the graph
public void addGraph(Metrics.Graph graph)
graph
- The name of the graphpublic void addCustomData(Metrics.Plotter plotter)
plotter
- The plotter to use to plot custom datapublic boolean start()
public boolean isOptOut()
public void enable() throws java.io.IOException
java.io.IOException
public void disable() throws java.io.IOException
java.io.IOException
public java.io.File getConfigFile()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |