2013-01-10 00:58:34 +01:00
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
< html lang = "en" >
< head >
2013-01-22 13:29:54 +01:00
<!-- Generated by javadoc (version 1.7.0_07) on Tue Jan 22 13:27:27 CET 2013 -->
2013-01-10 00:58:34 +01:00
< title > Metrics.Plotter< / title >
2013-01-22 13:29:54 +01:00
< meta name = "date" content = "2013-01-22" >
2013-01-10 00:58:34 +01:00
< link rel = "stylesheet" type = "text/css" href = "../../../../stylesheet.css" title = "Style" >
< / head >
< body >
< script type = "text/javascript" > < ! - -
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Metrics.Plotter";
}
//-->
< / script >
< noscript >
< div > JavaScript is disabled on your browser.< / div >
< / noscript >
<!-- ========= START OF TOP NAVBAR ======= -->
< div class = "topNav" > < a name = "navbar_top" >
<!-- -->
< / a > < a href = "#skip-navbar_top" title = "Skip navigation links" > < / a > < a name = "navbar_top_firstrow" >
<!-- -->
< / a >
< ul class = "navList" title = "Navigation" >
< li > < a href = "../../../../overview-summary.html" > Overview< / a > < / li >
< li > < a href = "package-summary.html" > Package< / a > < / li >
< li class = "navBarCell1Rev" > Class< / li >
< li > < a href = "class-use/Metrics.Plotter.html" > Use< / a > < / li >
< li > < a href = "package-tree.html" > Tree< / a > < / li >
< li > < a href = "../../../../deprecated-list.html" > Deprecated< / a > < / li >
< li > < a href = "../../../../index-files/index-1.html" > Index< / a > < / li >
< li > < a href = "../../../../help-doc.html" > Help< / a > < / li >
< / ul >
< / div >
< div class = "subNav" >
< ul class = "navList" >
< li > < a href = "../../../../com/comphenix/protocol/metrics/Metrics.Graph.html" title = "class in com.comphenix.protocol.metrics" > < span class = "strong" > Prev Class< / span > < / a > < / li >
< li > < a href = "../../../../com/comphenix/protocol/metrics/Statistics.html" title = "class in com.comphenix.protocol.metrics" > < span class = "strong" > Next Class< / span > < / a > < / li >
< / ul >
< ul class = "navList" >
< li > < a href = "../../../../index.html?com/comphenix/protocol/metrics/Metrics.Plotter.html" target = "_top" > Frames< / a > < / li >
< li > < a href = "Metrics.Plotter.html" target = "_top" > No Frames< / a > < / li >
< / ul >
< ul class = "navList" id = "allclasses_navbar_top" >
< li > < a href = "../../../../allclasses-noframe.html" > All Classes< / a > < / li >
< / ul >
< div >
< script type = "text/javascript" > < ! - -
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
< / script >
< / div >
< div >
< ul class = "subNavList" >
< li > Summary: < / li >
< li > Nested | < / li >
< li > Field | < / li >
< li > < a href = "#constructor_summary" > Constr< / a > | < / li >
< li > < a href = "#method_summary" > Method< / a > < / li >
< / ul >
< ul class = "subNavList" >
< li > Detail: < / li >
< li > Field | < / li >
< li > < a href = "#constructor_detail" > Constr< / a > | < / li >
< li > < a href = "#method_detail" > Method< / a > < / li >
< / ul >
< / div >
< a name = "skip-navbar_top" >
<!-- -->
< / a > < / div >
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
< div class = "header" >
< div class = "subTitle" > com.comphenix.protocol.metrics< / div >
< h2 title = "Class Metrics.Plotter" class = "title" > Class Metrics.Plotter< / h2 >
< / div >
< div class = "contentContainer" >
< ul class = "inheritance" >
< li > java.lang.Object< / li >
< li >
< ul class = "inheritance" >
< li > com.comphenix.protocol.metrics.Metrics.Plotter< / li >
< / ul >
< / li >
< / ul >
< div class = "description" >
< ul class = "blockList" >
< li class = "blockList" >
< dl >
< dt > Enclosing class:< / dt >
< dd > < a href = "../../../../com/comphenix/protocol/metrics/Metrics.html" title = "class in com.comphenix.protocol.metrics" > Metrics< / a > < / dd >
< / dl >
< hr >
< br >
< pre > public abstract static class < span class = "strong" > Metrics.Plotter< / span >
extends java.lang.Object< / pre >
< div class = "block" > Interface used to collect custom data for a plugin< / div >
< / li >
< / ul >
< / div >
< div class = "summary" >
< ul class = "blockList" >
< li class = "blockList" >
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
< ul class = "blockList" >
< li class = "blockList" > < a name = "constructor_summary" >
<!-- -->
< / a >
< h3 > Constructor Summary< / h3 >
< table class = "overviewSummary" border = "0" cellpadding = "3" cellspacing = "0" summary = "Constructor Summary table, listing constructors, and an explanation" >
< caption > < span > Constructors< / span > < span class = "tabEnd" > < / span > < / caption >
< tr >
< th class = "colOne" scope = "col" > Constructor and Description< / th >
< / tr >
< tr class = "altColor" >
< td class = "colOne" > < code > < strong > < a href = "../../../../com/comphenix/protocol/metrics/Metrics.Plotter.html#Metrics.Plotter()" > Metrics.Plotter< / a > < / strong > ()< / code >
< div class = "block" > Construct a plotter with the default plot name< / div >
< / td >
< / tr >
< tr class = "rowColor" >
< td class = "colOne" > < code > < strong > < a href = "../../../../com/comphenix/protocol/metrics/Metrics.Plotter.html#Metrics.Plotter(java.lang.String)" > Metrics.Plotter< / a > < / strong > (java.lang.String name)< / code >
< div class = "block" > Construct a plotter with a specific plot name< / div >
< / td >
< / tr >
< / table >
< / li >
< / ul >
<!-- ========== METHOD SUMMARY =========== -->
< ul class = "blockList" >
< li class = "blockList" > < a name = "method_summary" >
<!-- -->
< / a >
< h3 > Method Summary< / h3 >
< table class = "overviewSummary" border = "0" cellpadding = "3" cellspacing = "0" summary = "Method Summary table, listing methods, and an explanation" >
< caption > < span > Methods< / span > < span class = "tabEnd" > < / span > < / caption >
< tr >
< th class = "colFirst" scope = "col" > Modifier and Type< / th >
< th class = "colLast" scope = "col" > Method and Description< / th >
< / tr >
< tr class = "altColor" >
< td class = "colFirst" > < code > boolean< / code > < / td >
< td class = "colLast" > < code > < strong > < a href = "../../../../com/comphenix/protocol/metrics/Metrics.Plotter.html#equals(java.lang.Object)" > equals< / a > < / strong > (java.lang.Object object)< / code > < / td >
< / tr >
< tr class = "rowColor" >
< td class = "colFirst" > < code > java.lang.String< / code > < / td >
< td class = "colLast" > < code > < strong > < a href = "../../../../com/comphenix/protocol/metrics/Metrics.Plotter.html#getColumnName()" > getColumnName< / a > < / strong > ()< / code >
< div class = "block" > Get the column name for the plotted point< / div >
< / td >
< / tr >
< tr class = "altColor" >
< td class = "colFirst" > < code > abstract int< / code > < / td >
< td class = "colLast" > < code > < strong > < a href = "../../../../com/comphenix/protocol/metrics/Metrics.Plotter.html#getValue()" > getValue< / a > < / strong > ()< / code >
< div class = "block" > Get the current value for the plotted point.< / div >
< / td >
< / tr >
< tr class = "rowColor" >
< td class = "colFirst" > < code > int< / code > < / td >
< td class = "colLast" > < code > < strong > < a href = "../../../../com/comphenix/protocol/metrics/Metrics.Plotter.html#hashCode()" > hashCode< / a > < / strong > ()< / code > < / td >
< / tr >
< tr class = "altColor" >
< td class = "colFirst" > < code > void< / code > < / td >
< td class = "colLast" > < code > < strong > < a href = "../../../../com/comphenix/protocol/metrics/Metrics.Plotter.html#reset()" > reset< / a > < / strong > ()< / code >
< div class = "block" > Called after the website graphs have been updated< / div >
< / td >
< / tr >
< / table >
< ul class = "blockList" >
< li class = "blockList" > < a name = "methods_inherited_from_class_java.lang.Object" >
<!-- -->
< / a >
< h3 > Methods inherited from class java.lang.Object< / h3 >
< code > clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait< / code > < / li >
< / ul >
< / li >
< / ul >
< / li >
< / ul >
< / div >
< div class = "details" >
< ul class = "blockList" >
< li class = "blockList" >
<!-- ========= CONSTRUCTOR DETAIL ======== -->
< ul class = "blockList" >
< li class = "blockList" > < a name = "constructor_detail" >
<!-- -->
< / a >
< h3 > Constructor Detail< / h3 >
< a name = "Metrics.Plotter()" >
<!-- -->
< / a >
< ul class = "blockList" >
< li class = "blockList" >
< h4 > Metrics.Plotter< / h4 >
< pre > public Metrics.Plotter()< / pre >
< div class = "block" > Construct a plotter with the default plot name< / div >
< / li >
< / ul >
< a name = "Metrics.Plotter(java.lang.String)" >
<!-- -->
< / a >
< ul class = "blockListLast" >
< li class = "blockList" >
< h4 > Metrics.Plotter< / h4 >
< pre > public Metrics.Plotter(java.lang.String name)< / pre >
< div class = "block" > Construct a plotter with a specific plot name< / div >
< dl > < dt > < span class = "strong" > Parameters:< / span > < / dt > < dd > < code > name< / code > - the name of the plotter to use, which will show up on the website< / dd > < / dl >
< / li >
< / ul >
< / li >
< / ul >
<!-- ============ METHOD DETAIL ========== -->
< ul class = "blockList" >
< li class = "blockList" > < a name = "method_detail" >
<!-- -->
< / a >
< h3 > Method Detail< / h3 >
< a name = "getValue()" >
<!-- -->
< / a >
< ul class = "blockList" >
< li class = "blockList" >
< h4 > getValue< / h4 >
< pre > public abstract int getValue()< / pre >
< div class = "block" > Get the current value for the plotted point. Since this function defers to an external function it may or may
not return immediately thus cannot be guaranteed to be thread friendly or safe. This function can be called
from any thread so care should be taken when accessing resources that need to be synchronized.< / div >
< dl > < dt > < span class = "strong" > Returns:< / span > < / dt > < dd > the current value for the point to be plotted.< / dd > < / dl >
< / li >
< / ul >
< a name = "getColumnName()" >
<!-- -->
< / a >
< ul class = "blockList" >
< li class = "blockList" >
< h4 > getColumnName< / h4 >
< pre > public java.lang.String getColumnName()< / pre >
< div class = "block" > Get the column name for the plotted point< / div >
< dl > < dt > < span class = "strong" > Returns:< / span > < / dt > < dd > the plotted point's column name< / dd > < / dl >
< / li >
< / ul >
< a name = "reset()" >
<!-- -->
< / a >
< ul class = "blockList" >
< li class = "blockList" >
< h4 > reset< / h4 >
< pre > public void reset()< / pre >
< div class = "block" > Called after the website graphs have been updated< / div >
< / li >
< / ul >
< a name = "hashCode()" >
<!-- -->
< / a >
< ul class = "blockList" >
< li class = "blockList" >
< h4 > hashCode< / h4 >
< pre > public int hashCode()< / pre >
< dl >
< dt > < strong > Overrides:< / strong > < / dt >
< dd > < code > hashCode< / code > in class < code > java.lang.Object< / code > < / dd >
< / dl >
< / li >
< / ul >
< a name = "equals(java.lang.Object)" >
<!-- -->
< / a >
< ul class = "blockListLast" >
< li class = "blockList" >
< h4 > equals< / h4 >
< pre > public boolean equals(java.lang.Object object)< / pre >
< dl >
< dt > < strong > Overrides:< / strong > < / dt >
< dd > < code > equals< / code > in class < code > java.lang.Object< / code > < / dd >
< / dl >
< / li >
< / ul >
< / li >
< / ul >
< / li >
< / ul >
< / div >
< / div >
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
< div class = "bottomNav" > < a name = "navbar_bottom" >
<!-- -->
< / a > < a href = "#skip-navbar_bottom" title = "Skip navigation links" > < / a > < a name = "navbar_bottom_firstrow" >
<!-- -->
< / a >
< ul class = "navList" title = "Navigation" >
< li > < a href = "../../../../overview-summary.html" > Overview< / a > < / li >
< li > < a href = "package-summary.html" > Package< / a > < / li >
< li class = "navBarCell1Rev" > Class< / li >
< li > < a href = "class-use/Metrics.Plotter.html" > Use< / a > < / li >
< li > < a href = "package-tree.html" > Tree< / a > < / li >
< li > < a href = "../../../../deprecated-list.html" > Deprecated< / a > < / li >
< li > < a href = "../../../../index-files/index-1.html" > Index< / a > < / li >
< li > < a href = "../../../../help-doc.html" > Help< / a > < / li >
< / ul >
< / div >
< div class = "subNav" >
< ul class = "navList" >
< li > < a href = "../../../../com/comphenix/protocol/metrics/Metrics.Graph.html" title = "class in com.comphenix.protocol.metrics" > < span class = "strong" > Prev Class< / span > < / a > < / li >
< li > < a href = "../../../../com/comphenix/protocol/metrics/Statistics.html" title = "class in com.comphenix.protocol.metrics" > < span class = "strong" > Next Class< / span > < / a > < / li >
< / ul >
< ul class = "navList" >
< li > < a href = "../../../../index.html?com/comphenix/protocol/metrics/Metrics.Plotter.html" target = "_top" > Frames< / a > < / li >
< li > < a href = "Metrics.Plotter.html" target = "_top" > No Frames< / a > < / li >
< / ul >
< ul class = "navList" id = "allclasses_navbar_bottom" >
< li > < a href = "../../../../allclasses-noframe.html" > All Classes< / a > < / li >
< / ul >
< div >
< script type = "text/javascript" > < ! - -
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
< / script >
< / div >
< div >
< ul class = "subNavList" >
< li > Summary: < / li >
< li > Nested | < / li >
< li > Field | < / li >
< li > < a href = "#constructor_summary" > Constr< / a > | < / li >
< li > < a href = "#method_summary" > Method< / a > < / li >
< / ul >
< ul class = "subNavList" >
< li > Detail: < / li >
< li > Field | < / li >
< li > < a href = "#constructor_detail" > Constr< / a > | < / li >
< li > < a href = "#method_detail" > Method< / a > < / li >
< / ul >
< / div >
< a name = "skip-navbar_bottom" >
<!-- -->
< / a > < / div >
<!-- ======== END OF BOTTOM NAVBAR ======= -->
< / body >
< / html >
