LabeledEnumResolver (Spring Framework API 2.1) - Spring Framework 2.1.0 API 文档英文版

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

The Spring Framework

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.springframework.core.enums
Interface LabeledEnumResolver

All Known Implementing Classes:: AbstractCachingLabeledEnumResolver, StaticLabeledEnumResolver

public interface LabeledEnumResolver

Interface for looking up LabeledEnum instances.

Since:: 1.2.2
Author:: Keith Donald, Juergen Hoeller

Method Summary

LabeledEnum getLabeledEnumByCode(Class type, Comparable code)
          Resolve a single LabeledEnum by its identifying code.

LabeledEnum getLabeledEnumByLabel(Class type, String label)
          Resolve a single LabeledEnum by its identifying code.

Map getLabeledEnumMap(Class type)
          Return a map of enumerations of a particular type.

Set getLabeledEnumSet(Class type)
          Return a set of enumerations of a particular type.

Method Summary
`LabeledEnum`	`getLabeledEnumByCode(Class type, Comparable code)` Resolve a single `LabeledEnum` by its identifying code.
`LabeledEnum`	`getLabeledEnumByLabel(Class type, String label)` Resolve a single `LabeledEnum` by its identifying code.
`Map`	`getLabeledEnumMap(Class type)` Return a map of enumerations of a particular type.
`Set`	`getLabeledEnumSet(Class type)` Return a set of enumerations of a particular type.

Method Detail

getLabeledEnumSet

Set getLabeledEnumSet(Class type)
                      throws IllegalArgumentException

Return a set of enumerations of a particular type. Each element in the set should be an instance of LabeledEnum.

Parameters:: type - the enum type
Returns:: a set of localized enumeration instances for the provided type
Throws:: IllegalArgumentException - if the type is not supported

getLabeledEnumMap

Map getLabeledEnumMap(Class type)
                      throws IllegalArgumentException

Return a map of enumerations of a particular type. Each element in the map should be a key/value pair, where the key is the enum code, and the value is the LabeledEnum instance.

Parameters:: type - the enum type
Returns:: a Map of localized enumeration instances, with enum code as key and LabeledEnum instance as value
Throws:: IllegalArgumentException - if the type is not supported

getLabeledEnumByCode

LabeledEnum getLabeledEnumByCode(Class type,
                                 Comparable code)
                                 throws IllegalArgumentException

Resolve a single LabeledEnum by its identifying code.

Parameters:: type - the enum type; code - the enum code
Returns:: the enum
Throws:: IllegalArgumentException - if the code did not map to a valid instance

getLabeledEnumByLabel

LabeledEnum getLabeledEnumByLabel(Class type,
                                  String label)
                                  throws IllegalArgumentException