PageRenderTime 24ms CodeModel.GetById 10ms app.highlight 10ms RepoModel.GetById 1ms app.codeStats 0ms

/Prototipo/Servlet/lib/xstream-distribution-1.4.1-bin/xstream-1.4.1/docs/benchmark-javadoc/com/thoughtworks/xstream/tools/benchmark/Metric.html

http://prototipomemoria.googlecode.com/
HTML | 306 lines | 254 code | 32 blank | 20 comment | 0 complexity | 252ab4da111b6a93875e99165dd8de65 MD5 | raw file
  1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
  2<!--NewPage-->
  3<HTML>
  4<HEAD>
  5<!-- Generated by javadoc (build 1.6.0_26) on Thu Aug 11 04:42:06 CEST 2011 -->
  6<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
  7<TITLE>
  8Metric (XStream Benchmark 1.4.1 API)
  9</TITLE>
 10
 11<META NAME="date" CONTENT="2011-08-11">
 12
 13<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
 14
 15<SCRIPT type="text/javascript">
 16function windowTitle()
 17{
 18    if (location.href.indexOf('is-external=true') == -1) {
 19        parent.document.title="Metric (XStream Benchmark 1.4.1 API)";
 20    }
 21}
 22</SCRIPT>
 23<NOSCRIPT>
 24</NOSCRIPT>
 25
 26</HEAD>
 27
 28<BODY BGCOLOR="white" onload="windowTitle();">
 29<HR>
 30
 31
 32<!-- ========= START OF TOP NAVBAR ======= -->
 33<A NAME="navbar_top"><!-- --></A>
 34<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
 35<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
 36<TR>
 37<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
 38<A NAME="navbar_top_firstrow"><!-- --></A>
 39<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
 40  <TR ALIGN="center" VALIGN="top">
 41  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
 42  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
 43  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
 44  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/Metric.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
 45  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
 46  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
 47  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
 48  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
 49  </TR>
 50</TABLE>
 51</TD>
 52<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
 53</EM>
 54</TD>
 55</TR>
 56
 57<TR>
 58<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 59&nbsp;<A HREF="../../../../../com/thoughtworks/xstream/tools/benchmark/Harness.html" title="class in com.thoughtworks.xstream.tools.benchmark"><B>PREV CLASS</B></A>&nbsp;
 60&nbsp;<A HREF="../../../../../com/thoughtworks/xstream/tools/benchmark/Product.html" title="interface in com.thoughtworks.xstream.tools.benchmark"><B>NEXT CLASS</B></A></FONT></TD>
 61<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 62  <A HREF="../../../../../index.html?com/thoughtworks/xstream/tools/benchmark/Metric.html" target="_top"><B>FRAMES</B></A>  &nbsp;
 63&nbsp;<A HREF="Metric.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
 64&nbsp;<SCRIPT type="text/javascript">
 65  <!--
 66  if(window==top) {
 67    document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
 68  }
 69  //-->
 70</SCRIPT>
 71<NOSCRIPT>
 72  <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
 73</NOSCRIPT>
 74
 75
 76</FONT></TD>
 77</TR>
 78<TR>
 79<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 80  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
 81<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 82DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
 83</TR>
 84</TABLE>
 85<A NAME="skip-navbar_top"></A>
 86<!-- ========= END OF TOP NAVBAR ========= -->
 87
 88<HR>
 89<!-- ======== START OF CLASS DATA ======== -->
 90<H2>
 91<FONT SIZE="-1">
 92com.thoughtworks.xstream.tools.benchmark</FONT>
 93<BR>
 94Interface Metric</H2>
 95<DL>
 96<DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../../com/thoughtworks/xstream/tools/benchmark/metrics/CharacterCountMetric.html" title="class in com.thoughtworks.xstream.tools.benchmark.metrics">CharacterCountMetric</A>, <A HREF="../../../../../com/thoughtworks/xstream/tools/benchmark/metrics/DeserializationSpeedMetric.html" title="class in com.thoughtworks.xstream.tools.benchmark.metrics">DeserializationSpeedMetric</A>, <A HREF="../../../../../com/thoughtworks/xstream/tools/benchmark/metrics/SerializationSpeedMetric.html" title="class in com.thoughtworks.xstream.tools.benchmark.metrics">SerializationSpeedMetric</A>, <A HREF="../../../../../com/thoughtworks/xstream/tools/benchmark/metrics/SizeMetric.html" title="class in com.thoughtworks.xstream.tools.benchmark.metrics">SizeMetric</A></DD>
 97</DL>
 98<HR>
 99<DL>
100<DT><PRE>public interface <B>Metric</B></DL>
101</PRE>
102
103<P>
104A metric is what's actually recorded. This provides a strategy
105 for what to do with an object for a given product and should
106 return a measurable result. For example it could serialize an
107 object against a product and return how long it took to complete
108 the operation.
109<P>
110
111<P>
112<DL>
113<DT><B>Author:</B></DT>
114  <DD>Joe Walnes, J&ouml;rg Schaible</DD>
115<DT><B>See Also:</B><DD><A HREF="../../../../../com/thoughtworks/xstream/tools/benchmark/Harness.html" title="class in com.thoughtworks.xstream.tools.benchmark"><CODE>Harness</CODE></A></DL>
116<HR>
117
118<P>
119
120<!-- ========== METHOD SUMMARY =========== -->
121
122<A NAME="method_summary"><!-- --></A>
123<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
124<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
125<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
126<B>Method Summary</B></FONT></TH>
127</TR>
128<TR BGCOLOR="white" CLASS="TableRowColor">
129<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
130<CODE>&nbsp;boolean</CODE></FONT></TD>
131<TD><CODE><B><A HREF="../../../../../com/thoughtworks/xstream/tools/benchmark/Metric.html#biggerIsBetter()">biggerIsBetter</A></B>()</CODE>
132
133<BR>
134&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Whether a big result is better for this metric.</TD>
135</TR>
136<TR BGCOLOR="white" CLASS="TableRowColor">
137<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
138<CODE>&nbsp;double</CODE></FONT></TD>
139<TD><CODE><B><A HREF="../../../../../com/thoughtworks/xstream/tools/benchmark/Metric.html#run(com.thoughtworks.xstream.tools.benchmark.Product, java.lang.Object)">run</A></B>(<A HREF="../../../../../com/thoughtworks/xstream/tools/benchmark/Product.html" title="interface in com.thoughtworks.xstream.tools.benchmark">Product</A>&nbsp;product,
140    <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A>&nbsp;object)</CODE>
141
142<BR>
143&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<B>Deprecated.</B>&nbsp;<I>since 1.3</I></TD>
144</TR>
145<TR BGCOLOR="white" CLASS="TableRowColor">
146<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
147<CODE>&nbsp;double</CODE></FONT></TD>
148<TD><CODE><B><A HREF="../../../../../com/thoughtworks/xstream/tools/benchmark/Metric.html#run(com.thoughtworks.xstream.tools.benchmark.Product, com.thoughtworks.xstream.tools.benchmark.Target)">run</A></B>(<A HREF="../../../../../com/thoughtworks/xstream/tools/benchmark/Product.html" title="interface in com.thoughtworks.xstream.tools.benchmark">Product</A>&nbsp;product,
149    <A HREF="../../../../../com/thoughtworks/xstream/tools/benchmark/Target.html" title="interface in com.thoughtworks.xstream.tools.benchmark">Target</A>&nbsp;target)</CODE>
150
151<BR>
152&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Run the test and produce a metric.</TD>
153</TR>
154<TR BGCOLOR="white" CLASS="TableRowColor">
155<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
156<CODE>&nbsp;<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
157<TD><CODE><B><A HREF="../../../../../com/thoughtworks/xstream/tools/benchmark/Metric.html#unit()">unit</A></B>()</CODE>
158
159<BR>
160&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The unit the metric is recorded in (for reporting purposes).</TD>
161</TR>
162</TABLE>
163&nbsp;
164<P>
165
166<!-- ============ METHOD DETAIL ========== -->
167
168<A NAME="method_detail"><!-- --></A>
169<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
170<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
171<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
172<B>Method Detail</B></FONT></TH>
173</TR>
174</TABLE>
175
176<A NAME="run(com.thoughtworks.xstream.tools.benchmark.Product, java.lang.Object)"><!-- --></A><H3>
177run</H3>
178<PRE>
179double <B>run</B>(<A HREF="../../../../../com/thoughtworks/xstream/tools/benchmark/Product.html" title="interface in com.thoughtworks.xstream.tools.benchmark">Product</A>&nbsp;product,
180           <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A>&nbsp;object)
181           throws <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</A></PRE>
182<DL>
183<DD><B>Deprecated.</B>&nbsp;<I>since 1.3</I>
184<P>
185<DD>Run the test and produce a metric.
186<P>
187<DD><DL>
188<DT><B>Parameters:</B><DD><CODE>product</CODE> - Product to use in test.<DD><CODE>object</CODE> - A object to use against the product.
189<DT><B>Returns:</B><DD>The resulting metric (e.g. 12.22).
190<DT><B>Throws:</B>
191<DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</A></CODE> - If this metric could not be obtained. This will
192                   be reported back to the <A HREF="../../../../../com/thoughtworks/xstream/tools/benchmark/Reporter.html" title="interface in com.thoughtworks.xstream.tools.benchmark"><CODE>Reporter</CODE></A>.</DL>
193</DD>
194</DL>
195<HR>
196
197<A NAME="run(com.thoughtworks.xstream.tools.benchmark.Product, com.thoughtworks.xstream.tools.benchmark.Target)"><!-- --></A><H3>
198run</H3>
199<PRE>
200double <B>run</B>(<A HREF="../../../../../com/thoughtworks/xstream/tools/benchmark/Product.html" title="interface in com.thoughtworks.xstream.tools.benchmark">Product</A>&nbsp;product,
201           <A HREF="../../../../../com/thoughtworks/xstream/tools/benchmark/Target.html" title="interface in com.thoughtworks.xstream.tools.benchmark">Target</A>&nbsp;target)
202           throws <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</A></PRE>
203<DL>
204<DD>Run the test and produce a metric.
205<P>
206<DD><DL>
207<DT><B>Parameters:</B><DD><CODE>product</CODE> - Product to use in test.<DD><CODE>target</CODE> - A target to use against the product.
208<DT><B>Returns:</B><DD>The resulting metric (e.g. 12.22).
209<DT><B>Throws:</B>
210<DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</A></CODE> - If this metric could not be obtained. This will
211                   be reported back to the <A HREF="../../../../../com/thoughtworks/xstream/tools/benchmark/Reporter.html" title="interface in com.thoughtworks.xstream.tools.benchmark"><CODE>Reporter</CODE></A>.<DT><B>Since:</B></DT>
212  <DD>1.3</DD>
213</DL>
214</DD>
215</DL>
216<HR>
217
218<A NAME="unit()"><!-- --></A><H3>
219unit</H3>
220<PRE>
221<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>unit</B>()</PRE>
222<DL>
223<DD>The unit the metric is recorded in (for reporting purposes).
224 e.g. "ms" or "bytes".
225<P>
226<DD><DL>
227</DL>
228</DD>
229</DL>
230<HR>
231
232<A NAME="biggerIsBetter()"><!-- --></A><H3>
233biggerIsBetter</H3>
234<PRE>
235boolean <B>biggerIsBetter</B>()</PRE>
236<DL>
237<DD>Whether a big result is better for this metric.
238<P>
239<DD><DL>
240</DL>
241</DD>
242</DL>
243<!-- ========= END OF CLASS DATA ========= -->
244<HR>
245
246
247<!-- ======= START OF BOTTOM NAVBAR ====== -->
248<A NAME="navbar_bottom"><!-- --></A>
249<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
250<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
251<TR>
252<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
253<A NAME="navbar_bottom_firstrow"><!-- --></A>
254<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
255  <TR ALIGN="center" VALIGN="top">
256  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
257  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
258  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
259  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/Metric.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
260  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
261  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
262  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
263  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
264  </TR>
265</TABLE>
266</TD>
267<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
268</EM>
269</TD>
270</TR>
271
272<TR>
273<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
274&nbsp;<A HREF="../../../../../com/thoughtworks/xstream/tools/benchmark/Harness.html" title="class in com.thoughtworks.xstream.tools.benchmark"><B>PREV CLASS</B></A>&nbsp;
275&nbsp;<A HREF="../../../../../com/thoughtworks/xstream/tools/benchmark/Product.html" title="interface in com.thoughtworks.xstream.tools.benchmark"><B>NEXT CLASS</B></A></FONT></TD>
276<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
277  <A HREF="../../../../../index.html?com/thoughtworks/xstream/tools/benchmark/Metric.html" target="_top"><B>FRAMES</B></A>  &nbsp;
278&nbsp;<A HREF="Metric.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
279&nbsp;<SCRIPT type="text/javascript">
280  <!--
281  if(window==top) {
282    document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
283  }
284  //-->
285</SCRIPT>
286<NOSCRIPT>
287  <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
288</NOSCRIPT>
289
290
291</FONT></TD>
292</TR>
293<TR>
294<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
295  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
296<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
297DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
298</TR>
299</TABLE>
300<A NAME="skip-navbar_bottom"></A>
301<!-- ======== END OF BOTTOM NAVBAR ======= -->
302
303<HR>
304Copyright &#169; 2004-2011 <a href="http://xstream.codehaus.org">XStream</a>. All Rights Reserved.
305</BODY>
306</HTML>