[8780cbec] | 1 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN""http://www.w3.org/TR/REC-html40/loose.dtd"> |
---|
| 2 | <!--NewPage--> |
---|
| 3 | <HTML> |
---|
| 4 | <HEAD> |
---|
| 5 | <!-- Generated by javadoc on Wed Oct 02 14:27:58 PDT 2002 --> |
---|
| 6 | <TITLE> |
---|
| 7 | EnumType |
---|
| 8 | </TITLE> |
---|
| 9 | <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style"> |
---|
| 10 | </HEAD> |
---|
| 11 | <SCRIPT> |
---|
| 12 | function asd() |
---|
| 13 | { |
---|
| 14 | parent.document.title="EnumType"; |
---|
| 15 | } |
---|
| 16 | </SCRIPT> |
---|
| 17 | <BODY BGCOLOR="white" onload="asd();"> |
---|
| 18 | |
---|
| 19 | <!-- ========== START OF NAVBAR ========== --> |
---|
| 20 | <A NAME="navbar_top"><!-- --></A> |
---|
| 21 | <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0"> |
---|
| 22 | <TR> |
---|
| 23 | <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
---|
| 24 | <A NAME="navbar_top_firstrow"><!-- --></A> |
---|
| 25 | <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3"> |
---|
| 26 | <TR ALIGN="center" VALIGN="top"> |
---|
| 27 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
---|
| 28 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
---|
| 29 | <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
---|
| 30 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/EnumType.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
---|
| 31 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
---|
| 32 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
---|
| 33 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
---|
| 34 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
---|
| 35 | </TR> |
---|
| 36 | </TABLE> |
---|
| 37 | </TD> |
---|
| 38 | <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
---|
| 39 | </EM> |
---|
| 40 | </TD> |
---|
| 41 | </TR> |
---|
| 42 | |
---|
| 43 | <TR> |
---|
| 44 | <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
---|
| 45 | <A HREF="../../../../edu/stanford/rt/datatype/DecimalValue.html"><B>PREV CLASS</B></A> |
---|
| 46 | <A HREF="../../../../edu/stanford/rt/datatype/EnumValue.html"><B>NEXT CLASS</B></A></FONT></TD> |
---|
| 47 | <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
---|
| 48 | <A HREF="../../../../index.html" TARGET="_top"><B>FRAMES</B></A> |
---|
| 49 | <A HREF="EnumType.html" TARGET="_top"><B>NO FRAMES</B></A> |
---|
| 50 | |
---|
| 51 | <SCRIPT> |
---|
| 52 | <!-- |
---|
| 53 | if(window==top) { |
---|
| 54 | document.writeln('<A HREF="../../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>'); |
---|
| 55 | } |
---|
| 56 | //--> |
---|
| 57 | </SCRIPT> |
---|
| 58 | <NOSCRIPT> |
---|
| 59 | <A HREF="../../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A> |
---|
| 60 | </NOSCRIPT> |
---|
| 61 | </FONT></TD> |
---|
| 62 | </TR> |
---|
| 63 | <TR> |
---|
| 64 | <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
---|
| 65 | SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> |
---|
| 66 | <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
---|
| 67 | DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> |
---|
| 68 | </TR> |
---|
| 69 | </TABLE> |
---|
| 70 | <!-- =========== END OF NAVBAR =========== --> |
---|
| 71 | |
---|
| 72 | <HR> |
---|
| 73 | <!-- ======== START OF CLASS DATA ======== --> |
---|
| 74 | <H2> |
---|
| 75 | <FONT SIZE="-1"> |
---|
| 76 | edu.stanford.rt.datatype</FONT> |
---|
| 77 | <BR> |
---|
| 78 | Class EnumType</H2> |
---|
| 79 | <PRE> |
---|
| 80 | java.lang.Object |
---|
| 81 | | |
---|
| 82 | +--<A HREF="../../../../edu/stanford/rt/datatype/DataType.html">edu.stanford.rt.datatype.DataType</A> |
---|
| 83 | | |
---|
| 84 | +--<A HREF="../../../../edu/stanford/rt/datatype/SimpleType.html">edu.stanford.rt.datatype.SimpleType</A> |
---|
| 85 | | |
---|
| 86 | +--<A HREF="../../../../edu/stanford/rt/datatype/OrderedType.html">edu.stanford.rt.datatype.OrderedType</A> |
---|
| 87 | | |
---|
| 88 | +--<B>edu.stanford.rt.datatype.EnumType</B> |
---|
| 89 | </PRE> |
---|
| 90 | <HR> |
---|
| 91 | <DL> |
---|
| 92 | <DT>public class <B>EnumType</B><DT>extends <A HREF="../../../../edu/stanford/rt/datatype/OrderedType.html">OrderedType</A></DL> |
---|
| 93 | |
---|
| 94 | <P> |
---|
| 95 | <DL> |
---|
| 96 | <DT><B>Author:</B><DD>Ninghui Li, Sandra Qiu<br> |
---|
| 97 | |
---|
| 98 | Represents <code>EnumType</code> element in DomainSpecification. |
---|
| 99 | Each <code>EnumType</code> declaration object knows its legal values |
---|
| 100 | and the ordering of the values if the values are ordered.</DD> |
---|
| 101 | </DD> |
---|
| 102 | </DL> |
---|
| 103 | <HR> |
---|
| 104 | |
---|
| 105 | <P> |
---|
| 106 | <!-- ======== NESTED CLASS SUMMARY ======== --> |
---|
| 107 | |
---|
| 108 | |
---|
| 109 | <!-- =========== FIELD SUMMARY =========== --> |
---|
| 110 | |
---|
| 111 | <A NAME="field_summary"><!-- --></A> |
---|
| 112 | <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> |
---|
| 113 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
---|
| 114 | <TD COLSPAN=2><FONT SIZE="+2"> |
---|
| 115 | <B>Field Summary</B></FONT></TD> |
---|
| 116 | </TR> |
---|
| 117 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
| 118 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
| 119 | <CODE>private boolean</CODE></FONT></TD> |
---|
| 120 | <TD><CODE><B><A HREF="../../../../edu/stanford/rt/datatype/EnumType.html#ignoreCase">ignoreCase</A></B></CODE> |
---|
| 121 | |
---|
| 122 | <BR> |
---|
| 123 | are values case-sensitive?</TD> |
---|
| 124 | </TR> |
---|
| 125 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
| 126 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
| 127 | <CODE>private boolean</CODE></FONT></TD> |
---|
| 128 | <TD><CODE><B><A HREF="../../../../edu/stanford/rt/datatype/EnumType.html#ordered">ordered</A></B></CODE> |
---|
| 129 | |
---|
| 130 | <BR> |
---|
| 131 | are values ordered in any way?</TD> |
---|
| 132 | </TR> |
---|
| 133 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
| 134 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
| 135 | <CODE>private int</CODE></FONT></TD> |
---|
| 136 | <TD><CODE><B><A HREF="../../../../edu/stanford/rt/datatype/EnumType.html#size">size</A></B></CODE> |
---|
| 137 | |
---|
| 138 | <BR> |
---|
| 139 | the number of values this type has</TD> |
---|
| 140 | </TR> |
---|
| 141 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
| 142 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
| 143 | <CODE>private java.util.ArrayList</CODE></FONT></TD> |
---|
| 144 | <TD><CODE><B><A HREF="../../../../edu/stanford/rt/datatype/EnumType.html#values">values</A></B></CODE> |
---|
| 145 | |
---|
| 146 | <BR> |
---|
| 147 | the list of values in their natural order, i.e.</TD> |
---|
| 148 | </TR> |
---|
| 149 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
| 150 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
| 151 | <CODE>private java.util.HashSet</CODE></FONT></TD> |
---|
| 152 | <TD><CODE><B><A HREF="../../../../edu/stanford/rt/datatype/EnumType.html#valuesCopy">valuesCopy</A></B></CODE> |
---|
| 153 | |
---|
| 154 | <BR> |
---|
| 155 | We also store the values in a hash set to speed up |
---|
| 156 | membership tests.</TD> |
---|
| 157 | </TR> |
---|
| 158 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
| 159 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
| 160 | <CODE>private <A HREF="../../../../edu/stanford/rt/datatype/DataType.html">DataType</A></CODE></FONT></TD> |
---|
| 161 | <TD><CODE><B><A HREF="../../../../edu/stanford/rt/datatype/EnumType.html#valueType">valueType</A></B></CODE> |
---|
| 162 | |
---|
| 163 | <BR> |
---|
| 164 | Defines the ordering of values.</TD> |
---|
| 165 | </TR> |
---|
| 166 | </TABLE> |
---|
| 167 | <A NAME="fields_inherited_from_class_edu.stanford.rt.datatype.DataType"><!-- --></A> |
---|
| 168 | <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> |
---|
| 169 | <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
---|
| 170 | <TD><B>Fields inherited from class edu.stanford.rt.datatype.<A HREF="../../../../edu/stanford/rt/datatype/DataType.html">DataType</A></B></TD> |
---|
| 171 | </TR> |
---|
| 172 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
| 173 | <TD><CODE></CODE></TD> |
---|
| 174 | </TR> |
---|
| 175 | </TABLE> |
---|
| 176 | |
---|
| 177 | <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
---|
| 178 | |
---|
| 179 | <A NAME="constructor_summary"><!-- --></A> |
---|
| 180 | <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> |
---|
| 181 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
---|
| 182 | <TD COLSPAN=2><FONT SIZE="+2"> |
---|
| 183 | <B>Constructor Summary</B></FONT></TD> |
---|
| 184 | </TR> |
---|
| 185 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
| 186 | <TD><CODE><B><A HREF="../../../../edu/stanford/rt/datatype/EnumType.html#EnumType(java.lang.String, edu.stanford.rt.datatype.DataType, edu.stanford.rt.credential.OrderedMap, boolean, boolean, int)">EnumType</A></B>(java.lang.String name, |
---|
| 187 | <A HREF="../../../../edu/stanford/rt/datatype/DataType.html">DataType</A> valueType, |
---|
| 188 | <A HREF="../../../../edu/stanford/rt/credential/OrderedMap.html">OrderedMap</A> enumValues, |
---|
| 189 | boolean ignoreCase, |
---|
| 190 | boolean ordered, |
---|
| 191 | int size)</CODE> |
---|
| 192 | |
---|
| 193 | <BR> |
---|
| 194 | Constructor for EnumType.</TD> |
---|
| 195 | </TR> |
---|
| 196 | </TABLE> |
---|
| 197 | |
---|
| 198 | <!-- ========== METHOD SUMMARY =========== --> |
---|
| 199 | |
---|
| 200 | <A NAME="method_summary"><!-- --></A> |
---|
| 201 | <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> |
---|
| 202 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
---|
| 203 | <TD COLSPAN=2><FONT SIZE="+2"> |
---|
| 204 | <B>Method Summary</B></FONT></TD> |
---|
| 205 | </TR> |
---|
| 206 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
| 207 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
| 208 | <CODE> int</CODE></FONT></TD> |
---|
| 209 | <TD><CODE><B><A HREF="../../../../edu/stanford/rt/datatype/EnumType.html#compares(edu.stanford.rt.datatype.DataValue, edu.stanford.rt.datatype.DataValue)">compares</A></B>(<A HREF="../../../../edu/stanford/rt/datatype/DataValue.html">DataValue</A> value1, |
---|
| 210 | <A HREF="../../../../edu/stanford/rt/datatype/DataValue.html">DataValue</A> value2)</CODE> |
---|
| 211 | |
---|
| 212 | <BR> |
---|
| 213 | Method compares.</TD> |
---|
| 214 | </TR> |
---|
| 215 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
| 216 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
| 217 | <CODE> boolean</CODE></FONT></TD> |
---|
| 218 | <TD><CODE><B><A HREF="../../../../edu/stanford/rt/datatype/EnumType.html#contains(java.lang.String)">contains</A></B>(java.lang.String value)</CODE> |
---|
| 219 | |
---|
| 220 | <BR> |
---|
| 221 | Method contains.</TD> |
---|
| 222 | </TR> |
---|
| 223 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
| 224 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
| 225 | <CODE> int</CODE></FONT></TD> |
---|
| 226 | <TD><CODE><B><A HREF="../../../../edu/stanford/rt/datatype/EnumType.html#getSize()">getSize</A></B>()</CODE> |
---|
| 227 | |
---|
| 228 | <BR> |
---|
| 229 | Method getSize.</TD> |
---|
| 230 | </TR> |
---|
| 231 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
| 232 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
| 233 | <CODE> java.util.List</CODE></FONT></TD> |
---|
| 234 | <TD><CODE><B><A HREF="../../../../edu/stanford/rt/datatype/EnumType.html#getValues()">getValues</A></B>()</CODE> |
---|
| 235 | |
---|
| 236 | <BR> |
---|
| 237 | Method getValues.</TD> |
---|
| 238 | </TR> |
---|
| 239 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
| 240 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
| 241 | <CODE> <A HREF="../../../../edu/stanford/rt/datatype/DataType.html">DataType</A></CODE></FONT></TD> |
---|
| 242 | <TD><CODE><B><A HREF="../../../../edu/stanford/rt/datatype/EnumType.html#getValueType()">getValueType</A></B>()</CODE> |
---|
| 243 | |
---|
| 244 | <BR> |
---|
| 245 | Method getValueType.</TD> |
---|
| 246 | </TR> |
---|
| 247 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
| 248 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
| 249 | <CODE> boolean</CODE></FONT></TD> |
---|
| 250 | <TD><CODE><B><A HREF="../../../../edu/stanford/rt/datatype/EnumType.html#isIgnoreCase()">isIgnoreCase</A></B>()</CODE> |
---|
| 251 | |
---|
| 252 | <BR> |
---|
| 253 | Method isIgnoreCase.</TD> |
---|
| 254 | </TR> |
---|
| 255 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
| 256 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
| 257 | <CODE> boolean</CODE></FONT></TD> |
---|
| 258 | <TD><CODE><B><A HREF="../../../../edu/stanford/rt/datatype/EnumType.html#isOrdered()">isOrdered</A></B>()</CODE> |
---|
| 259 | |
---|
| 260 | <BR> |
---|
| 261 | Method isOrdered.</TD> |
---|
| 262 | </TR> |
---|
| 263 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
| 264 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
| 265 | <CODE> boolean</CODE></FONT></TD> |
---|
| 266 | <TD><CODE><B><A HREF="../../../../edu/stanford/rt/datatype/EnumType.html#isValidValue(edu.stanford.rt.datatype.DataValue)">isValidValue</A></B>(<A HREF="../../../../edu/stanford/rt/datatype/DataValue.html">DataValue</A> v)</CODE> |
---|
| 267 | |
---|
| 268 | <BR> |
---|
| 269 | Check if the DataValue o is a legal value for its type.</TD> |
---|
| 270 | </TR> |
---|
| 271 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
| 272 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
| 273 | <CODE> void</CODE></FONT></TD> |
---|
| 274 | <TD><CODE><B><A HREF="../../../../edu/stanford/rt/datatype/EnumType.html#setValueType(edu.stanford.rt.datatype.DataType)">setValueType</A></B>(<A HREF="../../../../edu/stanford/rt/datatype/DataType.html">DataType</A> type)</CODE> |
---|
| 275 | |
---|
| 276 | <BR> |
---|
| 277 | Method setValueType.</TD> |
---|
| 278 | </TR> |
---|
| 279 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
| 280 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
| 281 | <CODE> java.lang.String</CODE></FONT></TD> |
---|
| 282 | <TD><CODE><B><A HREF="../../../../edu/stanford/rt/datatype/EnumType.html#toString(java.lang.String)">toString</A></B>(java.lang.String indent)</CODE> |
---|
| 283 | |
---|
| 284 | <BR> |
---|
| 285 | Method toString.</TD> |
---|
| 286 | </TR> |
---|
| 287 | </TABLE> |
---|
| 288 | <A NAME="methods_inherited_from_class_edu.stanford.rt.datatype.DataType"><!-- --></A> |
---|
| 289 | <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> |
---|
| 290 | <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
---|
| 291 | <TD><B>Methods inherited from class edu.stanford.rt.datatype.<A HREF="../../../../edu/stanford/rt/datatype/DataType.html">DataType</A></B></TD> |
---|
| 292 | </TR> |
---|
| 293 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
| 294 | <TD><CODE><A HREF="../../../../edu/stanford/rt/datatype/DataType.html#getName()">getName</A>, <A HREF="../../../../edu/stanford/rt/datatype/DataType.html#toString()">toString</A></CODE></TD> |
---|
| 295 | </TR> |
---|
| 296 | </TABLE> |
---|
| 297 | <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> |
---|
| 298 | <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> |
---|
| 299 | <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
---|
| 300 | <TD><B>Methods inherited from class java.lang.Object</B></TD> |
---|
| 301 | </TR> |
---|
| 302 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
| 303 | <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</CODE></TD> |
---|
| 304 | </TR> |
---|
| 305 | </TABLE> |
---|
| 306 | |
---|
| 307 | <P> |
---|
| 308 | |
---|
| 309 | <!-- ============ FIELD DETAIL =========== --> |
---|
| 310 | |
---|
| 311 | <A NAME="field_detail"><!-- --></A> |
---|
| 312 | <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> |
---|
| 313 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
---|
| 314 | <TD COLSPAN=1><FONT SIZE="+2"> |
---|
| 315 | <B>Field Detail</B></FONT></TD> |
---|
| 316 | </TR> |
---|
| 317 | </TABLE> |
---|
| 318 | |
---|
| 319 | <A NAME="size"><!-- --></A><H3> |
---|
| 320 | size</H3> |
---|
| 321 | <PRE> |
---|
| 322 | private int <B>size</B></PRE> |
---|
| 323 | <DL> |
---|
| 324 | <DD>the number of values this type has |
---|
| 325 | <P> |
---|
| 326 | <DL> |
---|
| 327 | </DL> |
---|
| 328 | </DL> |
---|
| 329 | <HR> |
---|
| 330 | |
---|
| 331 | <A NAME="valueType"><!-- --></A><H3> |
---|
| 332 | valueType</H3> |
---|
| 333 | <PRE> |
---|
| 334 | private <A HREF="../../../../edu/stanford/rt/datatype/DataType.html">DataType</A> <B>valueType</B></PRE> |
---|
| 335 | <DL> |
---|
| 336 | <DD>Defines the ordering of values. |
---|
| 337 | <P> |
---|
| 338 | <DL> |
---|
| 339 | </DL> |
---|
| 340 | </DL> |
---|
| 341 | <HR> |
---|
| 342 | |
---|
| 343 | <A NAME="ignoreCase"><!-- --></A><H3> |
---|
| 344 | ignoreCase</H3> |
---|
| 345 | <PRE> |
---|
| 346 | private boolean <B>ignoreCase</B></PRE> |
---|
| 347 | <DL> |
---|
| 348 | <DD>are values case-sensitive? |
---|
| 349 | <P> |
---|
| 350 | <DL> |
---|
| 351 | </DL> |
---|
| 352 | </DL> |
---|
| 353 | <HR> |
---|
| 354 | |
---|
| 355 | <A NAME="ordered"><!-- --></A><H3> |
---|
| 356 | ordered</H3> |
---|
| 357 | <PRE> |
---|
| 358 | private boolean <B>ordered</B></PRE> |
---|
| 359 | <DL> |
---|
| 360 | <DD>are values ordered in any way? |
---|
| 361 | <P> |
---|
| 362 | <DL> |
---|
| 363 | </DL> |
---|
| 364 | </DL> |
---|
| 365 | <HR> |
---|
| 366 | |
---|
| 367 | <A NAME="values"><!-- --></A><H3> |
---|
| 368 | values</H3> |
---|
| 369 | <PRE> |
---|
| 370 | private java.util.ArrayList <B>values</B></PRE> |
---|
| 371 | <DL> |
---|
| 372 | <DD>the list of values in their natural order, i.e. the order that |
---|
| 373 | being added to the list |
---|
| 374 | <P> |
---|
| 375 | <DL> |
---|
| 376 | </DL> |
---|
| 377 | </DL> |
---|
| 378 | <HR> |
---|
| 379 | |
---|
| 380 | <A NAME="valuesCopy"><!-- --></A><H3> |
---|
| 381 | valuesCopy</H3> |
---|
| 382 | <PRE> |
---|
| 383 | private java.util.HashSet <B>valuesCopy</B></PRE> |
---|
| 384 | <DL> |
---|
| 385 | <DD>We also store the values in a hash set to speed up |
---|
| 386 | membership tests. |
---|
| 387 | <P> |
---|
| 388 | <DL> |
---|
| 389 | </DL> |
---|
| 390 | </DL> |
---|
| 391 | |
---|
| 392 | <!-- ========= CONSTRUCTOR DETAIL ======== --> |
---|
| 393 | |
---|
| 394 | <A NAME="constructor_detail"><!-- --></A> |
---|
| 395 | <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> |
---|
| 396 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
---|
| 397 | <TD COLSPAN=1><FONT SIZE="+2"> |
---|
| 398 | <B>Constructor Detail</B></FONT></TD> |
---|
| 399 | </TR> |
---|
| 400 | </TABLE> |
---|
| 401 | |
---|
| 402 | <A NAME="EnumType(java.lang.String, edu.stanford.rt.datatype.DataType, edu.stanford.rt.credential.OrderedMap, boolean, boolean, int)"><!-- --></A><H3> |
---|
| 403 | EnumType</H3> |
---|
| 404 | <PRE> |
---|
| 405 | public <B>EnumType</B>(java.lang.String name, |
---|
| 406 | <A HREF="../../../../edu/stanford/rt/datatype/DataType.html">DataType</A> valueType, |
---|
| 407 | <A HREF="../../../../edu/stanford/rt/credential/OrderedMap.html">OrderedMap</A> enumValues, |
---|
| 408 | boolean ignoreCase, |
---|
| 409 | boolean ordered, |
---|
| 410 | int size) |
---|
| 411 | throws java.lang.IllegalArgumentException</PRE> |
---|
| 412 | <DL> |
---|
| 413 | <DD>Constructor for EnumType. |
---|
| 414 | <P> |
---|
| 415 | </DL> |
---|
| 416 | |
---|
| 417 | <!-- ============ METHOD DETAIL ========== --> |
---|
| 418 | |
---|
| 419 | <A NAME="method_detail"><!-- --></A> |
---|
| 420 | <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> |
---|
| 421 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
---|
| 422 | <TD COLSPAN=1><FONT SIZE="+2"> |
---|
| 423 | <B>Method Detail</B></FONT></TD> |
---|
| 424 | </TR> |
---|
| 425 | </TABLE> |
---|
| 426 | |
---|
| 427 | <A NAME="setValueType(edu.stanford.rt.datatype.DataType)"><!-- --></A><H3> |
---|
| 428 | setValueType</H3> |
---|
| 429 | <PRE> |
---|
| 430 | public void <B>setValueType</B>(<A HREF="../../../../edu/stanford/rt/datatype/DataType.html">DataType</A> type)</PRE> |
---|
| 431 | <DL> |
---|
| 432 | <DD>Method setValueType. |
---|
| 433 | <P> |
---|
| 434 | <DD><DL> |
---|
| 435 | <DT><B>Parameters:</B><DD><CODE>type</CODE> - </DL> |
---|
| 436 | </DD> |
---|
| 437 | </DL> |
---|
| 438 | <HR> |
---|
| 439 | |
---|
| 440 | <A NAME="getValueType()"><!-- --></A><H3> |
---|
| 441 | getValueType</H3> |
---|
| 442 | <PRE> |
---|
| 443 | public <A HREF="../../../../edu/stanford/rt/datatype/DataType.html">DataType</A> <B>getValueType</B>()</PRE> |
---|
| 444 | <DL> |
---|
| 445 | <DD>Method getValueType. |
---|
| 446 | <P> |
---|
| 447 | <DD><DL> |
---|
| 448 | |
---|
| 449 | <DT><B>Returns:</B><DD>DataType</DL> |
---|
| 450 | </DD> |
---|
| 451 | </DL> |
---|
| 452 | <HR> |
---|
| 453 | |
---|
| 454 | <A NAME="getValues()"><!-- --></A><H3> |
---|
| 455 | getValues</H3> |
---|
| 456 | <PRE> |
---|
| 457 | public java.util.List <B>getValues</B>()</PRE> |
---|
| 458 | <DL> |
---|
| 459 | <DD>Method getValues.<p> |
---|
| 460 | returns an unmodifiable view of the legal values. |
---|
| 461 | <P> |
---|
| 462 | <DD><DL> |
---|
| 463 | |
---|
| 464 | <DT><B>Returns:</B><DD>List</DL> |
---|
| 465 | </DD> |
---|
| 466 | </DL> |
---|
| 467 | <HR> |
---|
| 468 | |
---|
| 469 | <A NAME="contains(java.lang.String)"><!-- --></A><H3> |
---|
| 470 | contains</H3> |
---|
| 471 | <PRE> |
---|
| 472 | public boolean <B>contains</B>(java.lang.String value)</PRE> |
---|
| 473 | <DL> |
---|
| 474 | <DD>Method contains.<p> |
---|
| 475 | checks whether the given value is part of the legal values. |
---|
| 476 | <P> |
---|
| 477 | <DD><DL> |
---|
| 478 | <DT><B>Parameters:</B><DD><CODE>value</CODE> - |
---|
| 479 | <DT><B>Returns:</B><DD>boolean</DL> |
---|
| 480 | </DD> |
---|
| 481 | </DL> |
---|
| 482 | <HR> |
---|
| 483 | |
---|
| 484 | <A NAME="getSize()"><!-- --></A><H3> |
---|
| 485 | getSize</H3> |
---|
| 486 | <PRE> |
---|
| 487 | public int <B>getSize</B>()</PRE> |
---|
| 488 | <DL> |
---|
| 489 | <DD>Method getSize.<p> |
---|
| 490 | returns the actual number of legal values defined |
---|
| 491 | for this type. |
---|
| 492 | <P> |
---|
| 493 | <DD><DL> |
---|
| 494 | |
---|
| 495 | <DT><B>Returns:</B><DD>int</DL> |
---|
| 496 | </DD> |
---|
| 497 | </DL> |
---|
| 498 | <HR> |
---|
| 499 | |
---|
| 500 | <A NAME="isIgnoreCase()"><!-- --></A><H3> |
---|
| 501 | isIgnoreCase</H3> |
---|
| 502 | <PRE> |
---|
| 503 | public boolean <B>isIgnoreCase</B>()</PRE> |
---|
| 504 | <DL> |
---|
| 505 | <DD>Method isIgnoreCase.<p> |
---|
| 506 | <P> |
---|
| 507 | <DD><DL> |
---|
| 508 | |
---|
| 509 | <DT><B>Returns:</B><DD>boolean</DL> |
---|
| 510 | </DD> |
---|
| 511 | </DL> |
---|
| 512 | <HR> |
---|
| 513 | |
---|
| 514 | <A NAME="isOrdered()"><!-- --></A><H3> |
---|
| 515 | isOrdered</H3> |
---|
| 516 | <PRE> |
---|
| 517 | public boolean <B>isOrdered</B>()</PRE> |
---|
| 518 | <DL> |
---|
| 519 | <DD>Method isOrdered. |
---|
| 520 | <P> |
---|
| 521 | <DD><DL> |
---|
| 522 | |
---|
| 523 | <DT><B>Returns:</B><DD>boolean</DL> |
---|
| 524 | </DD> |
---|
| 525 | </DL> |
---|
| 526 | <HR> |
---|
| 527 | |
---|
| 528 | <A NAME="isValidValue(edu.stanford.rt.datatype.DataValue)"><!-- --></A><H3> |
---|
| 529 | isValidValue</H3> |
---|
| 530 | <PRE> |
---|
| 531 | public boolean <B>isValidValue</B>(<A HREF="../../../../edu/stanford/rt/datatype/DataValue.html">DataValue</A> v)</PRE> |
---|
| 532 | <DL> |
---|
| 533 | <DD><B>Description copied from class: <CODE><A HREF="../../../../edu/stanford/rt/datatype/SimpleType.html">SimpleType</A></CODE></B></DD> |
---|
| 534 | <DD>Check if the DataValue o is a legal value for its type. |
---|
| 535 | <P> |
---|
| 536 | <DD><DL> |
---|
| 537 | <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../edu/stanford/rt/datatype/SimpleType.html#isValidValue(edu.stanford.rt.datatype.DataValue)">isValidValue</A></CODE> in class <CODE><A HREF="../../../../edu/stanford/rt/datatype/SimpleType.html">SimpleType</A></CODE></DL> |
---|
| 538 | </DD> |
---|
| 539 | <DD><DL> |
---|
| 540 | </DL> |
---|
| 541 | </DD> |
---|
| 542 | </DL> |
---|
| 543 | <HR> |
---|
| 544 | |
---|
| 545 | <A NAME="compares(edu.stanford.rt.datatype.DataValue, edu.stanford.rt.datatype.DataValue)"><!-- --></A><H3> |
---|
| 546 | compares</H3> |
---|
| 547 | <PRE> |
---|
| 548 | public int <B>compares</B>(<A HREF="../../../../edu/stanford/rt/datatype/DataValue.html">DataValue</A> value1, |
---|
| 549 | <A HREF="../../../../edu/stanford/rt/datatype/DataValue.html">DataValue</A> value2)</PRE> |
---|
| 550 | <DL> |
---|
| 551 | <DD><B>Description copied from class: <CODE><A HREF="../../../../edu/stanford/rt/datatype/OrderedType.html">OrderedType</A></CODE></B></DD> |
---|
| 552 | <DD>Method compares. |
---|
| 553 | Compares two DataValue objects. |
---|
| 554 | <P> |
---|
| 555 | <DD><DL> |
---|
| 556 | <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../edu/stanford/rt/datatype/OrderedType.html#compares(edu.stanford.rt.datatype.DataValue, edu.stanford.rt.datatype.DataValue)">compares</A></CODE> in class <CODE><A HREF="../../../../edu/stanford/rt/datatype/OrderedType.html">OrderedType</A></CODE></DL> |
---|
| 557 | </DD> |
---|
| 558 | <DD><DL> |
---|
| 559 | <DT><B>Parameters:</B><DD><CODE>value1</CODE> - <DD><CODE>value2</CODE> - |
---|
| 560 | <DT><B>Returns:</B><DD>int</DL> |
---|
| 561 | </DD> |
---|
| 562 | </DL> |
---|
| 563 | <HR> |
---|
| 564 | |
---|
| 565 | <A NAME="toString(java.lang.String)"><!-- --></A><H3> |
---|
| 566 | toString</H3> |
---|
| 567 | <PRE> |
---|
| 568 | public java.lang.String <B>toString</B>(java.lang.String indent)</PRE> |
---|
| 569 | <DL> |
---|
| 570 | <DD><B>Description copied from class: <CODE><A HREF="../../../../edu/stanford/rt/datatype/DataType.html">DataType</A></CODE></B></DD> |
---|
| 571 | <DD>Method toString. |
---|
| 572 | <P> |
---|
| 573 | <DD><DL> |
---|
| 574 | <DT><B>Overrides:</B><DD><CODE><A HREF="../../../../edu/stanford/rt/datatype/DataType.html#toString(java.lang.String)">toString</A></CODE> in class <CODE><A HREF="../../../../edu/stanford/rt/datatype/DataType.html">DataType</A></CODE></DL> |
---|
| 575 | </DD> |
---|
| 576 | <DD><DL> |
---|
| 577 | <DT><B>Parameters:</B><DD><CODE>indent</CODE> - |
---|
| 578 | <DT><B>Returns:</B><DD>String</DL> |
---|
| 579 | </DD> |
---|
| 580 | </DL> |
---|
| 581 | <!-- ========= END OF CLASS DATA ========= --> |
---|
| 582 | <HR> |
---|
| 583 | |
---|
| 584 | <!-- ========== START OF NAVBAR ========== --> |
---|
| 585 | <A NAME="navbar_bottom"><!-- --></A> |
---|
| 586 | <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0"> |
---|
| 587 | <TR> |
---|
| 588 | <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
---|
| 589 | <A NAME="navbar_bottom_firstrow"><!-- --></A> |
---|
| 590 | <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3"> |
---|
| 591 | <TR ALIGN="center" VALIGN="top"> |
---|
| 592 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
---|
| 593 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
---|
| 594 | <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
---|
| 595 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/EnumType.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
---|
| 596 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
---|
| 597 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
---|
| 598 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
---|
| 599 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
---|
| 600 | </TR> |
---|
| 601 | </TABLE> |
---|
| 602 | </TD> |
---|
| 603 | <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
---|
| 604 | </EM> |
---|
| 605 | </TD> |
---|
| 606 | </TR> |
---|
| 607 | |
---|
| 608 | <TR> |
---|
| 609 | <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
---|
| 610 | <A HREF="../../../../edu/stanford/rt/datatype/DecimalValue.html"><B>PREV CLASS</B></A> |
---|
| 611 | <A HREF="../../../../edu/stanford/rt/datatype/EnumValue.html"><B>NEXT CLASS</B></A></FONT></TD> |
---|
| 612 | <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
---|
| 613 | <A HREF="../../../../index.html" TARGET="_top"><B>FRAMES</B></A> |
---|
| 614 | <A HREF="EnumType.html" TARGET="_top"><B>NO FRAMES</B></A> |
---|
| 615 | |
---|
| 616 | <SCRIPT> |
---|
| 617 | <!-- |
---|
| 618 | if(window==top) { |
---|
| 619 | document.writeln('<A HREF="../../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>'); |
---|
| 620 | } |
---|
| 621 | //--> |
---|
| 622 | </SCRIPT> |
---|
| 623 | <NOSCRIPT> |
---|
| 624 | <A HREF="../../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A> |
---|
| 625 | </NOSCRIPT> |
---|
| 626 | </FONT></TD> |
---|
| 627 | </TR> |
---|
| 628 | <TR> |
---|
| 629 | <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
---|
| 630 | SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> |
---|
| 631 | <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
---|
| 632 | DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> |
---|
| 633 | </TR> |
---|
| 634 | </TABLE> |
---|
| 635 | <!-- =========== END OF NAVBAR =========== --> |
---|
| 636 | |
---|
| 637 | <HR> |
---|
| 638 | |
---|
| 639 | </BODY> |
---|
| 640 | </HTML> |
---|