Platform SDK Java 8.5 API Reference

com.genesyslab.platform.configuration.protocol.metadata
Class CfgDescriptionEnum<E extends GEnum>

java.lang.Object
  extended by com.genesyslab.platform.configuration.protocol.metadata.CfgDescription
      extended by com.genesyslab.platform.configuration.protocol.metadata.CfgDescriptionEnum<E>
All Implemented Interfaces:
ICfgEnum<CfgEnumType>

public final class CfgDescriptionEnum<E extends GEnum>
extends CfgDescription
implements ICfgEnum<CfgEnumType>

CfgDescriptionEnum<T> class is descriptive class for configuration protocol enums.

CfgDescriptionEnum<T> class is derived from CfgDescription class. CfgDescriptionEnum<T> also inherits ICfgEnum<T> interface realizing the 'Optional Feature' pattern. The whole set of the configuration enums is listed in the CfgEnumType enum. In case of CfgDescriptionObject, ICfgEnum<T>.CfgEnum implementation returns the enum value for the configuration object a particular CfgDescriptionEnum<T> class' instance describes.

See Also:
CfgEnumType, CfgDescriptionObject, CfgDescriptionStructure, CfgDescriptionAttribute, ICfgEnum

Field Summary
 
Fields inherited from class com.genesyslab.platform.configuration.protocol.metadata.CfgDescription
baseComparer
 
Method Summary
 CfgEnumType getCfgEnum()
          Gets corresponding value from enum for a particular descriptive class' instance.
 java.lang.Class<E> getCfgEnumClass()
           
 CfgDescriptionAttributeEnumItem<E> getItem(E enumItem)
          Gets enum item description (CfgDescriptionAttributeEnumItem<T>) for a particular descriptive class' instance.
 CfgDescriptionAttributeEnumItem<E> getItem(java.lang.String enumLiteral)
          Gets enum item description (CfgDescriptionAttributeEnumItem<T>) for a particular descriptive class' instance.
 java.util.Collection<CfgDescriptionAttributeEnumItem<E>> getItems()
          Gets enum the collection of item descriptions (CfgDescriptionAttributeEnumItem<T>) for a particular descriptive enum's instance.
protected  void setComparer()
           
protected  void setTypeMask()
          Sets type mask for descriptive object.
 
Methods inherited from class com.genesyslab.platform.configuration.protocol.metadata.CfgDescription
addTypeToMask, getComparer, getIndex, getLocalizedName, getName, getNameComparer, getProtocolVersion, getTypeBitMask, getTypeMask, getTypeMaskString, isCfgType, isCfgType, isCfgType, setComparer, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Method Detail

getCfgEnum

public CfgEnumType getCfgEnum()
Gets corresponding value from enum for a particular descriptive class' instance.

Specified by:
getCfgEnum in interface ICfgEnum<CfgEnumType>
Returns:
Corresponding enum value

getCfgEnumClass

public java.lang.Class<E> getCfgEnumClass()

getItems

public java.util.Collection<CfgDescriptionAttributeEnumItem<E>> getItems()
Gets enum the collection of item descriptions (CfgDescriptionAttributeEnumItem<T>) for a particular descriptive enum's instance.

See Also:
CfgEnumType

getItem

public CfgDescriptionAttributeEnumItem<E> getItem(java.lang.String enumLiteral)
Gets enum item description (CfgDescriptionAttributeEnumItem<T>) for a particular descriptive class' instance.

See Also:
CfgEnumType

getItem

public CfgDescriptionAttributeEnumItem<E> getItem(E enumItem)
Gets enum item description (CfgDescriptionAttributeEnumItem<T>) for a particular descriptive class' instance.

Parameters:
enumItem - Used to provide a particular enum item
See Also:
CfgEnumType

setTypeMask

protected void setTypeMask()
Description copied from class: CfgDescription
Sets type mask for descriptive object.

Specified by:
setTypeMask in class CfgDescription

setComparer

protected void setComparer()
Specified by:
setComparer in class CfgDescription

Platform SDK Java 8.5 API Reference

Send comments on this topicTechpubs.webadmin@genesys.com.
Document version: 8.5.302.00
Copyright © 2006–2017 Genesys Telecommunications Laboratories, Inc. All rights reserved.