com.prosysopc.ua.typedictionary

Class EnumerationSpecification.Builder

java.lang.Object

com.prosysopc.ua.typedictionary.EnumerationSpecification.Builder

Enclosing class:

EnumerationSpecification

public static class EnumerationSpecification.Builder
extends Object

Builder for EnumerationSpecification.

Method Summary

Modifier and Type	Method and Description
EnumerationSpecification.Builder	addMapping(int intValue, String stringValue) Add new enum value.
EnumerationSpecification.Builder	addMapping(int intValue, String stringValue, LocalizedText description) Add new enum value.
EnumerationSpecification	build() Builds EnumerationSpecification instance based on the given parameters.
EnumerationSpecification.Builder	setBuilderSupplier(EnumerationSpecification.EnumerationBuilderSupplier supplier) Set supplier used in EnumerationSpecification.toEnumerationBuilder().
EnumerationSpecification.Builder	setJavaClass(Class<? extends Enumeration> javaClass) Sets the java class of returned objects.
EnumerationSpecification.Builder	setMappings(Map<Integer,String> intToStringEnumerationData) Set all mappings at once.
EnumerationSpecification.Builder	setName(String name) Set the name of the Enumeration.
EnumerationSpecification.Builder	setTypeId(UaNodeId typeId) Set the typeId of the Enumeration.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

addMapping

public EnumerationSpecification.Builder addMapping(int intValue,
                                                   String stringValue)

Add new enum value. Note that both the given int and String values must be unique for the Enumeration. LocalizedText.EMPTY is used for the description of the enum value.

addMapping

public EnumerationSpecification.Builder addMapping(int intValue,
                                                   String stringValue,
                                                   LocalizedText description)

Add new enum value. Note that both the given int and String values must be unique for the Enumeration. A description can be optionally given (LocalizedText.EMPTY is used if given null).

build

public EnumerationSpecification build()

Builds EnumerationSpecification instance based on the given parameters. This method may return a cached instance.

setBuilderSupplier

public EnumerationSpecification.Builder setBuilderSupplier(EnumerationSpecification.EnumerationBuilderSupplier supplier)

Set supplier used in EnumerationSpecification.toEnumerationBuilder(). If set to null (default) that method will provide DynamicEnumeration.Builders.

setJavaClass

public EnumerationSpecification.Builder setJavaClass(Class<? extends Enumeration> javaClass)

Sets the java class of returned objects. If null, DynamicEnumeration is used.

setMappings

public EnumerationSpecification.Builder setMappings(Map<Integer,String> intToStringEnumerationData)

Set all mappings at once.

setName

public EnumerationSpecification.Builder setName(String name)

Set the name of the Enumeration. This should match the BrowseName Attribute name part of the DataType node defining the Enumeration.

setTypeId

public EnumerationSpecification.Builder setTypeId(UaNodeId typeId)

Set the typeId of the Enumeration. This should match the NodeId Attribute of the DataType node defining the Enumeration.