EnumerationSpecification (prosys-opc-ua-sdk-client-server-pubsub 5.6.2-227 API)

java.lang.Object
- com.prosysopc.ua.typedictionary.EnumerationSpecification

All Implemented Interfaces:

UaDataTypeSpecification, UaNamespaceTranslateable<UaDataTypeSpecification>
```
public class EnumerationSpecification
extends Object
implements UaDataTypeSpecification
```
Definition of an OPC UA Enumeration. This class is used when parsing custom Structures from a TypeDictionary that have custom Enumerations defined as their fields.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`EnumerationSpecification.Builder` Builder for `EnumerationSpecification`.
`static interface`	`EnumerationSpecification.EnumerationBuilderSupplier` Helper supplier interface.

Nested classes/interfaces inherited from interface com.prosysopc.ua.UaNamespaceTranslateable
UaNamespaceTranslateable.Context

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static EnumerationSpecification.Builder`	`builder()`
`DynamicEnumeration`	`createEnumerationFromInteger(int value)` Deprecated. this method works only for non-code-generated Enumerations, use `getByValue(Integer)` instead.
`DynamicEnumeration`	`createEnumerationFromString(String value)` Deprecated. this method works only for non-code-generated Enumerations, use `getByName(String)` instead.
`boolean`	`equals(Object obj)`
`SortedSet<Enumeration>`	`getAllEnumValues()` Returns all Enumeration values, order is based on `Enumeration.getValue()`.
`Set<Integer>`	`getAllIntegerValues()` Returns all values of the Enumeration as integers.
`Set<String>`	`getAllStringValues()` Returns all values of the Enumeration as Strings.
`Enumeration`	`getByName(String enumName)` Returns the `Enumeration` of this specification that matches the given name or null if there is no match.
`Enumeration`	`getByValue(Integer enumValue)` Returns the `Enumeration` of this specification that matches the given value or null if there is no match.
`LocalizedText`	`getDescriptionByValue(Integer enumValue)` Returns description of the `Enumeration` value, if one is available.
`Map<Integer,String>`	`getIntToStringMappings()` Returns a map for Enumeration integer value to String mapping.
`Class<? extends Enumeration>`	`getJavaClass()` Returns the java `Class` of the enumeration instances.
`String`	`getName()` Returns the name of the Enumeration.
`Map<String,Integer>`	`getStringToIntMappings()` Returns a map for Enumeration String value to int mapping.
`UaNodeId`	`getTypeId()` Returns the DataType node NodeId that defines the `Enumeration`.
`String`	`getXmlName()` Internal.
`int`	`hashCode()`
`boolean`	`isAbstract()` Returns true if the type is known to be abstract, false otherwise.
`EnumerationSpecification.Builder`	`toBuilder()` Returns a Builder with data of this instance pre-set.
`DataTypeDefinition`	`toDataTypeDefinition(NamespaceTable namespaceTable)` Returns data of this `UaDataTypeSpecification` as a `DataTypeDefinition`.
`Enumeration.Builder`	`toEnumerationBuilder()` Creates a `Enumeration.Builder` implementation that creates `Enumeration`s that match this specification.
`String`	`toString()`
`EnumerationSpecification`	`withTranslatedNamespaces(UaNamespaceTranslateable.Context context)` Returns a deep copy of itself where all where every namespace index and uri plus server index and uri (see `ExpandedNodeId`, `UaExpandedNodeId`) has been swapped based on the given `UaNamespaceTranslateable.Context`.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Method Detail
  - builder
```
public static EnumerationSpecification.Builder builder()
```
  - createEnumerationFromInteger
```
@Deprecated
public DynamicEnumeration createEnumerationFromInteger(int value)
```
    Deprecated. this method works only for non-code-generated Enumerations, use getByValue(Integer) instead.
    
    Creates a DynamicEnumeration based on the given value in the context of this Enumeration.
    
    Parameters:
    
    value - the Enumeration value as integer
    
    Returns:
    
    DynamicEnumeration that has the given value and matching String representation of the value.
    
    Throws:
    
    IllegalArgumentException - if this enumeration specification does not have mapping defined for the given value, i.e. the given value is not part of the valid values for this Enumeration.
  - createEnumerationFromString
```
@Deprecated
public DynamicEnumeration createEnumerationFromString(String value)
```
    Deprecated. this method works only for non-code-generated Enumerations, use getByName(String) instead.
    
    Creates a DynamicEnumeration based on the given value in the context of this Enumeration.
    
    Parameters:
    
    value - the Enumeration value as String
    
    Returns:
    
    DynamicEnumeration that has the given value and matching Integer representation of the value.
    
    Throws:
    
    IllegalArgumentException - if this enumeration specification does not have mapping defined for the given value, i.e. the given value is not part of the valid values for this Enumeration.
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - getAllEnumValues
```
public SortedSet<Enumeration> getAllEnumValues()
```
    Returns all Enumeration values, order is based on Enumeration.getValue(). The returned set is unmodifiable.
  - getAllIntegerValues
```
public Set<Integer> getAllIntegerValues()
```
    Returns all values of the Enumeration as integers. The returned set is unmodifiable.
  - getAllStringValues
```
public Set<String> getAllStringValues()
```
    Returns all values of the Enumeration as Strings. The returned set is unmodifiable.
  - getByName
```
public Enumeration getByName(String enumName)
```
    Returns the Enumeration of this specification that matches the given name or null if there is no match. Returns null if given null.
  - getByValue
```
public Enumeration getByValue(Integer enumValue)
```
    Returns the Enumeration of this specification that matches the given value or null if there is no match. Returns null if given null.
  - getDescriptionByValue
```
public LocalizedText getDescriptionByValue(Integer enumValue)
```
    Returns description of the Enumeration value, if one is available. Returns LocalizedText.EMPTY if given null or there is no description.
  - getIntToStringMappings
```
public Map<Integer,String> getIntToStringMappings()
```
    Returns a map for Enumeration integer value to String mapping. The returned map is unmodifiable.
  - getJavaClass
```
public Class<? extends Enumeration> getJavaClass()
```
    Returns the java Class of the enumeration instances. This is either a generated class via Codegen or DynamicEnumeration.
    
    Specified by:
    
    getJavaClass in interface UaDataTypeSpecification
  - getName
```
public String getName()
```
    Returns the name of the Enumeration.
    
    Specified by:
    
    getName in interface UaDataTypeSpecification
  - getStringToIntMappings
```
public Map<String,Integer> getStringToIntMappings()
```
    Returns a map for Enumeration String value to int mapping. The returned map is unmodifiable.
  - getTypeId
```
public UaNodeId getTypeId()
```
    Returns the DataType node NodeId that defines the Enumeration.
    
    Specified by:
    
    getTypeId in interface UaDataTypeSpecification
  - getXmlName
```
public String getXmlName()
```
    Description copied from interface: UaDataTypeSpecification
    
    Internal. Application code shouldn't use this, but SDK may use this instead of UaDataTypeSpecification.getName() if more context is available, such as symbolic names in NodeSet documents. Returns same as UaDataTypeSpecification.getName() if there no such context.
    
    Specified by:
    
    getXmlName in interface UaDataTypeSpecification
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - isAbstract
```
public boolean isAbstract()
```
    Description copied from interface: UaDataTypeSpecification
    
    Returns true if the type is known to be abstract, false otherwise.
    Note that if the UaDataTypeSpecification has been formed outside of client-server communication or a NodeSet, it might not be possible to determine this information, in which case this method returns false.
    
    Specified by:
    
    isAbstract in interface UaDataTypeSpecification
  - toBuilder
```
public EnumerationSpecification.Builder toBuilder()
```
    Returns a Builder with data of this instance pre-set.
  - toDataTypeDefinition
```
public DataTypeDefinition toDataTypeDefinition(NamespaceTable namespaceTable)
```
    Description copied from interface: UaDataTypeSpecification
    
    Returns data of this UaDataTypeSpecification as a DataTypeDefinition. This method is mostly intended for SDK's internal use for the DataTypeDefinition Attribute's value for UaDataType nodes, but may be useful in some complicated aggregation servers.
    Note that not all UaDataTypeSpecifications can be converted to a DataTypeDefinition (such as SimpleTypeSpecification), in which case this method returns null. Enumeration and OptionSet-types (including 'OptionSet'-Structure subtypes, but not the base 'OptionSet' Structure type) use EnumDefinition. Structures use StructureDefinition.
    
    Specified by:
    
    toDataTypeDefinition in interface UaDataTypeSpecification
    
    Parameters:
    
    namespaceTable - a NamespaceTable.
    
    Returns:
    
    DataTypeDefinition based of the data of this StructureSpecification or null in the case of SimpleTypeSpecification.
  - toEnumerationBuilder
```
public Enumeration.Builder toEnumerationBuilder()
```
    Creates a Enumeration.Builder implementation that creates Enumerations that match this specification. By default returns DynamicEnumeration.Builder unless more specific supplier was given in the Builder of this EnumerationSpecification.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - withTranslatedNamespaces
```
public EnumerationSpecification withTranslatedNamespaces(UaNamespaceTranslateable.Context context)
```
    Description copied from interface: UaNamespaceTranslateable
    
    Returns a deep copy of itself where all where every namespace index and uri plus server index and uri (see ExpandedNodeId, UaExpandedNodeId) has been swapped based on the given UaNamespaceTranslateable.Context. Returning the same object is allowed if the type is immutable and the result is equal to this. Note that for Structure types if the UaDataTypeSpecification translation is active the returned type can be of different java class.
    
    Specified by:
    
    withTranslatedNamespaces in interface UaNamespaceTranslateable<UaDataTypeSpecification>

Class EnumerationSpecification

Nested Class Summary

Nested classes/interfaces inherited from interface com.prosysopc.ua.UaNamespaceTranslateable

Method Summary

Methods inherited from class java.lang.Object

Method Detail

builder

createEnumerationFromInteger

createEnumerationFromString

equals

getAllEnumValues

getAllIntegerValues

getAllStringValues

getByName

getByValue

getDescriptionByValue

getIntToStringMappings

getJavaClass

getName

getStringToIntMappings

getTypeId

getXmlName

hashCode

isAbstract

toBuilder

toDataTypeDefinition

toEnumerationBuilder

toString

withTranslatedNamespaces