PC^2/pc2admin/doc/pc2ex/pc2/ex/ScoreDataComparator.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Frameset//EN""http://www.w3.org/TR/REC-html40/frameset.dtd">
   2 <!--NewPage-->
   3 <HTML>
   4 <HEAD>
   5 <!-- Generated by javadoc on Wed Jul 09 10:18:17 PDT 2003 -->
   6 <TITLE>
   7 PC^2: Class  ScoreDataComparator
   8 </TITLE>
   9 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style">
  10 </HEAD>
  11 <BODY BGCOLOR="white">
  12
  13 <!-- ========== START OF NAVBAR ========== -->
  14 <A NAME="navbar_top"><!-- --></A>
  15 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
  16 <TR>
  17 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
  18 <A NAME="navbar_top_firstrow"><!-- --></A>
  19 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
  20   <TR ALIGN="center" VALIGN="top">
  21   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  22   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  23   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  24   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  25   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  26   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  27   </TR>
  28 </TABLE>
  29 </TD>
  30 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
  31 Questions? <A HREf=mailto:pc2@ecs.csus.edu>Send mail to PC<sup>2</sup></a></EM>
  32 </TD>
  33 </TR>
  34
  35 <TR>
  36 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  37 &nbsp;<A HREF="../../pc2/ex/ScoreboardClient.html"><B>PREV CLASS</B></A>&nbsp;
  38 &nbsp;<A HREF="../../pc2/ex/TeamClient.html"><B>NEXT CLASS</B></A></FONT></TD>
  39 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  40   <A HREF="../../index.html" TARGET="_top"><B>FRAMES</B></A>  &nbsp;
  41 &nbsp;<A HREF="ScoreDataComparator.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
  42 </TR>
  43 <TR>
  44 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  45   SUMMARY: &nbsp;INNER&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
  46 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  47 DETAIL: &nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
  48 </TR>
  49 </TABLE>
  50 <!-- =========== END OF NAVBAR =========== -->
  51
  52 <HR>
  53 <!-- ======== START OF CLASS DATA ======== -->
  54 <H2>
  55 <FONT SIZE="-1">
  56 pc2.ex</FONT>
  57 <BR>
  58 Class  ScoreDataComparator</H2>
  59 <PRE>
  60 java.lang.Object
  61   |
  62   +--<B>pc2.ex.ScoreDataComparator</B>
  63 </PRE>
  64 <DL>
  65 <DT><B>All Implemented Interfaces:</B> <DD>java.util.Comparator, java.io.Serializable</DD>
  66 </DL>
  67 <HR>
  68 <DL>
  69 <DT>public class <B>ScoreDataComparator</B><DT>extends java.lang.Object<DT>implements java.io.Serializable, java.util.Comparator</DL>
  70
  71 <P>
  72 Comparator to sort ClientScoreData
  73 <P>
  74 <DL>
  75 <DT><B>See Also: </B><DD><A HREF="../../serialized-form.html#pc2.ex.ScoreDataComparator">Serialized Form</A></DL>
  76 <HR>
  77
  78 <P>
  79 <!-- ======== INNER CLASS SUMMARY ======== -->
  80
  81
  82 <!-- =========== FIELD SUMMARY =========== -->
  83
  84
  85 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  86
  87 <A NAME="constructor_summary"><!-- --></A>
  88 <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
  89 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  90 <TD COLSPAN=2><FONT SIZE="+2">
  91 <B>Constructor Summary</B></FONT></TD>
  92 </TR>
  93 <TR BGCOLOR="white" CLASS="TableRowColor">
  94 <TD><CODE><B><A HREF="../../pc2/ex/ScoreDataComparator.html#ScoreDataComparator()">ScoreDataComparator</A></B>()</CODE>
  95
  96 <BR>
  97 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;ScoreDataCompator constructor comment.</TD>
  98 </TR>
  99 </TABLE>
 100 &nbsp;
 101 <!-- ========== METHOD SUMMARY =========== -->
 102
 103 <A NAME="method_summary"><!-- --></A>
 104 <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
 105 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 106 <TD COLSPAN=2><FONT SIZE="+2">
 107 <B>Method Summary</B></FONT></TD>
 108 </TR>
 109 <TR BGCOLOR="white" CLASS="TableRowColor">
 110 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 111 <CODE>&nbsp;int</CODE></FONT></TD>
 112 <TD><CODE><B><A HREF="../../pc2/ex/ScoreDataComparator.html#compare(java.lang.Object, java.lang.Object)">compare</A></B>(java.lang.Object&nbsp;o1,
 113         java.lang.Object&nbsp;o2)</CODE>
 114
 115 <BR>
 116 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Compares its two arguments for order.</TD>
 117 </TR>
 118 </TABLE>
 119 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
 120 <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
 121 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
 122 <TD><B>Methods inherited from class java.lang.Object</B></TD>
 123 </TR>
 124 <TR BGCOLOR="white" CLASS="TableRowColor">
 125 <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
 126 </TR>
 127 </TABLE>
 128 &nbsp;<A NAME="methods_inherited_from_class_java.util.Comparator"><!-- --></A>
 129 <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
 130 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
 131 <TD><B>Methods inherited from interface java.util.Comparator</B></TD>
 132 </TR>
 133 <TR BGCOLOR="white" CLASS="TableRowColor">
 134 <TD><CODE>equals</CODE></TD>
 135 </TR>
 136 </TABLE>
 137 &nbsp;
 138 <P>
 139
 140 <!-- ============ FIELD DETAIL =========== -->
 141
 142
 143 <!-- ========= CONSTRUCTOR DETAIL ======== -->
 144
 145 <A NAME="constructor_detail"><!-- --></A>
 146 <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
 147 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 148 <TD COLSPAN=1><FONT SIZE="+2">
 149 <B>Constructor Detail</B></FONT></TD>
 150 </TR>
 151 </TABLE>
 152
 153 <A NAME="ScoreDataComparator()"><!-- --></A><H3>
 154 ScoreDataComparator</H3>
 155 <PRE>
 156 public <B>ScoreDataComparator</B>()</PRE>
 157 <DL>
 158 <DD>ScoreDataCompator constructor comment.</DL>
 159
 160 <!-- ============ METHOD DETAIL ========== -->
 161
 162 <A NAME="method_detail"><!-- --></A>
 163 <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
 164 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 165 <TD COLSPAN=1><FONT SIZE="+2">
 166 <B>Method Detail</B></FONT></TD>
 167 </TR>
 168 </TABLE>
 169
 170 <A NAME="compare(java.lang.Object, java.lang.Object)"><!-- --></A><H3>
 171 compare</H3>
 172 <PRE>
 173 public int <B>compare</B>(java.lang.Object&nbsp;o1,
 174                    java.lang.Object&nbsp;o2)</PRE>
 175 <DL>
 176 <DD>Compares its two arguments for order.  Returns a negative integer,
 177  zero, or a positive integer as the first argument is less than, equal
 178  to, or greater than the second.<p>
 179
 180  The implementor must ensure that <tt>sgn(compare(x, y)) ==
 181  -sgn(compare(y, x))</tt> for all <tt>x</tt> and <tt>y</tt>.  (This
 182  implies that <tt>compare(x, y)</tt> must throw an exception if and only
 183  if <tt>compare(y, x)</tt> throws an exception.)<p>
 184
 185  The implementor must also ensure that the relation is transitive:
 186  <tt>((compare(x, y)&gt;0) &amp;&amp; (compare(y, z)&gt;0))</tt> implies
 187  <tt>compare(x, z)&gt;0</tt>.<p>
 188
 189  Finally, the implementer must ensure that <tt>compare(x, y)==0</tt>
 190  implies that <tt>sgn(compare(x, z))==sgn(compare(y, z))</tt> for all
 191  <tt>z</tt>.<p>
 192
 193  It is generally the case, but <i>not</i> strictly required that
 194  <tt>(compare(x, y)==0) == (x.equals(y))</tt>.  Generally speaking,
 195  any comparator that violates this condition should clearly indicate
 196  this fact.  The recommended language is "Note: this comparator
 197  imposes orderings that are inconsistent with equals."<DD><DL>
 198 <DT><B>Specified by: </B><DD><CODE>compare</CODE> in interface <CODE>java.util.Comparator</CODE></DL>
 199 </DD>
 200 <DD><DL>
 201 <DT><B>Returns:</B><DD>a negative integer, zero, or a positive integer as the
 202                first argument is less than, equal to, or greater than the
 203                second.<DT><B>Throws:</B><DD><CODE>ClassCastException</CODE> - if the arguments' types prevent them from
 204                being compared by this Comparator.</DL>
 205 </DD>
 206 </DL>
 207 <!-- ========= END OF CLASS DATA ========= -->
 208 <HR>
 209
 210 <!-- ========== START OF NAVBAR ========== -->
 211 <A NAME="navbar_bottom"><!-- --></A>
 212 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
 213 <TR>
 214 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
 215 <A NAME="navbar_bottom_firstrow"><!-- --></A>
 216 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
 217   <TR ALIGN="center" VALIGN="top">
 218   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
 219   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
 220   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
 221   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
 222   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
 223   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
 224   </TR>
 225 </TABLE>
 226 </TD>
 227 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
 228 Questions? <A HREf=mailto:pc2@ecs.csus.edu>Send mail to PC<sup>2</sup></a></EM>
 229 </TD>
 230 </TR>
 231
 232 <TR>
 233 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 234 &nbsp;<A HREF="../../pc2/ex/ScoreboardClient.html"><B>PREV CLASS</B></A>&nbsp;
 235 &nbsp;<A HREF="../../pc2/ex/TeamClient.html"><B>NEXT CLASS</B></A></FONT></TD>
 236 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 237   <A HREF="../../index.html" TARGET="_top"><B>FRAMES</B></A>  &nbsp;
 238 &nbsp;<A HREF="ScoreDataComparator.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
 239 </TR>
 240 <TR>
 241 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 242   SUMMARY: &nbsp;INNER&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
 243 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 244 DETAIL: &nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
 245 </TR>
 246 </TABLE>
 247 <!-- =========== END OF NAVBAR =========== -->
 248
 249 <HR>
 250
 251 </BODY>
 252 </HTML>