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

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

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

Comparable, Serializable

public abstract class EnumUtils

extends Object

implements Comparable, Serializable

Enum に対するアクセスと処理を行うユーティリティクラスです。

バージョン:

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

作成者:

Stephen Colebourne

関連項目:

Enum, ValuedEnum, 直列化された形式

翻訳者:

日置 聡

コンストラクタの概要

private

EnumUtils() 制限されたコンストラクタ

メソッドの概要

static ValuedEnum	getEnum(Class enumClass, int value) クラスと値から ValuedEnum を取得します。
static Enum	getEnum(Class enumClass, String name) クラスと名称から Enum を取得します。
static List	getEnumList(Class enumClass) Enum クラスを使用して Enum オブジェクトのリストを取得します。
static Map	getEnumMap(Class enumClass) Enum クラスの名称から Enum オブジェクトの Map を取得します。
static Iterator	iterator(Class enumClass) Enum クラス内の Enum オブジェクトを走査するイテレータを取得します。.

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

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

インタフェース java.lang.Comparable から継承したメソッド

compareTo

コンストラクタの詳細

EnumUtils

private EnumUtils()

制限されたコンストラクタ

メソッドの詳細

getEnum

public static Enum getEnum(Class enumClass,
                           String name)

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

パラメータ:

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

name - Enum の名称、または null

戻り値:

enum オブジェクト

例外:

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

getEnum

public static ValuedEnum getEnum(Class enumClass,
                                 int value)

クラスと値から ValuedEnum を取得します。

パラメータ:

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

value - 取得する Enum の値

戻り値:

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

例外:

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

getEnumMap

public static Map getEnumMap(Class enumClass)

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

パラメータ:

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

戻り値:

enum オブジェクトの Map

例外:

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

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

getEnumList

public static List getEnumList(Class enumClass)

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

パラメータ:

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

戻り値:

enum オブジェクトの List

例外:

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

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

iterator

public static Iterator iterator(Class enumClass)

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

パラメータ:

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

戻り値:

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

例外:

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

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