org.eclipse.milo.opcua.stack.core.types.builtin

Class ExpandedNodeId

java.lang.Object

org.eclipse.milo.opcua.stack.core.types.builtin.ExpandedNodeId

public final class ExpandedNodeId
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ExpandedNodeId.Builder

Field Summary

Fields

Modifier and Type	Field and Description
static ExpandedNodeId	NULL_VALUE

Constructor Summary

Constructors

Constructor and Description
ExpandedNodeId(UShort namespaceIndex, String namespaceUri, ByteString identifier)
ExpandedNodeId(UShort namespaceIndex, String namespaceUri, ByteString identifier, UInteger serverIndex)
ExpandedNodeId(@NotNull UShort namespaceIndex, @Nullable String namespaceUri, @Nullable Object identifier, @NotNull UInteger serverIndex)
ExpandedNodeId(UShort namespaceIndex, String namespaceUri, String identifier)
ExpandedNodeId(UShort namespaceIndex, String namespaceUri, String identifier, UInteger serverIndex)
ExpandedNodeId(UShort namespaceIndex, String namespaceUri, UInteger identifier)
ExpandedNodeId(UShort namespaceIndex, String namespaceUri, UInteger identifier, UInteger serverIndex)
ExpandedNodeId(UShort namespaceIndex, String namespaceUri, UUID identifier)
ExpandedNodeId(UShort namespaceIndex, String namespaceUri, UUID identifier, UInteger serverIndex)

Method Summary

Modifier and Type	Method and Description
Optional<ExpandedNodeId>	absolute(NamespaceTable namespaceTable) Convert this ExpandedNodeId to an absolute ExpandedNodeId if not already.
boolean	equals(NodeId nodeId) Deprecated. use equalTo(NodeId) instead.
boolean	equals(NodeId nodeId, NamespaceTable namespaceTable) Deprecated. use equalTo(NodeId, NamespaceTable) instead.
boolean	equals(Object o)
boolean	equalTo(NodeId nodeId) Check if this ExpandedNodeId is equal to nodeId.
boolean	equalTo(NodeId nodeId, NamespaceTable namespaceTable) Check if this ExpandedNodeId is equal to nodeId.
Object	getIdentifier() Get the identifier object of this ExpandedNodeId.
UShort	getNamespaceIndex() Get the namespace index of this ExpandedNodeId.
@Nullable String	getNamespaceUri() Get the namespace URI of this ExpandedNodeId.
UInteger	getServerIndex() Get the server index of this ExpandedNodeId.
IdType	getType() Get the IdType of this ExpandedNodeId.
int	hashCode()
boolean	isAbsolute()
boolean	isLocal()
boolean	isNotNull()
boolean	isNull()
boolean	isRelative()
Optional<NodeId>	local(NamespaceTable namespaceTable) Deprecated. use toNodeId(NamespaceTable) instead.
NodeId	localOrThrow(NamespaceTable namespaceTable) Deprecated. use toNodeIdOrThrow(NamespaceTable) instead.
static ExpandedNodeId.Builder	newBuilder() Return a new ExpandedNodeId.Builder.
static ExpandedNodeId	parse(String s) Parse s into an ExpandedNodeId.
static @Nullable ExpandedNodeId	parseOrNull(@NotNull String s) Parse s into an ExpandedNodeId, or return null if parsing fails.
static Optional<ExpandedNodeId>	parseSafe(@NotNull String s) Parse s into an Optional containing an ExpandedNodeId, or return Optional.empty()} if parsing fails.
ExpandedNodeId	reindex(NamespaceTable namespaceTable, String namespaceUri) Re-index this ExpandedNodeId from its current namespace index to the index for namespaceUri in namespaceTable.
Optional<ExpandedNodeId>	relative(NamespaceTable namespaceTable) Convert this ExpandedNodeId to a relative ExpandedNodeId if not already.
Optional<NodeId>	toNodeId(NamespaceTable namespaceTable) If this ExpandedNodeId resides on the local server (serverIndex == 0), return its representation as a local NodeId.
NodeId	toNodeIdOrThrow(NamespaceTable namespaceTable) Like toNodeId(NamespaceTable), but throws if the node is not local or the namespace is not registered.
String	toParseableString()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

NULL_VALUE

public static final ExpandedNodeId NULL_VALUE

Constructor Detail

ExpandedNodeId

public ExpandedNodeId(UShort namespaceIndex,
                      String namespaceUri,
                      UInteger identifier)

ExpandedNodeId

public ExpandedNodeId(UShort namespaceIndex,
                      String namespaceUri,
                      UInteger identifier,
                      UInteger serverIndex)

ExpandedNodeId

public ExpandedNodeId(UShort namespaceIndex,
                      String namespaceUri,
                      String identifier)

ExpandedNodeId

public ExpandedNodeId(UShort namespaceIndex,
                      String namespaceUri,
                      String identifier,
                      UInteger serverIndex)

ExpandedNodeId

public ExpandedNodeId(UShort namespaceIndex,
                      String namespaceUri,
                      ByteString identifier)

ExpandedNodeId

public ExpandedNodeId(UShort namespaceIndex,
                      String namespaceUri,
                      ByteString identifier,
                      UInteger serverIndex)

ExpandedNodeId

public ExpandedNodeId(UShort namespaceIndex,
                      String namespaceUri,
                      UUID identifier)

ExpandedNodeId

public ExpandedNodeId(UShort namespaceIndex,
                      String namespaceUri,
                      UUID identifier,
                      UInteger serverIndex)

ExpandedNodeId

public ExpandedNodeId(@NotNull
                      @NotNull UShort namespaceIndex,
                      @Nullable
                      @Nullable String namespaceUri,
                      @Nullable
                      @Nullable Object identifier,
                      @NotNull
                      @NotNull UInteger serverIndex)

Method Detail

getIdentifier

public Object getIdentifier()

Get the identifier object of this ExpandedNodeId.

Returns:

the identifier object of this ExpandedNodeId.

getType

public IdType getType()

Get the IdType of this ExpandedNodeId.

Returns:

the IdType of this ExpandedNodeId.

getNamespaceIndex

public UShort getNamespaceIndex()

Get the namespace index of this ExpandedNodeId.

This value shall be ignored if getNamespaceUri() is non-null.

Returns:

the namespace index of this ExpandedNodeId.

getNamespaceUri

@Nullable
public @Nullable String getNamespaceUri()

Get the namespace URI of this ExpandedNodeId.

Returns:

the namespace URI of this ExpandedNodeId.

getServerIndex

public UInteger getServerIndex()

Get the server index of this ExpandedNodeId.

Returns:

the server index of this ExpandedNodeId.

isAbsolute

public boolean isAbsolute()

Returns:

true if this ExpandedNodeId is absolute, i.e. it specifies a namespace URI instead of a namespace index.

isRelative

public boolean isRelative()

Returns:

true if this ExpandedNodeId is relative, i.e. it specifies a namespace index instead of a namespace URI, and is therefore defined relative to some NamespaceTable.

isLocal

public boolean isLocal()

Returns:

true if this ExpandedNodeId is local (serverIndex == 0).

isNull

public boolean isNull()

Returns:

true if this ExpandedNodeId is null.

isNotNull

public boolean isNotNull()

absolute

public Optional<ExpandedNodeId> absolute(NamespaceTable namespaceTable)

Convert this ExpandedNodeId to an absolute ExpandedNodeId if not already.

An absolute ExpandedNodeId is one that defines the namespace URI rather than namespace index.

Returns Optional.empty() if the URI is not found in the namespace table.

Parameters:

namespaceTable - the NamespaceTable to use when converting the index to URI.

Returns:

an absolute ExpandedNodeId, or this ExpandedNodeId if it's already absolute.

See Also:

isAbsolute()

relative

public Optional<ExpandedNodeId> relative(NamespaceTable namespaceTable)

Convert this ExpandedNodeId to a relative ExpandedNodeId if not already.

A relative ExpandedNodeId is one that defines the namespace index rather than namespace URI.

Returns Optional.empty() if the URI is not found in the namespace table.

Parameters:

namespaceTable - the NamespaceTable to use when converting the URI to index.

Returns:

a relative ExpandedNodeId, or this ExpandedNodeId if it's already relative.

See Also:

isRelative()

reindex

public ExpandedNodeId reindex(NamespaceTable namespaceTable,
                              String namespaceUri)

Re-index this ExpandedNodeId from its current namespace index to the index for namespaceUri in namespaceTable.

If the target namespace URI is not present in the namespace table this ExpandedNodeId is returned.

Parameters:

namespaceTable - the NamespaceTable.

namespaceUri - the target namespace URI.

Returns:

a new NodeId in the namespace index indicated by namespaceUri.

local

@Deprecated
public Optional<NodeId> local(NamespaceTable namespaceTable)

Deprecated. use toNodeId(NamespaceTable) instead.

If this ExpandedNodeId resides on the local server (serverIndex == 0), return its representation as a local NodeId.

If this ExpandedNodeId specifies a namespace URI instead of a namespace index then the URI must exist in namespaceTable or Optional.empty() is returned.

Parameters:

namespaceTable - the NamespaceTable.

Returns:

a local NodeId, if serverIndex == 0 and the namespace index can be determined.

localOrThrow

@Deprecated
public NodeId localOrThrow(NamespaceTable namespaceTable)
                                throws Exception

Deprecated. use toNodeIdOrThrow(NamespaceTable) instead.

Like local(NamespaceTable), but throws if the node is not local or the namespace is not registered.

Parameters:

namespaceTable - the NamespaceTable.

Returns:

a local NodeId.

Throws:

Exception - if the node is not local or the namespace is not registered.

toNodeId

public Optional<NodeId> toNodeId(NamespaceTable namespaceTable)

If this ExpandedNodeId resides on the local server (serverIndex == 0), return its representation as a local NodeId.

If this ExpandedNodeId specifies a namespace URI instead of a namespace index then the URI must exist in namespaceTable or Optional.empty() is returned.

Parameters:

namespaceTable - the NamespaceTable.

Returns:

a local NodeId, if serverIndex == 0 and the namespace index can be determined.

toNodeIdOrThrow

public NodeId toNodeIdOrThrow(NamespaceTable namespaceTable)
                       throws Exception

Like toNodeId(NamespaceTable), but throws if the node is not local or the namespace is not registered.

Parameters:

namespaceTable - the NamespaceTable.

Returns:

a local NodeId.

Throws:

Exception - if the node is not local or the namespace is not registered.

equals

@Deprecated
public boolean equals(NodeId nodeId)

Deprecated. use equalTo(NodeId) instead.

Check if this ExpandedNodeId is equal to nodeId.

To be considered equal this ExpandedNodeId must be in serverIndex == 0, have the same namespace index as nodeId or have a namespace URI at the same index in the default namespace table, and an equal identifier.

Parameters:

nodeId - the NodeId to check equality against.

Returns:

true if this ExpandedNodeId is equal to nodeId.

equals

@Deprecated
public boolean equals(NodeId nodeId,
                                  NamespaceTable namespaceTable)

Deprecated. use equalTo(NodeId, NamespaceTable) instead.

Check if this ExpandedNodeId is equal to nodeId.

To be considered equal this ExpandedNodeId must be in serverIndex == 0, have the same namespace index as nodeId or have a namespace URI at the same index in the default namespace table, and an equal identifier.

Parameters:

nodeId - the NodeId to check equality against.

namespaceTable - the NamespaceTable used to look up the index of a namespace URI.

Returns:

true if this ExpandedNodeId is equal to nodeId.

equalTo

public boolean equalTo(NodeId nodeId)

Check if this ExpandedNodeId is equal to nodeId.

To be considered equal this ExpandedNodeId must be in serverIndex == 0, have the same namespace index as nodeId or have a namespace URI at the same index in the default namespace table, and an equal identifier.

Parameters:

nodeId - the NodeId to check equality against.

Returns:

true if this ExpandedNodeId is equal to nodeId.

equalTo

public boolean equalTo(NodeId nodeId,
                       NamespaceTable namespaceTable)

Check if this ExpandedNodeId is equal to nodeId.

To be considered equal this ExpandedNodeId must be in serverIndex == 0, have the same namespace index as nodeId or have a namespace URI at the same index in the default namespace table, and an equal identifier.

Parameters:

nodeId - the NodeId to check equality against.

namespaceTable - the NamespaceTable used to look up the index of a namespace URI.

Returns:

true if this ExpandedNodeId is equal to nodeId.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

toParseableString

public String toParseableString()

parse

public static ExpandedNodeId parse(String s)

Parse s into an ExpandedNodeId.

Parameters:

s - the String to parse.

Returns:

an ExpandedNodeId.

Throws:

UaRuntimeException - if parsing fails.

parseOrNull

@Nullable
public static @Nullable ExpandedNodeId parseOrNull(@NotNull
                                                             @NotNull String s)

Parse s into an ExpandedNodeId, or return null if parsing fails.

Parameters:

s - the String to parse.

Returns:

an ExpandedNodeId or null if parsing fails.

parseSafe

public static Optional<ExpandedNodeId> parseSafe(@NotNull
                                                 @NotNull String s)

Parse s into an Optional containing an ExpandedNodeId, or return Optional.empty()} if parsing fails.

Parameters:

s - the String to parse.

Returns:

an Optional containing an ExpandedNodeId, or Optional.empty() if parsing fails.

newBuilder

public static ExpandedNodeId.Builder newBuilder()

Return a new ExpandedNodeId.Builder.

Returns:

a new ExpandedNodeId.Builder.