com.prosysopc.ua.stack.builtintypes

Class QualifiedName

java.lang.Object

com.prosysopc.ua.stack.builtintypes.QualifiedName

All Implemented Interfaces:

UaNamespaceTranslateable<QualifiedName>, Comparable<QualifiedName>

public final class QualifiedName
extends Object
implements Comparable<QualifiedName>, UaNamespaceTranslateable<QualifiedName>

A name qualified by a namespace.

Nested Class Summary

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

UaNamespaceTranslateable.Context

Field Summary

Fields

Modifier and Type	Field and Description
static QualifiedName	DEFAULT_BINARY_ENCODING
static QualifiedName	DEFAULT_XML_ENCODING
static QualifiedName	EMPTY
static QualifiedName[]	EMPTY_ARRAY
static NodeId	ID Deprecated. use Identifiers.QualifiedName instead.
static QualifiedName	NULL

Constructor Summary

Constructors

Constructor and Description
QualifiedName(int namespaceIndex, String name) Returns QualifiedName with the given namespaceindex and name.
QualifiedName(String name) Returns QualifiedName with NamespaceIndex of 0 and the given name.
QualifiedName(UnsignedShort namespaceIndex, String name) Returns QualifiedName with the given namespaceindex and name.

Method Summary

Modifier and Type	Method and Description
static QualifiedName[]	arrayFrom(UaQualifiedName[] qualifiedNames, NamespaceTable namespaceTable) Converts an array of UaQualifiedName to an array ofQualifiedName in the context of the given NamespaceTable.
int	compareTo(QualifiedName other)
boolean	equals(Object obj)
static QualifiedName	from(int namespaceIndex, String name) Returns QualifiedName with the given namespaceindex and name.
static QualifiedName	from(UaQualifiedName qualifiedName, NamespaceTable namespaceTable) Converts a UaQualifiedName to QualifiedName in the context of a NamespaceTable.
static QualifiedName	from(UnsignedShort namespaceIndex, String name) Returns QualifiedName with the given namespaceindex and name.
String	getName() Returns the Name part.
int	getNamespaceIndex() Returns the NamespaceIndex part.
int	hashCode()
static boolean	isNull(QualifiedName value) Returns true if the value is null.
static boolean	isNullOrEmpty(QualifiedName value) Return true if the value is null, or name part is empty string.
static QualifiedName	parseQualifiedName(String value) Parse the QualifiedName from a string.
String	toString()
QualifiedName	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

Field Detail

ID

@Deprecated
public static final NodeId ID

Deprecated. use Identifiers.QualifiedName instead.

The NodeId for the DataType node QualifiedName in the UA AddressSpace.

NULL

public static final QualifiedName NULL

DEFAULT_BINARY_ENCODING

public static final QualifiedName DEFAULT_BINARY_ENCODING

DEFAULT_XML_ENCODING

public static final QualifiedName DEFAULT_XML_ENCODING

EMPTY

public static final QualifiedName EMPTY

EMPTY_ARRAY

public static final QualifiedName[] EMPTY_ARRAY

Constructor Detail

QualifiedName

public QualifiedName(int namespaceIndex,
                     String name)

Returns QualifiedName with the given namespaceindex and name. Throws IllegalArgumentException, if the given NamespaceIndex is negative or larger than 65535.

QualifiedName

public QualifiedName(String name)

Returns QualifiedName with NamespaceIndex of 0 and the given name.

QualifiedName

public QualifiedName(UnsignedShort namespaceIndex,
                     String name)

Returns QualifiedName with the given namespaceindex and name. Throws IllegalArgumentException if the given namespaceIndex is null.

Method Detail

arrayFrom

public static QualifiedName[] arrayFrom(UaQualifiedName[] qualifiedNames,
                                        NamespaceTable namespaceTable)

Converts an array of UaQualifiedName to an array ofQualifiedName in the context of the given NamespaceTable. Returns null if given null array.

from

public static QualifiedName from(int namespaceIndex,
                                 String name)

Returns QualifiedName with the given namespaceindex and name. May return a cached instance. Throws IllegalArgumentException, if the given NamespaceIndex is negative or larger than 65535.

from

public static QualifiedName from(UaQualifiedName qualifiedName,
                                 NamespaceTable namespaceTable)

Converts a UaQualifiedName to QualifiedName in the context of a NamespaceTable. Returns null if given null. Throws IllegalArgumentException if given null NamespaceTable.

from

public static QualifiedName from(UnsignedShort namespaceIndex,
                                 String name)

Returns QualifiedName with the given namespaceindex and name. May return a cached instance. Throws IllegalArgumentException if the given namespaceIndex is null.

isNull

public static boolean isNull(QualifiedName value)

Returns true if the value is null.

Parameters:

value - the qualified name

Returns:

true if value is null or equal to NULL

isNullOrEmpty

public static boolean isNullOrEmpty(QualifiedName value)

Return true if the value is null, or name part is empty string.

Parameters:

value - the qualified name

Returns:

true if isNull(value) is true or the name part is empty string

parseQualifiedName

public static QualifiedName parseQualifiedName(String value)

Parse the QualifiedName from a string.

The string is supposed to be in format "[NamespaceIndex]:[Name]" or just "[Name]" (if the NamespaceIndex is 0)

Parameters:

value - the string

Returns:

the new QualifiedName

compareTo

public int compareTo(QualifiedName other)

Specified by:

compareTo in interface Comparable<QualifiedName>

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getName

public String getName()

Returns the Name part.

getNamespaceIndex

public int getNamespaceIndex()

Returns the NamespaceIndex part.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

withTranslatedNamespaces

public QualifiedName 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<QualifiedName>