enum.html

来自「j2se5-api-zh,java文档的中文版本」· HTML 代码 · 共 502 行 · 第 1/2 页

protected <B>Enum</B>(<A HREF="String.html" title="java.lang 中的类">String</A>&nbsp;name,
               int&nbsp;ordinal)</PRE>
<DL>
<DD>单独的构造方法。程序员无法调用此构造方法。该构造方法用于由响应枚举类型声明的编译器发出的代码。
<P>
<DL>
<DT><B>参数：</B><DD><CODE>name</CODE> - - 此枚举常量的名称，它是用来声明该常量的标识符。<DD><CODE>ordinal</CODE> - - 枚举常量的序数（它在枚举声明中的位置，其中初始常量序数为零）。</DL>
</DL>

<!-- ============ METHOD DETAIL ========== -->

<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>方法详细信息</B></FONT></TH>
</TR>
</TABLE>

<A NAME="name()"><!-- --></A><H3>
name</H3>
<PRE>
public final <A HREF="String.html" title="java.lang 中的类">String</A> <B>name</B>()</PRE>
<DL>
<DD>返回此枚举常量的名称，在其枚举声明中对其进行声明。
<b>与此方法相比，大多数程序员应该优先考虑使用 <A HREF="Enum.html#toString()"><CODE>toString()</CODE></A> 方法，因为 toString 方法返回更加用户友好的名称。</b>该方法主要设计用于特殊情形，其正确性取决于获得正确的名称，其名称不会随版本的改变而改变。
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>返回：</B><DD>枚举常量的名称</DL>
</DD>
</DL>
<HR>

<A NAME="ordinal()"><!-- --></A><H3>
ordinal</H3>
<PRE>
public final int <B>ordinal</B>()</PRE>
<DL>
<DD>返回枚举常量的序数（它在枚举声明中的位置，其中初始常量序数为零）。

大多数程序员不会使用此方法。它被设计用于复杂的基于枚举的数据结构，比如 <A HREF="../util/EnumSet.html" title="java.util 中的类"><CODE>EnumSet</CODE></A> 和 <A HREF="../util/EnumMap.html" title="java.util 中的类"><CODE>EnumMap</CODE></A>。
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>返回：</B><DD>枚举常量的序数</DL>
</DD>
</DL>
<HR>

<A NAME="toString()"><!-- --></A><H3>
toString</H3>
<PRE>
public <A HREF="String.html" title="java.lang 中的类">String</A> <B>toString</B>()</PRE>
<DL>
<DD>返回枚举常量的名称，它包含在声明中。可以重写此方法，虽然一般来说没有必要。当存在更加&ldquo;程序员友好的&rdquo;字符串形式时，应该使用枚举类型重写此方法。
<P>
<DD><DL>
<DT><B>覆盖：</B><DD>类 <CODE><A HREF="Object.html" title="java.lang 中的类">Object</A></CODE> 中的 <CODE><A HREF="Object.html#toString()">toString</A></CODE></DL>
</DD>
<DD><DL>

<DT><B>返回：</B><DD>枚举常量的名称</DL>
</DD>
</DL>
<HR>

<A NAME="equals(java.lang.Object)"><!-- --></A><H3>
equals</H3>
<PRE>
public final boolean <B>equals</B>(<A HREF="Object.html" title="java.lang 中的类">Object</A>&nbsp;other)</PRE>
<DL>
<DD>当指定对象等于此枚举常量时，返回 true。
<P>
<DD><DL>
<DT><B>覆盖：</B><DD>类 <CODE><A HREF="Object.html" title="java.lang 中的类">Object</A></CODE> 中的 <CODE><A HREF="Object.html#equals(java.lang.Object)">equals</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>参数：</B><DD><CODE>other</CODE> - 要与此对象进行相等性比较的对象。
<DT><B>返回：</B><DD>如果指定对象等于此枚举常量，则返回 true。<DT><B>另请参见：</B><DD><A HREF="Object.html#hashCode()"><CODE>Object.hashCode()</CODE></A>, 
<A HREF="../util/Hashtable.html" title="java.util 中的类"><CODE>Hashtable</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="hashCode()"><!-- --></A><H3>
hashCode</H3>
<PRE>
public final int <B>hashCode</B>()</PRE>
<DL>
<DD>返回枚举常量的哈希代码。
<P>
<DD><DL>
<DT><B>覆盖：</B><DD>类 <CODE><A HREF="Object.html" title="java.lang 中的类">Object</A></CODE> 中的 <CODE><A HREF="Object.html#hashCode()">hashCode</A></CODE></DL>
</DD>
<DD><DL>

<DT><B>返回：</B><DD>枚举常量的哈希代码。<DT><B>另请参见：</B><DD><A HREF="Object.html#equals(java.lang.Object)"><CODE>Object.equals(java.lang.Object)</CODE></A>, 
<A HREF="../util/Hashtable.html" title="java.util 中的类"><CODE>Hashtable</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="clone()"><!-- --></A><H3>
clone</H3>
<PRE>
protected final <A HREF="Object.html" title="java.lang 中的类">Object</A> <B>clone</B>()
                      throws <A HREF="CloneNotSupportedException.html" title="java.lang 中的类">CloneNotSupportedException</A></PRE>
<DL>
<DD>抛出 CloneNotSupportedException。这可保证永远不会克隆枚举，这对于保留其&ldquo;单元素&rdquo;状态是必需的。
<P>
<DD><DL>
<DT><B>覆盖：</B><DD>类 <CODE><A HREF="Object.html" title="java.lang 中的类">Object</A></CODE> 中的 <CODE><A HREF="Object.html#clone()">clone</A></CODE></DL>
</DD>
<DD><DL>

<DT><B>返回：</B><DD>此实例的一个克隆。
<DT><B>抛出：</B>
<DD><CODE><A HREF="CloneNotSupportedException.html" title="java.lang 中的类">CloneNotSupportedException</A></CODE> - 如果对象的类不支持 <code>Cloneable</code> 接口，则重写 <code>clone</code> 方法的子类也会抛出此异常，以指示无法克隆某个实例。<DT><B>另请参见：</B><DD><A HREF="Cloneable.html" title="java.lang 中的接口"><CODE>Cloneable</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="compareTo(java.lang.Enum)"><!-- --></A><A NAME="compareTo(E)"><!-- --></A><H3>
compareTo</H3>
<PRE>
public final int <B>compareTo</B>(<A HREF="Enum.html" title="Enum 中的类型参数">E</A>&nbsp;o)</PRE>
<DL>
<DD>比较此枚举与指定对象的顺序。在该对象小于、等于或大于指定对象时，分别返回负整数、零或正整数。

枚举常量只能与相同枚举类型的其他枚举常量进行比较。该方法实现的自然顺序就是声明常量的顺序。
<P>
<DD><DL>
<DT><B>指定者：</B><DD>接口 <CODE><A HREF="Comparable.html" title="java.lang 中的接口">Comparable</A>&lt;<A HREF="Enum.html" title="Enum 中的类型参数">E</A> extends <A HREF="Enum.html" title="java.lang 中的类">Enum</A>&lt;<A HREF="Enum.html" title="Enum 中的类型参数">E</A>&gt;&gt;</CODE> 中的 <CODE><A HREF="Comparable.html#compareTo(T)">compareTo</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>参数：</B><DD><CODE>o</CODE> - 要比较的对象。
<DT><B>返回：</B><DD>负整数、零或正整数，根据此对象是小于、等于还是大于指定对象。</DL>
</DD>
</DL>
<HR>

<A NAME="getDeclaringClass()"><!-- --></A><H3>
getDeclaringClass</H3>
<PRE>
public final <A HREF="Class.html" title="java.lang 中的类">Class</A>&lt;<A HREF="Enum.html" title="Enum 中的类型参数">E</A>&gt; <B>getDeclaringClass</B>()</PRE>
<DL>
<DD>返回与此枚举常量的枚举类型相对应的 Class 对象。当且仅当 e1.getDeclaringClass() == e2.getDeclaringClass() 时，两个枚举常量 e1 和 e2 的枚举类型才相同。（由该方法返回的值不同于由 <A HREF="Object.html#getClass()"><CODE>Object.getClass()</CODE></A> 方法返回的值，<A HREF="Object.html#getClass()"><CODE>Object.getClass()</CODE></A> 方法用于带有特定常量的类主体的枚举常量。）
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>返回：</B><DD>与此枚举常量的枚举类型相对应的 Class 对象</DL>
</DD>
</DL>
<HR>

<A NAME="valueOf(java.lang.Class, java.lang.String)"><!-- --></A><H3>
valueOf</H3>
<PRE>
public static &lt;T extends <A HREF="Enum.html" title="java.lang 中的类">Enum</A>&lt;T&gt;&gt; T <B>valueOf</B>(<A HREF="Class.html" title="java.lang 中的类">Class</A>&lt;T&gt;&nbsp;enumType,
                                            <A HREF="String.html" title="java.lang 中的类">String</A>&nbsp;name)</PRE>
<DL>
<DD>返回带指定名称的指定枚举类型的枚举常量。名称必须与在此类型中声明枚举常量所用的标识符完全匹配。（不允许使用额外的空白字符。）
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>参数：</B><DD><CODE>enumType</CODE> - 要从中返回常量的枚举类型的 <tt>Class</tt> 对象<DD><CODE>name</CODE> - 要返回的常量名称
<DT><B>返回：</B><DD>带指定名称的指定枚举类型的枚举常量
<DT><B>抛出：</B>
<DD><CODE><A HREF="IllegalArgumentException.html" title="java.lang 中的类">IllegalArgumentException</A></CODE> - 如果指定枚举类型不包含指定名称的常量，或者指定类对象不表示枚举类型
<DD><CODE><A HREF="NullPointerException.html" title="java.lang 中的类">NullPointerException</A></CODE> - 如果 <tt>enumType</tt> 或 <tt>name</tt> 为空<DT><B>从以下版本开始：</B></DT>
  <DD>1.5</DD>
</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>


<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="跳过导航链接"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  <TR ALIGN="center" VALIGN="top">
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>概述</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>软件包</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>类</B></FONT>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/Enum.html"><FONT CLASS="NavBarFont1"><B>使用</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>树</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>已过时</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>索引</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>帮助</B></FONT></A>&nbsp;</TD>
  </TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
<b>Java<sup><font size=-2>TM</font></sup>&nbsp;2&nbsp;Platform<br>Standard&nbsp;Ed. 5.0</b></EM>
</TD>
</TR>

<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="Double.html" title="java.lang 中的类"><B>上一个类</B></A>&nbsp;
&nbsp;<A HREF="EnumConstantNotPresentException.html" title="java.lang 中的类"><B>下一个类</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  <A HREF="../../index.html@java_2Flang_2FEnum.html" target="_top"><B>框架</B></A>  &nbsp;
&nbsp;<A HREF="Enum.html" target="_top"><B>无框架</B></A>  &nbsp;
&nbsp;<SCRIPT type="text/javascript">
  <!--
  if(window==top) {
    document.writeln('<A HREF="../../allclasses-noframe.html"><B>所有类</B></A>');
  }
  //-->
</SCRIPT>
<NOSCRIPT>
  <A HREF="../../allclasses-noframe.html"><B>所有类</B></A>
</NOSCRIPT>


</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  摘要：&nbsp;嵌套&nbsp;|&nbsp;字段&nbsp;|&nbsp;<A HREF="#constructor_summary">构造方法</A>&nbsp;|&nbsp;<A HREF="#method_summary">方法</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
详细信息：&nbsp;字段&nbsp;|&nbsp;<A HREF="#constructor_detail">构造方法</A>&nbsp;|&nbsp;<A HREF="#method_detail">方法</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->

<HR>
<font size="-1"><a href="../../../../../../../../java.sun.com/cgi-bin/bugreport.cgi">提交错误或意见</a><br>有关更多的 API 参考资料和开发人员文档，请参阅 <a href="../../../../../../../../java.sun.com/j2se/1.5.0/docs/relnotes/devdocs-vs-specs.html">Java 2 SDK SE 开发人员文档</a>。该文档包含更详细的、面向开发人员的描述，以及总体概述、术语定义、使用技巧和工作代码示例。 <p>版权所有 2004 Sun Microsystems, Inc. 保留所有权利。 请遵守<a href="../../../../../../../../java.sun.com/j2se/1.5.0/docs/relnotes/license.html">许可证条款</a>。另请参阅<a href="../../../../../../../../java.sun.com/docs/redist.html">文档重新分发政策</a>。</font>
</BODY>
</HTML>