Platform SDK Java 8.5 API Reference

com.genesyslab.platform.contacts.protocol.contactserver
Class NamedGEnum

java.lang.Object
  extended by com.genesyslab.platform.commons.GEnum
      extended by com.genesyslab.platform.contacts.protocol.contactserver.NamedGEnum
Direct Known Subclasses:
CoBrowseAction, DataSourceType, EntityTypes, ErrorCodes, IndexNameType, Operators, Prefixes, ResponseType, SortMode, Statuses

public abstract class NamedGEnum
extends GEnum

Extended enumeration class to support non-integer enumerations with additional value for more friendly value representation in XML.


Field Summary
 
Fields inherited from class com.genesyslab.platform.commons.GEnum
LOCALE_ENGLISH
 
Constructor Summary
protected NamedGEnum(int ordinal, java.lang.String name, java.lang.String longName, java.lang.Class cls)
           
 
Method Summary
 java.lang.String getLongName()
          Returns additional enum value name for more friendly presentation in XML.
static NamedGEnum getValue(java.lang.Class enumClass, java.lang.String name)
          Return enum value with specified name/longName or null if no such value exists.
 java.lang.String toString()
           
 
Methods inherited from class com.genesyslab.platform.commons.GEnum
asInteger, enumSize, equals, equals, getEnumMap, getEnumValues, getValue, getValue, hashCode, name, ordinal, valueOf, valueOf, values, valuesBy
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

NamedGEnum

protected NamedGEnum(int ordinal,
                     java.lang.String name,
                     java.lang.String longName,
                     java.lang.Class cls)
Method Detail

getLongName

public java.lang.String getLongName()
Returns additional enum value name for more friendly presentation in XML.

Returns:
additional name of the enum instance

getValue

public static NamedGEnum getValue(java.lang.Class enumClass,
                                  java.lang.String name)
Return enum value with specified name/longName or null if no such value exists.

Parameters:
enumClass - Actual class of the enum
name - name or longName of value in the enum
Returns:
enum value with specified ordinal or null
Throws:
java.lang.IllegalArgumentException - if enumClass is not enum

toString

public java.lang.String toString()
Overrides:
toString in class GEnum

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.