java.lang

クラス Enum<E extends Enum<E>>

java.lang.Object

java.lang.Enum<E>

型パラメータ:

E - 列挙型のサブクラス

すべての実装されたインタフェース:

Serializable, Comparable<E>

public abstract class Enum<E extends Enum<E>>
extends Object
implements Comparable<E>, Serializable

すべての Java 言語列挙型の共通の基底クラスです。 コンパイラによって合成される暗黙宣言メソッドの説明など、列挙の詳細については、『Java™ 言語仕様』のセクション 8.9 を参照してください。

列挙型をセットの型やマップ内のキーの型として使用する場合は、特殊化された効率的なセット実装やマップ実装を使用できます。

導入されたバージョン:

1.5

関連項目:

Class.getEnumConstants(), EnumSet, EnumMap, 直列化された形式

コンストラクタのサマリー

コンストラクタ

修飾子	コンストラクタと説明
protected	Enum(String name, int ordinal) 唯一のコンストラクタです。

メソッドのサマリー

メソッド

修飾子と型	メソッドと説明
protected Object	clone() CloneNotSupportedException をスローします。
int	compareTo(E o) この enum と指定されたオブジェクトの順序を比較します。
boolean	equals(Object other) 指定されたオブジェクトがこの enum 定数と同じ場合は、true を返します。
protected void	finalize() enum クラスは finalize メソッドを持つことはできません。
Class<E>	getDeclaringClass() この enum 定数の enum 型に対応する Class オブジェクトを返します。
int	hashCode() この enum 定数のハッシュコードを返します。
String	name() enum 宣言で宣言されているとおりの enum 定数の名前を返します。
int	ordinal() 列挙定数の序数 (列挙宣言での位置。初期定数はゼロの序数に割り当てられる) を返します。
String	toString() 宣言に含まれるとおりの enum 定数の名前を返します。
static <T extends Enum<T>> T	valueOf(Class<T> enumType, String name) 指定された名前を持つ指定された enum 型の enum 定数を返します。

クラス java.lang.Object から継承されたメソッド

getClass, notify, notifyAll, wait, wait, wait

コンストラクタの詳細

列挙型

protected Enum(String name,
    int ordinal)

唯一のコンストラクタです。プログラマは、このコンストラクタを呼び出すことはできません。このコンストラクタは、enum 型宣言に対する応答で、コンパイラにより生成されるコードで使用するためのものです。

パラメータ:

name - - この enum 定数の名前。enum を宣言するために使われる識別子。

ordinal - - 列挙定数の序数 (enum 宣言での位置。初期定数はゼロの序数に割り当てられる)。

メソッドの詳細

name

public final String name()

enum 宣言で宣言されているとおりの enum 定数の名前を返します。 ほとんどのプログラマは、このメソッドよりも toString() メソッドを使う必要があります。これは、toString メソッドの方がユーザーフレンドリな名前を返すことができるからです。このメソッドは、リリース間で変わることがない name 値自体の取得に依存するような特殊な状況で主に使用するために設計されています。

戻り値:

この enum 定数の名前

ordinal

public final int ordinal()

列挙定数の序数 (列挙宣言での位置。初期定数はゼロの序数に割り当てられる) を返します。 このメソッドは、ほとんどのプログラマにとって役に立ちません。それは、EnumSet や EnumMap などの洗練された enum ベースのデータ構造で使用するために設計されています。

戻り値:

この列挙定数の序数

toString

public String toString()

宣言に含まれるとおりの enum 定数の名前を返します。このメソッドは不要な場合や不適切な場合にオーバーライドできます。より「プログラマフレンドリ」な文字列形式が存在する場合、enum 型はこのメソッドをオーバーライドする必要があります。

オーバーライド:

toString、クラス: Object

戻り値:

この enum 定数の名前

equals

public final boolean equals(Object other)

指定されたオブジェクトがこの enum 定数と同じ場合は、true を返します。

オーバーライド:

equals、クラス: Object

パラメータ:

other - このオブジェクトと等しいかどうかを比較するオブジェクト。

戻り値:

指定されたオブジェクトがこの enum 定数と同じ場合は true

関連項目:

Object.hashCode()、HashMap

hashCode

public final int hashCode()

この enum 定数のハッシュコードを返します。

オーバーライド:

hashCode、クラス: Object

戻り値:

この enum 定数のハッシュコード

関連項目:

Object.equals(java.lang.Object), System.identityHashCode(java.lang.Object)

clone

protected final Object clone()
                      throws CloneNotSupportedException

CloneNotSupportedException をスローします。これにより、「単体」ステータスを維持する必要がある enum が複製されないことが保証されます。

オーバーライド:

clone、クラス: Object

戻り値:

(返さない)

例外:

CloneNotSupportedException - オブジェクトのクラスが Cloneable インタフェースをサポートしていない場合。clone メソッドをオーバーライドしたサブクラスも、インスタンスを複製できないことを示すためにこの例外をスローすることがある。

関連項目:

Cloneable

compareTo

public final int compareTo(E o)

この enum と指定されたオブジェクトの順序を比較します。このオブジェクトが指定されたオブジェクトより小さい場合は負の整数、等しい場合はゼロ、大きい場合は正の整数を返します。 enum 定数は、同じ enum 型のほかの enum 定数だけと比較できます。このメソッドにより実装される自然の順番は、定数が宣言された順番です。

定義:

compareTo、インタフェース: Comparable<E extends Enum<E>>

パラメータ:

o -比較対象のオブジェクト。

戻り値:

このオブジェクトが指定されたオブジェクトより小さい場合は負の整数、等しい場合はゼロ、大きい場合は正の整数

getDeclaringClass

public final Class<E> getDeclaringClass()

この enum 定数の enum 型に対応する Class オブジェクトを返します。e1.getDeclaringClass() == e2.getDeclaringClass() の場合だけ、2 つの enum 定数 e1 と e2 は同じ enum 型の enum 定数です。このメソッドにより返される値は、定数固有のクラス本文を持つ enum 定数について Object.getClass() メソッドで返される値とは異なる可能性があります。

戻り値:

この enum 定数の enum 型に対応する Class オブジェクト

valueOf

public static <T extends Enum<T>> T valueOf(Class<T> enumType,
                            String name)

指定された名前を持つ指定された enum 型の enum 定数を返します。この名前は、この型で enum 定数を宣言するのに使用される識別子に一致しなければいけません。不適切な空白文字は許可されません。

特定の列挙型 T について、その列挙上の暗黙的に宣言された public static T valueOf(String) メソッドをこのメソッドの代わりに使用すれば、名前から対応する列挙定数へのマッピングを行うことができます。列挙型のすべての定数を取得するには、その型の暗黙的な public static T[] values() メソッドを呼び出します。

型パラメータ:

T - 返す定数を含んでいる列挙型

パラメータ:

enumType - 定数が返される enum 型の Class オブジェクト

name - 返される定数の名前

戻り値:

指定された名前を持つ指定された enum 型の enum 定数

例外:

IllegalArgumentException - 指定された enum 型が指定された名前の定数を持たない場合、または指定されたクラスオブジェクトが enum 型を表さない場合

NullPointerException - enumType または name が null の場合

導入されたバージョン:

1.5

finalize

protected final void finalize()

enum クラスは finalize メソッドを持つことはできません。

オーバーライド:

finalize、クラス: Object