ShortCodedLabeledEnum (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
Class ShortCodedLabeledEnum

java.lang.Object
  org.springframework.core.enums.AbstractLabeledEnum
      org.springframework.core.enums.AbstractGenericLabeledEnum
          org.springframework.core.enums.ShortCodedLabeledEnum

All Implemented Interfaces:: Serializable, Comparable, LabeledEnum

public class ShortCodedLabeledEnum
extends AbstractGenericLabeledEnum
extends AbstractGenericLabeledEnum

Implementation of LabeledEnum which uses Short as the code type.

Should almost always be subclassed, but for some simple situations it may be used directly. Note that you will not be able to use unique type-based functionality like LabeledEnumResolver.getLabeledEnumSet(type) in this case.

Since:: 1.2.2
Author:: Keith Donald
See Also:: Serialized Form

Field Summary

Fields inherited from interface org.springframework.core.enums.LabeledEnum

CODE_ORDER, DEFAULT_ORDER, LABEL_ORDER

Constructor Summary

ShortCodedLabeledEnum(int code, String label)
          Create a new ShortCodedLabeledEnum instance.

Method Summary

Comparable getCode()
          Return this enumeration's code.

short getShortCode()
          Return the short code of this LabeledEnum instance.

Methods inherited from class org.springframework.core.enums.AbstractGenericLabeledEnum

getLabel

Methods inherited from class org.springframework.core.enums.AbstractLabeledEnum

compareTo, equals, getType, hashCode, toString

Methods inherited from class java.lang.Object

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

Fields inherited from interface org.springframework.core.enums.LabeledEnum
`CODE_ORDER, DEFAULT_ORDER, LABEL_ORDER`

Constructor Summary
`ShortCodedLabeledEnum(int code, String label)` Create a new ShortCodedLabeledEnum instance.

Method Summary
`Comparable`	`getCode()` Return this enumeration's code.
`short`	`getShortCode()` Return the short code of this LabeledEnum instance.

Methods inherited from class org.springframework.core.enums.AbstractGenericLabeledEnum
`getLabel`

Methods inherited from class org.springframework.core.enums.AbstractLabeledEnum
`compareTo, equals, getType, hashCode, toString`

Methods inherited from class java.lang.Object
`clone, finalize, getClass, notify, notifyAll, wait, wait, wait`

Constructor Detail

ShortCodedLabeledEnum

public ShortCodedLabeledEnum(int code,
                             String label)

Create a new ShortCodedLabeledEnum instance.

Parameters:: code - the short code; label - the label (can be null)

Method Detail

getCode

public Comparable getCode()

Description copied from interface: LabeledEnum

Return this enumeration's code.

Each code should be unique within enumeration's of the same type.

getShortCode

public short getShortCode()

Return the short code of this LabeledEnum instance.