Enum Class TdbFieldGroupType
- All Implemented Interfaces:
Serializable
,Comparable<TdbFieldGroupType>
,Constable
An enumeration of the possible field group types.
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionStructural field group.Field group that defines a tuple structure. -
Method Summary
Modifier and TypeMethodDescriptiongetName()
Return the TRIPxpi protocol name for the current field group type identifierstatic TdbFieldGroupType
Retrieve the field group type ID that matches the provided namestatic TdbFieldGroupType
Returns the enum constant of this class with the specified name.static TdbFieldGroupType[]
values()
Returns an array containing the constants of this enum class, in the order they are declared.Methods inherited from class java.lang.Enum
compareTo, describeConstable, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
-
Enum Constant Details
-
Structural
Structural field group. Used for searching and to inform applications and users about related fields. -
Tuple
Field group that defines a tuple structure. In addition to the behaviors of strucural field groups, tuple field groups inform the TRIP kernel that the fields in the group are tupled and so must have the same number of subfields.
-
-
Method Details
-
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
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 nameNullPointerException
- if the argument is null
-
getTypeof
Retrieve the field group type ID that matches the provided name- Parameters:
name
- The name to match- Returns:
- The type ID
-
getName
Return the TRIPxpi protocol name for the current field group type identifier- Returns:
- The name
-