Enum EValueType
- java.lang.Object
-
- java.lang.Enum<EValueType>
-
- de.xima.fc.interfaces.workflow.value.EValueType
-
- All Implemented Interfaces:
INamedUiElement
,Serializable
,Comparable<EValueType>
public enum EValueType extends Enum<EValueType> implements INamedUiElement
Enumeration of different value types for a JSON like data structure.- Since:
- 7.0.0
- Author:
- XIMA MEDIA GmbH
-
-
Enum Constant Summary
Enum Constants Enum Constant Description ANY
The value may be of any type.BOOLEAN
The value must be a boolean, i.e.CONST
The value is a constant, such as3
or[1,2]
.FLOATING_POINT
The value must be a floating-point (64 bit) number (INTEGER
The value must be a (signed, 64 bit) integer.LIST
The value must be a list of items, such as a list of strings.MAP
The value must be a mapping from strings to items.NULL
The value must be absent, which is usually indicated bynull
orundefined
etc.RECORD
The value must be a mapping from a fixed, predefined set of keys to a certain value.STRING
The value must be a sequence of character, i.e. a string.TUPLE
The value must be a tuple of individual values, i.e. a list of fixed size where each item may have a different value type.UNION
The value must be one of a given set of otherEValueType
s.VOID
The value must be absent, which is usually indicated bynull
orundefined
etc.
-
Field Summary
-
Fields inherited from interface de.xima.fc.interfaces.INamedUiElement
ATTR_DISPLAY_NAME
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description String
getDisplayName(Locale locale)
String
getTechnicalName()
static EValueType
valueOf(String name)
Returns the enum constant of this type with the specified name.static EValueType[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
ANY
public static final EValueType ANY
The value may be of any type.
-
BOOLEAN
public static final EValueType BOOLEAN
The value must be a boolean, i.e.true
offalse
.
-
CONST
public static final EValueType CONST
The value is a constant, such as3
or[1,2]
. This is stronger than e.g. justINTEGER
, which allows any integer.
-
FLOATING_POINT
public static final EValueType FLOATING_POINT
The value must be a floating-point (64 bit) number (
-
INTEGER
public static final EValueType INTEGER
The value must be a (signed, 64 bit) integer.
-
LIST
public static final EValueType LIST
The value must be a list of items, such as a list of strings. The type of the items should be one of the availableEValueType
s. This value type allows list of arbitrary length, but requires each item to conform to a certain value type.- See Also:
TUPLE
-
MAP
public static final EValueType MAP
The value must be a mapping from strings to items. That is, the map key must always be of typeSTRING
. The type of the values should be one of the availableEValueType
s. This value type allows maps of arbitrary size, but required each value to conform to a certain value type.- See Also:
RECORD
-
NULL
public static final EValueType NULL
The value must be absent, which is usually indicated bynull
orundefined
etc.
-
RECORD
public static final EValueType RECORD
The value must be a mapping from a fixed, predefined set of keys to a certain value. The type of each value may be different for each key. Each key may be marked as optional, in which case no mapping must exist for that key.- See Also:
MAP
-
STRING
public static final EValueType STRING
The value must be a sequence of character, i.e. a string.
-
TUPLE
public static final EValueType TUPLE
The value must be a tuple of individual values, i.e. a list of fixed size where each item may have a different value type.- See Also:
LIST
-
UNION
public static final EValueType UNION
The value must be one of a given set of otherEValueType
s. For example, a value of typeUNION(STRING | INTEGER
) must be either be of typeSTRING
orINTEGER
.
-
VOID
public static final EValueType VOID
The value must be absent, which is usually indicated bynull
orundefined
etc.
-
-
Method Detail
-
values
public static EValueType[] 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 (EValueType c : EValueType.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static EValueType 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 nameNullPointerException
- if the argument is null
-
getDisplayName
public String getDisplayName(Locale locale)
- Specified by:
getDisplayName
in interfaceINamedUiElement
- Returns:
- Wert, der das entsprechende Objekt an Oberfläche repräsentiert (wird i.A. zur Laufzeit ermittelt).
-
getTechnicalName
public String getTechnicalName()
- Returns:
- The technical (non human-friendly or localized) name of this value type.
-
-