Module org.eclipse.milo.opcua.stack.core

Package org.eclipse.milo.opcua.stack.core.types.enumerated

Enum Class NamingRuleType

java.lang.Object

java.lang.Enum<NamingRuleType>

org.eclipse.milo.opcua.stack.core.types.enumerated.NamingRuleType

All Implemented Interfaces:

Serializable, Comparable<NamingRuleType>, Constable, UaDataType, UaEnumeratedType

public enum NamingRuleType
extends Enum<NamingRuleType>
implements UaEnumeratedType

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	NamingRuleType.TypeInfo

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

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
Constraint	The modelling rule defines a constraint and the BrowseName is not used in an instance of the type.
Mandatory	The BrowseName must appear in all instances of the type.
Optional	The BrowseName may appear in an instance of the type.

Method Summary

Modifier and Type	Method	Description
static EnumDefinition	definition()
static @Nullable NamingRuleType	from(int value)
ExpandedNodeId	getTypeId()	Get the ExpandedNodeId identifying this DataType.
int	getValue()	Get the numeric value associated with this enumerated value.
static NamingRuleType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static NamingRuleType[]	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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.eclipse.milo.opcua.stack.core.types.UaDataType

getTypeName

Methods inherited from interface org.eclipse.milo.opcua.stack.core.types.UaEnumeratedType

getName

Enum Constant Details

Mandatory

public static final NamingRuleType Mandatory

The BrowseName must appear in all instances of the type.

Optional

public static final NamingRuleType Optional

The BrowseName may appear in an instance of the type.

Constraint

public static final NamingRuleType Constraint

The modelling rule defines a constraint and the BrowseName is not used in an instance of the type.

Method Details

values

public static NamingRuleType[] 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 NamingRuleType 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

getValue

public int getValue()

Description copied from interface: UaEnumeratedType

Get the numeric value associated with this enumerated value.

Specified by:

getValue in interface UaEnumeratedType

Returns:

the numeric value associated with this enumerated value.

getTypeId

public ExpandedNodeId getTypeId()

Description copied from interface: UaDataType

Get the ExpandedNodeId identifying this DataType.

Specified by:

getTypeId in interface UaDataType

Returns:

the ExpandedNodeId identifying this DataType.

from

public static @Nullable NamingRuleType from(int value)

definition

public static EnumDefinition definition()