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

java.lang.Object
- com.prosysopc.ua.UaNodeId

All Implemented Interfaces:

UaNamespaceTranslateable<UaNodeId>, Comparable<UaNodeId>
```
public class UaNodeId
extends Object
implements Comparable<UaNodeId>, UaNamespaceTranslateable<UaNodeId>
```
This class models an OPC UA NodeId or local ExpandedNodeId. It can be converted to both. Instances are created with the static factory methods. This class is considered to be sealed.

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static UaNodeId[]`	`arrayFromLocal(ExpandedNodeId[] nodeIds)` Converts an array of `ExpandedNodeId` to an array of`UaNodeId` in the context of the given `NamespaceTable` (effectively calling `fromLocal(ExpandedNodeId)` for each element).
`static UaNodeId[]`	`arrayFromLocal(ExpandedNodeId[] nodeIds, NamespaceTable namespaceTable)` Converts an array of `ExpandedNodeId` to an array of`UaNodeId` in the context of the given `NamespaceTable` (effectively calling `fromLocal(ExpandedNodeId, NamespaceTable)` for each element).
`static UaNodeId[]`	`arrayFromLocal(NodeId[] nodeIds, NamespaceTable namespaceTable)` Converts an array of `NodeId` to an array of`UaNodeId` in the context of the given `NamespaceTable` (effectively calling `fromLocal(NodeId, NamespaceTable)` for each element).
`ExpandedNodeId`	`asExpandedNodeId()` Converts this UaNodeId to `ExpandedNodeId`.
`ExpandedNodeId`	`asLocalExpandedNodeId()` Converts this UaNodeId to `ExpandedNodeId`.
`NodeId`	`asNodeId(NamespaceTable namespaceTable)` Converts this UaNodeId to `NodeId` in the context of a `NamespaceTable`.
`int`	`compareTo(UaNodeId other)`
`boolean`	`equals(Object obj)`
`static UaNodeId`	`from(String namespaceUri, Object value)` Creates new UaNodeId from NamespaceUri and a value.
`static UaNodeId`	`from(UaNamespace namespace, Object value)` Returns UaNodeId in the given `UaNamespace` with the given value.
`static UaNodeId`	`fromLocal(ExpandedNodeId expandedNodeId)` Converts a local `ExpandedNodeId` to UaNodeId.
`static UaNodeId`	`fromLocal(ExpandedNodeId expandedNodeId, NamespaceTable namespaceTable)` Converts a local `ExpandedNodeId` to UaNodeId.
`static UaNodeId`	`fromLocal(NodeId nodeId, NamespaceTable namespaceTable)` Converts a `NodeId` to UaNodeId in the context of a `NamespaceTable`.
`static UaNodeId`	`fromStandard(NodeId nodeId)` Converts a `NodeId` from the Standard Namespace (i.e.
`IdType`	`getIdType()`
`UaNamespace`	`getNamespace()`
`String`	`getNamespaceUri()`
`Object`	`getValue()`
`String`	`getValueAsParseForm()` Returns the value as String that can be parsed by `parse(String, String)`.
`static UaNodeId`	`guid(UaNamespace namespace, UUID value)` Convenience method for `from(UaNamespace, Object)`.
`int`	`hashCode()`
`static UaNodeId`	`numeric(UaNamespace namespace, long value)` Convenience method for `numeric(UaNamespace, UnsignedInteger)`, where the given value is given to `UnsignedInteger.valueOf(long)`.
`static UaNodeId`	`numeric(UaNamespace namespace, UnsignedInteger value)` Convenience method for `from(UaNamespace, Object)`.
`static UaNodeId`	`opaque(UaNamespace namespace, ByteString value)` Convenience method for `from(UaNamespace, Object)`.
`static UaNodeId`	`parse(String encodedUaNodeId)` Returns `UaNodeId` that matches the given encoded string that has been previously output by `toString()`.
`static UaNodeId`	`parse(String namespaceUri, String valueAsParseForm)` Creates new UaNodeId from NamespaceUri and a value.
`static UaNodeId`	`parse(UaNamespace namespace, String valueAsParseForm)` Creates new UaNodeId from namespace and a value.
`static UaNodeId`	`string(UaNamespace namespace, String value)` Convenience method for `from(UaNamespace, Object)`.
`String`	`toString()`
`UaNodeId`	`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
  - arrayFromLocal
```
public static UaNodeId[] arrayFromLocal(ExpandedNodeId[] nodeIds)
```
    Converts an array of ExpandedNodeId to an array ofUaNodeId in the context of the given NamespaceTable (effectively calling fromLocal(ExpandedNodeId) for each element). Returns null if given null array. Throws IllegalArgumentException if any individual element conversion fails.
  - arrayFromLocal
```
public static UaNodeId[] arrayFromLocal(ExpandedNodeId[] nodeIds,
                                        NamespaceTable namespaceTable)
```
    Converts an array of ExpandedNodeId to an array ofUaNodeId in the context of the given NamespaceTable (effectively calling fromLocal(ExpandedNodeId, NamespaceTable) for each element). Returns null if given null array. Throws IllegalArgumentException if any individual element conversion fails.
  - arrayFromLocal
```
public static UaNodeId[] arrayFromLocal(NodeId[] nodeIds,
                                        NamespaceTable namespaceTable)
```
    Converts an array of NodeId to an array ofUaNodeId in the context of the given NamespaceTable (effectively calling fromLocal(NodeId, NamespaceTable) for each element). Returns null if given null array. Throws IllegalArgumentException if any individual element conversion fails.
  - from
```
public static UaNodeId from(String namespaceUri,
                            Object value)
```
    Creates new UaNodeId from NamespaceUri and a value.
    
    Parameters:
    
    namespaceUri - The NamespaceUri for the Namespace (namespace part of the NodeId).
    
    value - The value part of the NodeId. Accepts same inputs as NodeId
    
    Returns:
    
    the new UaNodeId;
  - from
```
public static UaNodeId from(UaNamespace namespace,
                            Object value)
```
    Returns UaNodeId in the given UaNamespace with the given value.
  - fromLocal
```
public static UaNodeId fromLocal(ExpandedNodeId expandedNodeId)
```
    Converts a local ExpandedNodeId to UaNodeId. Returns null if given null. The ExpanededNodeId must have the namespace uri specified and ExpandedNodeId.isLocal() must be true, otherwise an IllegalArgumentException is thrown.
    
    Parameters:
    
    expandedNodeId - the ExpandedNodeId to convert.
    
    Returns:
    
    new UaNodeId
    
    Throws:
    
    IllegalArgumentException - if the given ExpandedNodeId does not have uri defined
  - fromLocal
```
public static UaNodeId fromLocal(ExpandedNodeId expandedNodeId,
                                 NamespaceTable namespaceTable)
```
    Converts a local ExpandedNodeId to UaNodeId. The ExpanededNodeId can have either the namespace uri or index specified. Returns null if given null. ExpandedNodeId.isLocal() must be true, otherwise an IllegalArgumentException is thrown.
    If the ExpandedNodeId has the namespace uri defined, it is used as-is. In case the uri is not defined, the index is seached from the given NamespaceTable and that uri is used. If not found, IllegalArgumentException is thrown.
    
    Parameters:
    
    expandedNodeId - the ExpandedNodeId to convert.
    
    namespaceTable - NamespaceTable used for conversion if namespaceindex defined.
    
    Returns:
    
    new UaNodeId
    
    Throws:
    
    IllegalArgumentException - if the given ExpandedNodeId does not have uri defined
  - fromLocal
```
public static UaNodeId fromLocal(NodeId nodeId,
                                 NamespaceTable namespaceTable)
```
    Converts a NodeId to UaNodeId in the context of a NamespaceTable. Returns null if given null.
    
    Parameters:
    
    nodeId - the NodeId to convert
    
    namespaceTable - a NamespaceTable
    
    Returns:
    
    new UaNodeId
  - fromStandard
```
public static UaNodeId fromStandard(NodeId nodeId)
```
    Converts a NodeId from the Standard Namespace (i.e. having NamespaceIndex of 0) to UaNodeId.
    
    Parameters:
    
    nodeId - NodeId, for which NodeId.getNamespaceIndex() equals 0.
    
    Returns:
    
    UaNodeId with the same value and the standard NamespaceUri 'http://opcfoundation.org/UA/'.
    
    Throws:
    
    IllegalArgumentException - if the given NodeId has any other NamespaceIndex than 0.
  - guid
```
public static UaNodeId guid(UaNamespace namespace,
                            UUID value)
```
    Convenience method for from(UaNamespace, Object).
  - numeric
```
public static UaNodeId numeric(UaNamespace namespace,
                               long value)
```
    Convenience method for numeric(UaNamespace, UnsignedInteger), where the given value is given to UnsignedInteger.valueOf(long).
  - numeric
```
public static UaNodeId numeric(UaNamespace namespace,
                               UnsignedInteger value)
```
    Convenience method for from(UaNamespace, Object).
  - opaque
```
public static UaNodeId opaque(UaNamespace namespace,
                              ByteString value)
```
    Convenience method for from(UaNamespace, Object).
  - parse
```
public static UaNodeId parse(String encodedUaNodeId)
```
    Returns UaNodeId that matches the given encoded string that has been previously output by toString(). The format is the same as ExpandedNodeId.parseExpandedNodeId(String), but only the namespaceuri version is supported and the server index shall not be defined.
  - parse
```
public static UaNodeId parse(String namespaceUri,
                             String valueAsParseForm)
```
    Creates new UaNodeId from NamespaceUri and a value. Parses value part from a String outputted by getValueAsParseForm().
  - parse
```
public static UaNodeId parse(UaNamespace namespace,
                             String valueAsParseForm)
```
    Creates new UaNodeId from namespace and a value. Parses value part from a String outputted by getValueAsParseForm().
  - string
```
public static UaNodeId string(UaNamespace namespace,
                              String value)
```
    Convenience method for from(UaNamespace, Object).
  - asExpandedNodeId
```
public ExpandedNodeId asExpandedNodeId()
```
    Converts this UaNodeId to ExpandedNodeId.
    
    Returns:
    
    new ExpandedNodeId with uri defined.
  - asLocalExpandedNodeId
```
public ExpandedNodeId asLocalExpandedNodeId()
```
    Converts this UaNodeId to ExpandedNodeId. The ExpandedNodeId has uri defined.
    
    Returns:
    
    new ExpandedNodeId with uri defined.
  - asNodeId
```
public NodeId asNodeId(NamespaceTable namespaceTable)
```
    Converts this UaNodeId to NodeId in the context of a NamespaceTable.
    
    Parameters:
    
    namespaceTable - a namespace table
    
    Returns:
    
    new NodeId
    
    Throws:
    
    IllegalArgumentException - if the serverUri is defined for this UaNodeId OR the given namespacetable does not contain mapping for the namespace uri of this UaNodeId
  - compareTo
```
public int compareTo(UaNodeId other)
```
    Specified by:
    
    compareTo in interface Comparable<UaNodeId>
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - getIdType
```
public IdType getIdType()
```
  - getNamespace
```
public UaNamespace getNamespace()
```
  - getNamespaceUri
```
public String getNamespaceUri()
```
  - getValue
```
public Object getValue()
```
  - getValueAsParseForm
```
public String getValueAsParseForm()
```
    Returns the value as String that can be parsed by parse(String, String).
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - withTranslatedNamespaces
```
public UaNodeId 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<UaNodeId>

Class UaNodeId

Nested Class Summary

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

Method Summary

Methods inherited from class java.lang.Object

Method Detail

arrayFromLocal

arrayFromLocal

arrayFromLocal

from

from

fromLocal

fromLocal

fromLocal

fromStandard

guid

numeric

numeric

opaque

parse

parse

parse

string

asExpandedNodeId

asLocalExpandedNodeId

asNodeId

compareTo

equals

getIdType

getNamespace

getNamespaceUri

getValue

getValueAsParseForm

hashCode

toString

withTranslatedNamespaces