Package org.palladiosimulator.pcm.parameter

Enum Class VariableCharacterisationType

java.lang.Object

java.lang.Enum<VariableCharacterisationType>

org.palladiosimulator.pcm.parameter.VariableCharacterisationType

All Implemented Interfaces:

Serializable, Comparable<VariableCharacterisationType>, Constable, Enumerator

public enum VariableCharacterisationType
extends Enum<VariableCharacterisationType>
implements Enumerator

A representation of the literals of the enumeration 'Variable Characterisation Type', and utility methods for working with them. The variable characterisation types determine the set of available meta-informations on variables. Possible values are STRUCTURE, NUMBER_OF_ELEMENTS, VALUE, BYTESIZE, and TYPE.

See Also:

• ParameterPackage.getVariableCharacterisationType()

Generated class or method.

EMF model class or method.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
BYTESIZE	The 'BYTESIZE' literal object.
NUMBER_OF_ELEMENTS	The 'NUMBER OF ELEMENTS' literal object.
STRUCTURE	The 'STRUCTURE' literal object.
TYPE	The 'TYPE' literal object.
VALUE	The 'VALUE' literal object.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	BYTESIZE_VALUE	The 'BYTESIZE' literal value.
static final String	copyright
static final int	NUMBER_OF_ELEMENTS_VALUE	The 'NUMBER OF ELEMENTS' literal value.
static final int	STRUCTURE_VALUE	The 'STRUCTURE' literal value.
static final int	TYPE_VALUE	The 'TYPE' literal value.
static final int	VALUE_VALUE	The 'VALUE' literal value.
static final List<VariableCharacterisationType>	VALUES	A public read-only list of all the 'Variable Characterisation Type' enumerators.

Method Summary

Modifier and Type	Method	Description
static VariableCharacterisationType	get(int value)	Returns the 'Variable Characterisation Type' literal with the specified integer value.
static VariableCharacterisationType	get(String literal)	Returns the 'Variable Characterisation Type' literal with the specified literal value.
static VariableCharacterisationType	getByName(String name)	Returns the 'Variable Characterisation Type' literal with the specified name.
String	getLiteral()
String	getName()
int	getValue()
String	toString()	Returns the literal value of the enumerator, which is its string representation.
static VariableCharacterisationType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static VariableCharacterisationType[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

STRUCTURE

public static final VariableCharacterisationType STRUCTURE

The 'STRUCTURE' literal object. The structure characterisation type is used to describe the structure of the data. With structure we refer to performance relevant properties of data like for example whether an array is sorted, a tree is balanced, a collection is indexed, and so on.... The allowed set of value of the structure characterisation has to be specified by the component developer for a particular component.

See Also:

• STRUCTURE_VALUE

Generated class or method.

Ordered collection.

NUMBER_OF_ELEMENTS

public static final VariableCharacterisationType NUMBER_OF_ELEMENTS

The 'NUMBER OF ELEMENTS' literal object. The number of elements of a collection data type describe the amount of data objects contained in the collection.

See Also:

• NUMBER_OF_ELEMENTS_VALUE

Generated class or method.

Ordered collection.

VALUE

public static final VariableCharacterisationType VALUE

The 'VALUE' literal object. The value characterisation can be used to specify the actual value of a parameter. It is only available for parameters having a primitive type. The value characterisation should be used with care as it increased the complexity of the resulting analysis model significantly. It should be only used in performance-critical cases.

See Also:

• VALUE_VALUE

Generated class or method.

Ordered collection.

BYTESIZE

public static final VariableCharacterisationType BYTESIZE

The 'BYTESIZE' literal object. The bytesize characterisation specifies the memory footprint of a data object.

See Also:

• BYTESIZE_VALUE

Generated class or method.

Ordered collection.

TYPE

public static final VariableCharacterisationType TYPE

The 'TYPE' literal object. The type characterisation specifies the actual data type of polymorphic data objects in cases where the actual type has an impact on performance. For example in a shape drawing application the actual shape of a geometric object has an impact on the performance as drawing a circle is much more time consuming than drawing a simple line.

See Also:

• TYPE_VALUE

Generated class or method.

Ordered collection.

Field Details

copyright

public static final String copyright

See Also:

• Constant Field Values

Generated class or method.

STRUCTURE_VALUE

public static final int STRUCTURE_VALUE

The 'STRUCTURE' literal value. The structure characterisation type is used to describe the structure of the data. With structure we refer to performance relevant properties of data like for example whether an array is sorted, a tree is balanced, a collection is indexed, and so on.... The allowed set of value of the structure characterisation has to be specified by the component developer for a particular component.

See Also:

• STRUCTURE
• Constant Field Values

Generated class or method.

EMF model class or method.

Ordered collection.

NUMBER_OF_ELEMENTS_VALUE

public static final int NUMBER_OF_ELEMENTS_VALUE

The 'NUMBER OF ELEMENTS' literal value. The number of elements of a collection data type describe the amount of data objects contained in the collection.

See Also:

• NUMBER_OF_ELEMENTS
• Constant Field Values

Generated class or method.

EMF model class or method.

Ordered collection.

VALUE_VALUE

public static final int VALUE_VALUE

The 'VALUE' literal value. The value characterisation can be used to specify the actual value of a parameter. It is only available for parameters having a primitive type. The value characterisation should be used with care as it increased the complexity of the resulting analysis model significantly. It should be only used in performance-critical cases.

See Also:

• VALUE
• Constant Field Values

Generated class or method.

EMF model class or method.

Ordered collection.

BYTESIZE_VALUE

public static final int BYTESIZE_VALUE

The 'BYTESIZE' literal value. The bytesize characterisation specifies the memory footprint of a data object.

See Also:

• BYTESIZE
• Constant Field Values

Generated class or method.

EMF model class or method.

Ordered collection.

TYPE_VALUE

public static final int TYPE_VALUE

The 'TYPE' literal value. The type characterisation specifies the actual data type of polymorphic data objects in cases where the actual type has an impact on performance. For example in a shape drawing application the actual shape of a geometric object has an impact on the performance as drawing a circle is much more time consuming than drawing a simple line.

See Also:

• TYPE
• Constant Field Values

Generated class or method.

EMF model class or method.

Ordered collection.

VALUES

public static final List<VariableCharacterisationType> VALUES

A public read-only list of all the 'Variable Characterisation Type' enumerators.

Generated class or method.

Method Details

values

public static VariableCharacterisationType[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static VariableCharacterisationType valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

get

public static VariableCharacterisationType get(String literal)

Returns the 'Variable Characterisation Type' literal with the specified literal value.

Parameters:

literal - the literal.

Returns:

the matching enumerator or null.

Generated class or method.

getByName

public static VariableCharacterisationType getByName(String name)

Returns the 'Variable Characterisation Type' literal with the specified name.

Parameters:

name - the name.

Returns:

the matching enumerator or null.

Generated class or method.

get

public static VariableCharacterisationType get(int value)

Returns the 'Variable Characterisation Type' literal with the specified integer value.

Parameters:

value - the integer value.

Returns:

the matching enumerator or null.

Generated class or method.

getValue

public int getValue()

Specified by:

getValue in interface Enumerator

Generated class or method.

getName

public String getName()

Specified by:

getName in interface Enumerator

Generated class or method.

getLiteral

public String getLiteral()

Specified by:

getLiteral in interface Enumerator

Generated class or method.

toString

public String toString()

Returns the literal value of the enumerator, which is its string representation.

Overrides:

toString in class Enum<VariableCharacterisationType>

Generated class or method.