com.smartgwt.client.types
Enum EnumTranslateStrategy

java.lang.Object
  extended by java.lang.Enum<EnumTranslateStrategy>
      extended by com.smartgwt.client.types.EnumTranslateStrategy
All Implemented Interfaces:
ValueEnum, Serializable, Comparable<EnumTranslateStrategy>

public enum EnumTranslateStrategy
extends Enum<EnumTranslateStrategy>
implements ValueEnum

Determines how Java enums are translated to and from Javascript by the SmartClient server.


Enum Constant Summary
BEAN
          Translates to/from a Javascript object containing one property for each property defined within the enum.
ORDINAL
          Translates to/from an integer matching the ordinal number of the constant within the enumeration
STRING
          Translates to/from a String matching the constant name.
 
Method Summary
 String getValue()
           
static EnumTranslateStrategy valueOf(String name)
          Returns the enum constant of this type with the specified name.
static EnumTranslateStrategy[] values()
          Returns an array containing the constants of this enum type, in the order they are declared.
 
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

STRING

public static final EnumTranslateStrategy STRING
Translates to/from a String matching the constant name. This is the default if not set.


ORDINAL

public static final EnumTranslateStrategy ORDINAL
Translates to/from an integer matching the ordinal number of the constant within the enumeration


BEAN

public static final EnumTranslateStrategy BEAN
Translates to/from a Javascript object containing one property for each property defined within the enum. The constant itself and the ordinal number are included in the JS object. By default they are called "_constant" and "_ordinal", but this can be overridden with the DataSource.enumOrdinalProperty and DataSource.enumConstantProperty properties

Method Detail

values

public static EnumTranslateStrategy[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
for (EnumTranslateStrategy c : EnumTranslateStrategy.values())
    System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they are declared

valueOf

public static EnumTranslateStrategy valueOf(String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:
name - the name of the enum constant to be returned.
Returns:
the enum constant with the specified name
Throws:
IllegalArgumentException - if this enum type has no constant with the specified name
NullPointerException - if the argument is null

getValue

public String getValue()
Specified by:
getValue in interface ValueEnum