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

java.lang.Object
- com.prosysopc.ua.stack.builtintypes.NodeId

All Implemented Interfaces:

UaNamespaceTranslateable<NodeId>, Comparable<NodeId>
```
public final class NodeId
extends Object
implements Comparable<NodeId>, UaNamespaceTranslateable<NodeId>
```
An identifier of a node in the address space of an OPC UA server.

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 NodeId[]`	`EMPTY_ARRAY`
`static NodeId`	`ID` Deprecated. use `Identifiers.NodeId` instead.
`static NodeId`	`NULL` `NodeId` null value that can be used when the `NodeId` `IdType` is not defined.
`static NodeId`	`NULL_GUID` `IdType.Guid` `NodeId` that is considered as null value.
`static NodeId`	`NULL_NUMERIC` `IdType.Numeric` `NodeId` that is considered as null value.
`static NodeId`	`NULL_OPAQUE` `IdType.Opaque` `NodeId` that is considered as null value.
`static NodeId`	`NULL_STRING` `IdType.String` `NodeId` that is considered as null value.
`static NodeId`	`ZERO` Deprecated. use `NULL_NUMERIC` instead.

Constructor Summary

Constructors
Constructor and Description
`NodeId(int namespaceIndex, byte[] value)` Create new NodeId from byte[].
`NodeId(int namespaceIndex, ByteString value)` Create new Opaque NodeId from ByteString.
`NodeId(int namespaceIndex, int value)` Create new NodeId.
`NodeId(int namespaceIndex, String value)` Create new NodeId.
`NodeId(int namespaceIndex, UnsignedInteger value)` Create new NodeId.
`NodeId(int namespaceIndex, UUID value)` Create new NodeId.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static NodeId[]`	`arrayFrom(UaNodeId[] nodeIds, NamespaceTable namespaceTable)` Converts an array of `UaNodeId` to an array of`NodeId` in the context of the given `NamespaceTable` (effectively calling `from(UaNodeId, NamespaceTable)` for each element).
`int`	`compareTo(NodeId other)`
`static NodeId`	`decode(String nodeIdRef)` Deprecated. Use parseNodeId() instead (renamed for method name consistency with other similar classes)
`boolean`	`equals(ExpandedNodeId obj)` Deprecated. use `NamespaceTable.nodeIdEquals(NodeId, ExpandedNodeId)` instead.
`static boolean`	`equals(NodeId left, NodeId right)` Deprecated. use `Objects.equals(Object, Object)` instead.
`boolean`	`equals(Object obj)`
`static NodeId`	`from(UaNodeId nodeId, NamespaceTable namespaceTable)` Converts a `UaNodeId` to NodeId in the context of a `NamespaceTable`.
`static NodeId`	`get(IdType type, int namespaceIndex, Object value)` Constructs a NodeId per the given type.
`IdType`	`getIdType()`
`int`	`getNamespaceIndex()`
`Object`	`getValue()` Returns the value par of the NodeId, is UnsignedInteger, UUID, String, ByteString, or null.
`int`	`hashCode()`
`static boolean`	`isNull(NodeId nodeId)` Check if nodeId is null or a NullNodeId.
`boolean`	`isNullNodeId()` Whether the object represents a Null NodeId.
`static NodeId`	`parseNodeId(String nodeIdRef)` Convert String representation to NodeId.
`static NodeId`	`randomGUID(int namespaceIndex)` Create a new random NodeId.
`String`	`toString()`
`NodeId`	`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
  - ZERO
```
@Deprecated
public static final NodeId ZERO
```
    Deprecated. use NULL_NUMERIC instead.
    
    This is deprecated.
  - NULL_NUMERIC
```
public static final NodeId NULL_NUMERIC
```
    IdType.Numeric NodeId that is considered as null value.
  - NULL_STRING
```
public static final NodeId NULL_STRING
```
    IdType.String NodeId that is considered as null value.
  - NULL_GUID
```
public static final NodeId NULL_GUID
```
    IdType.Guid NodeId that is considered as null value.
  - NULL_OPAQUE
```
public static final NodeId NULL_OPAQUE
```
    IdType.Opaque NodeId that is considered as null value.
  - NULL
```
public static final NodeId NULL
```
    NodeId null value that can be used when the NodeId IdType is not defined. This is equal to NULL_NUMERIC.
  - ID
```
@Deprecated
public static final NodeId ID
```
    Deprecated. use Identifiers.NodeId instead.
    
    Identifier of the DataType 'NodeId' in the UA AddressSpace.
  - EMPTY_ARRAY
```
public static final NodeId[] EMPTY_ARRAY
```
- Constructor Detail
  - NodeId
```
public NodeId(int namespaceIndex,
              byte[] value)
```
    Create new NodeId from byte[]. It is converted to ByteString.
    
    Parameters:
    
    namespaceIndex - 0..65535
    
    value - byte[] or null
  - NodeId
```
public NodeId(int namespaceIndex,
              ByteString value)
```
    Create new Opaque NodeId from ByteString.
    
    Parameters:
    
    namespaceIndex - namespaceIndex 0..65535
    
    value - ByteString, max length 4096 bytes
  - NodeId
```
public NodeId(int namespaceIndex,
              int value)
```
    Create new NodeId.
    
    Parameters:
    
    namespaceIndex - 0..65535
    
    value - the value should be a positive integer, as it is converted to an UnsignedInteger
  - NodeId
```
public NodeId(int namespaceIndex,
              String value)
```
    Create new NodeId.
    
    Parameters:
    
    namespaceIndex - 0..65535
    
    value - String or null
  - NodeId
```
public NodeId(int namespaceIndex,
              UnsignedInteger value)
```
    Create new NodeId.
    
    Parameters:
    
    namespaceIndex - 0..65535
    
    value - UnsignedInteger
  - NodeId
```
public NodeId(int namespaceIndex,
              UUID value)
```
    Create new NodeId.
    
    Parameters:
    
    namespaceIndex - 0..65535
    
    value - GUID value
- Method Detail
  - arrayFrom
```
public static NodeId[] arrayFrom(UaNodeId[] nodeIds,
                                 NamespaceTable namespaceTable)
```
    Converts an array of UaNodeId to an array ofNodeId in the context of the given NamespaceTable (effectively calling from(UaNodeId, NamespaceTable) for each element). Returns null if given null array. Throws IllegalArgumentException if any individual element conversion fails.
  - decode
```
@Deprecated
public static NodeId decode(String nodeIdRef)
                                  throws IllegalArgumentException
```
    Deprecated. Use parseNodeId() instead (renamed for method name consistency with other similar classes)
    
    Convert String representation to NodeId.
    The String representation is in the following notations: ns=[id];i=[number] i=[number]
    ns=[id];s=[string] s=[string]
    ns=[id];g=[guid] g=[guid]
    ns=[id];b=[base64] b=[base64]
    
    Parameters:
    
    nodeIdRef - string
    
    Returns:
    
    nodeid
    
    Throws:
    
    IllegalArgumentException - on error
  - equals
```
@Deprecated
public static boolean equals(NodeId left,
                                          NodeId right)
```
    Deprecated. use Objects.equals(Object, Object) instead.
    
    Compares 2 NodeIds.
  - from
```
public static NodeId from(UaNodeId nodeId,
                          NamespaceTable namespaceTable)
```
    Converts a UaNodeId to NodeId in the context of a NamespaceTable. Returns null if given null. Throws IllegalArgumentException if the given NamespaceTable doesn't contain the namespace uri of the given UaNodeId.getNamespaceUri().
  - get
```
public static NodeId get(IdType type,
                         int namespaceIndex,
                         Object value)
```
    Constructs a NodeId per the given type.
  - isNull
```
public static boolean isNull(NodeId nodeId)
```
    Check if nodeId is null or a NullNodeId.
    
    Parameters:
    
    nodeId - the nodeId
    
    Returns:
    
    true if (nodeId == null) || nodeId.isNullNodeId()
  - parseNodeId
```
public static NodeId parseNodeId(String nodeIdRef)
                          throws IllegalArgumentException
```
    Convert String representation to NodeId.
    The String representation is in the following notations: ns=[id];i=[number] i=[number]
    ns=[id];s=[string] s=[string]
    ns=[id];g=[guid] g=[guid]
    ns=[id];b=[base64] b=[base64]
    
    Parameters:
    
    nodeIdRef - string format of node id
    
    Returns:
    
    nodeid
    
    Throws:
    
    IllegalArgumentException - if string notation is not correct
  - randomGUID
```
public static NodeId randomGUID(int namespaceIndex)
```
    Create a new random NodeId. Because GUID values are always unique, this method also always returns a unique NodeId.
    
    Parameters:
    
    namespaceIndex - namespace index
    
    Returns:
    
    a new NodeId initialized with a random GUID.
  - compareTo
```
public int compareTo(NodeId other)
```
    Specified by:
    
    compareTo in interface Comparable<NodeId>
  - equals
```
@Deprecated
public boolean equals(ExpandedNodeId obj)
```
    Deprecated. use NamespaceTable.nodeIdEquals(NodeId, ExpandedNodeId) instead.
    
    Do not use this method, instead use NamespaceTable.nodeIdEquals(NodeId, ExpandedNodeId) when you wish to compare NodeId with ExpandedNodeId. For historical reasons equals(Object) in some scenarios has worked with ExpandedNodeId, but this will be removed in a future version (and the method starts to always return false in this case).
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - getIdType
```
public IdType getIdType()
```
  - getNamespaceIndex
```
public int getNamespaceIndex()
```
  - getValue
```
public Object getValue()
```
    Returns the value par of the NodeId, is UnsignedInteger, UUID, String, ByteString, or null.
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - isNullNodeId
```
public boolean isNullNodeId()
```
    Whether the object represents a Null NodeId.
    
    Returns:
    
    Whether the object represents a Null NodeId.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - withTranslatedNamespaces
```
public NodeId 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<NodeId>

Class NodeId

Nested Class Summary

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

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ZERO

NULL_NUMERIC

NULL_STRING

NULL_GUID

NULL_OPAQUE

NULL

ID

EMPTY_ARRAY

Constructor Detail

NodeId

NodeId

NodeId

NodeId

NodeId

NodeId

Method Detail

arrayFrom

decode

equals

from

get

isNull

parseNodeId

randomGUID

compareTo

equals

equals

getIdType

getNamespaceIndex

getValue

hashCode

isNullNodeId

toString

withTranslatedNamespaces