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 に対するアクセスと処理を行うユーティリティクラスです。

Utility class for accessing and manipulating Enums.

バージョン:

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

作成者:

Stephen Colebourne

関連項目:

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

翻訳者:

日置 聡

翻訳状況:

初稿(校正者募集中)

翻訳更新日:

2003/08/05

コンストラクタの概要

private

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

メソッドの概要

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()

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

Restricted constructor

メソッドの詳細

getEnum

public static Enum getEnum(Class enumClass,
                           String name)

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

Gets an Enum object by class and name.

パラメータ:

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

the class of the Enum to get

name - Enum の名称、または null

the name of the Enum to get, may be null

戻り値:

enum オブジェクト

the enum object

例外:

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

if the enum class is null

getEnum

public static ValuedEnum getEnum(Class enumClass,
                                 int value)

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

Gets a ValuedEnum object by class and value.

パラメータ:

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

the class of the Enum to get

value - 取得する Enum の値

the value of the Enum to get

戻り値:

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

the enum object, or null if the enum does not exist

例外:

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

if the enum class is null

getEnumMap

public static Map getEnumMap(Class enumClass)

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

Gets the Map of Enum objects by name using the Enum class. If the requested class has no enum objects an empty Map is returned. The Map is unmodifiable.

パラメータ:

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

enumClass the class of the Enum to get

戻り値:

enum オブジェクトの Map

the enum object Map

例外:

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

if the enum class is null

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

if the enum class is not a subclass of Enum

getEnumList

public static List getEnumList(Class enumClass)

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

Gets the List of Enum objects using the Enum class. The list is in the order that the objects were created (source code order). If the requested class has no enum objects an empty List is returned. The List is unmodifiable.

パラメータ:

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

the class of the Enum to get

戻り値:

enum オブジェクトの List

the enum object List

例外:

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

if the enum class is null

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

if the enum class is not a subclass of Enum

iterator

public static Iterator iterator(Class enumClass)

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

Gets an iterator over the Enum objects in an Enum class. The iterator is in the order that the objects were created (source code order). If the requested class has no enum objects an empty Iterator is returned. The Iterator is unmodifiable.

パラメータ:

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

enumClass the class of the Enum to get

戻り値:

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

an iterator of the Enum objects

例外:

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

if the enum class is null

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

if the enum class is not a subclass of Enum