no.g9.domain

Interface G9Enums

public interface G9Enums

Methods for converting between enum value and enum text for domain classes inheriting from G9Enumerator. You may also retrieve a list of all enum values for a given enumerator.

Field Summary

Fields

Modifier and Type	Field and Description
static int	NO_VALUE The no value constant

Method Summary

Modifier and Type	Method and Description
List<G9Enumerator>	allEnums(String enumName) Returns the list of all enumeration values for a given enumeration.
void	enumAssign(Object owner, String attribute, Object enumObject) Assigns value to enum based on in object owner.
String	toName(String name, int value) Converts the enumeration value to its title for the enumeration from the class name.
int	toValue(String name, String title) Returns the int value for the enumeration from class 'name', with a given title.

Field Detail

NO_VALUE

static final int NO_VALUE

The no value constant

See Also:

Constant Field Values

Method Detail

toValue

int toValue(String name,
            String title)

Returns the int value for the enumeration from class 'name', with a given title. Used in autogenerated code - in your code, please use the function toValue.

Parameters:

name - The name of the enumeration.

title - The title of the enum to convert as defined in Rose.

Returns:

The int value (currentValue) of the enumerator.

toName

String toName(String name,
              int value)

Converts the enumeration value to its title for the enumeration from the class name. Used in autogenerated code - in your code, please use the function toName.

Parameters:

name - The name of the enumeration.

value - The currentValue of the enumeration.

Returns:

The title, as defined in Rose.

enumAssign

void enumAssign(Object owner,
                String attribute,
                Object enumObject)

Assigns value to enum based on in object owner.

Parameters:

owner - The object to set.

attribute - The attribute to set value for.

enumObject - The enum object to set.

allEnums

List<G9Enumerator> allEnums(String enumName)

Returns the list of all enumeration values for a given enumeration.

Parameters:

enumName - The name of the enumeration (class)

Returns:

List of g9 enumeration objects with currentValue set.