org.apache.commons.lang.enum
クラス Enum

java.lang.Object
  org.apache.commons.lang.enum.Enum

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

Comparable, Serializable

直系の既知のサブクラス:

ValuedEnum

public abstract class Enum

extends Object

implements Comparable, Serializable

タイプセーフな enum のスーパークラスとなる抽象クラスです。

C言語にあって Java に欠けている機能の一つが列挙型です。 int をベースにした C の実装は不十分で誤用を招きます。 オリジナルの Java の勧告とほとんどのJDKは int を不変の値として使用します。 しかしより強固でタイプセーフなクラスをベースにされた解決策がデザインされています。 このクラスは基本的なタイプセーフな列挙型のパターンを提供します。

注: Java クラスローダの処理に依存して結果が変わるため Enum オブジェクトの比較には == ではなく equals() メソッドを使う必要があります。 The equals() メソッドは初めに == を実行するため、たいていの場合は同じ結果になります。

このクラスは継承して使用する必要があります。 例えば:

 public final class ColorEnum extends Enum {
   public static final ColorEnum RED = new ColorEnum("Red");
   public static final ColorEnum GREEN = new ColorEnum("Green");
   public static final ColorEnum BLUE = new ColorEnum("Blue");

   private ColorEnum(String color) {
     super(color);
   }
 
   public static ColorEnum getEnum(String color) {
     return (ColorEnum) getEnum(ColorEnum.class, color);
   }
 
   public static Map getEnumMap() {
     return getEnumMap(ColorEnum.class);
   }
 
   public static List getEnumList() {
     return getEnumList(ColorEnum.class);
   }
 
   public static Iterator iterator() {
     return iterator(ColorEnum.class);
   }
 }
 

上に見られるように各 enum は名前をもっています。 これには getName を使用することによりアクセスできます。

getEnum と iterator のメソッドの使用をお勧めします。 不幸なことに、Javaの制限のために各サブクラス毎にこのようなコードが必要となってしまいます。 この代案は EnumUtils クラスの使用です。

注: このクラスのオリジナルは Jakarta Avalon プロジェクト内にあります。

バージョン:

$Id: Enum.java,v 1.1.1.1 2004/02/13 10:02:04 hioki Exp $

作成者:

Stephen Colebourne

関連項目:

直列化された形式

翻訳者:

日置 聡

入れ子クラスの概要

private static class

Enum.Entry ソースコードの順序を保持してイテレータを使用可能とします。

フィールドの概要

private static Map	cEnumClasses キーがクラス名、値がエントリーの Map。
private static Map	EMPTY_MAP 空のマップ(JDK1.2 は空のマップを持っていないので)。
private String	iName Enum を表現する名称。

コンストラクタの概要

protected

Enum(String name) 列挙型に追加する新しい名称のアイテムを生成します。

メソッドの概要

int	compareTo(Object other) 順序をチェックします。
boolean	equals(Object other) 等しいかどうかのチェックを行います。
protected static Enum	getEnum(Class enumClass, String name) クラスと名称から Enum を取得します。
protected static List	getEnumList(Class enumClass) Enum クラスを使用して Enum オブジェクトのリストを取得します。
protected static Map	getEnumMap(Class enumClass) Enum クラスの名称から Enum オブジェクトの Map を取得します。
String	getName() コンストラクタで設定された Enum アイテムの名称を取得します。
int	hashCode() 適切な列挙型のハッシュコードを返します。
protected static Iterator	iterator(Class enumClass) Enum クラス内の Enum オブジェクトを走査するイテレータを取得します。.
protected Object	readResolve() 複数のコピーが無駄に生成される、または不正な enum 型が生成される事のないようにクラスの直列化復元を処理します。
String	toString() Enum アイテムを読みやすい形で返します。

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

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

フィールドの詳細

EMPTY_MAP

private static final Map EMPTY_MAP

空のマップ(JDK1.2 は空のマップを持っていないので)。

cEnumClasses

private static final Map cEnumClasses

キーがクラス名、値がエントリーの Map。

iName

private final String iName

Enum を表現する名称。

コンストラクタの詳細

Enum

protected Enum(String name)

列挙型に追加する新しい名称のアイテムを生成します。

パラメータ:

name - enum オブジェクトの名称

例外:

IllegalArgumentException - 名称が null または空の文字列だった場合

メソッドの詳細

readResolve

protected Object readResolve()

複数のコピーが無駄に生成される、または不正な enum 型が生成される事のないようにクラスの直列化復元を処理します。

戻り値:

解決されたオブジェクト

getEnum

protected static Enum getEnum(Class enumClass,
                              String name)

クラスと名称から Enum を取得します。

パラメータ:

enumClass - 取得元となる Enum クラス

name - Enum の名称、または null

戻り値:

enum オブジェクト、該当する enum が存在しない場合には null

例外:

IllegalArgumentException - enum クラスが null だった場合

getEnumMap

protected static Map getEnumMap(Class enumClass)

Enum クラスの名称から Enum オブジェクトの Map を取得します。 要求されたクラスが Enum オブジェクトを持っていなかった場合には空の Map を返します。

パラメータ:

enumClass - 取得元となる Enum クラス

戻り値:

enum オブジェクトの Map

例外:

IllegalArgumentException - enum クラスが null だった場合

IllegalArgumentException - enum クラスが Enum のサブクラスでなかった場合

getEnumList

protected static List getEnumList(Class enumClass)

Enum クラスを使用して Enum オブジェクトのリストを取得します。 このリスト内はオブジェクトの生成された順番に並んでいます(ソースコード内の順番)。 指定されたクラスが enum オブジェクトを持っていない場合には空の List を返します。

パラメータ:

enumClass - 取得元となる Enum クラス

戻り値:

enum オブジェクトの List

例外:

IllegalArgumentException - enum クラスが null だった場合

IllegalArgumentException - enum クラスが Enum のサブクラスでなかった場合

iterator

protected static Iterator iterator(Class enumClass)

Enum クラス内の Enum オブジェクトを走査するイテレータを取得します。. このイテレータはオブジェクトの生成された順番に並んでいます(ソースコード内の順番)。 指定されたクラスが enum オブジェクトを持っていない場合には空の Iterator を返します。

パラメータ:

enumClass - 取得元となる Enum クラス

戻り値:

an enum オブジェクトの イテレータ

例外:

IllegalArgumentException - enum クラスが null だった場合

IllegalArgumentException - enum クラスが Enum のサブクラスでなかった場合

getName

public final String getName()

コンストラクタで設定された Enum アイテムの名称を取得します。

戻り値:

Enum アイテムの名称

equals

public final boolean equals(Object other)

等しいかどうかのチェックを行います。 2つの Enum オブジェクト の判定は、クラス名と名称が等しいかどうかにより行われます。 同一であるかのチェック(==の事)が最初に行われるため、たいていの場合このメソッドは高速に動作します。

パラメータ:

other - 等しいかどうかの比較対照となるオブジェクト

戻り値:

Enums が等しい場合 true

hashCode

public final int hashCode()

適切な列挙型のハッシュコードを返します。

戻り値:

名称をベースとするハッシュコード

compareTo

public int compareTo(Object other)

順序をチェックします。 デフォルトの順番は名称のアルファベット順となりますが、これはサブクラスによってオーバライドされます。

定義:

インタフェース Comparable 内の compareTo

パラメータ:

other - 比較対照となるオブジェクト

戻り値:

比較対照より小さかった場合 -ve(マイナス)、比較対照より大きかった場合 +ve(プラス)、等しかった場合 0

例外:

ClassCastException - 比較対照が Enum でなかった場合

NullPointerException - 比較対照が null だった場合

関連項目:

Comparable.compareTo(Object)

toString

public String toString()

Enum アイテムを読みやすい形で返します。 デバッグの際に使用されます。

戻り値:

type[name] のフォームの文字列、例: Color[Red]、 注 型の名前の中のパッケージ名は省略されます。