Variant (ignition 7.8.4-rc1 API)

java.lang.Object
- com.inductiveautomation.opcua.types.Variant

All Implemented Interfaces:

java.io.Serializable
```
public class Variant
extends java.lang.Object
implements java.io.Serializable
```
A Variant is a wrapper around any of the built-in datatypes. See OPC-UA Spec part 6 (Mappings) Section 5.1.5. This implementation of Variant is simply a wrapper around a java.lang.Object. A null variant is different than a variant whose value is null.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description
`Variant(java.lang.Boolean value)`
`Variant(java.lang.Boolean[] value)`
`Variant(java.lang.Byte value)` Creates a Byte variant.
`Variant(java.lang.Byte[][] value)` Creates a ByteString[] Variant
`Variant(java.lang.Byte[] value, DataType dataType)` Creates a SByte[], or ByteString[] Variant, depending on the DataType
`Variant(java.lang.Byte value, DataType type)` Creates an Byte or UByte variant, depending on the DataType.
`Variant(DataValue value)`
`Variant(DataValue[] value)`
`Variant(java.util.Date value)`
`Variant(java.lang.Double value)` Creates a Double variant
`Variant(java.lang.Double[] value)`
`Variant(ExpandedNodeId[] value)`
`Variant(ExtensionObject value)`
`Variant(ExtensionObject[] value)`
`Variant(java.lang.Float value)` Creates a Float variant
`Variant(java.lang.Float[] value)`
`Variant(Guid value)` Creates a Guid variant
`Variant(Guid[] value)`
`Variant(java.lang.Integer value)` Creates an Int32 Variant
`Variant(java.lang.Integer[] value)`
`Variant(LocalizedText value)`
`Variant(LocalizedText[] value)`
`Variant(java.lang.Long value)` Creates an Int64 Variant
`Variant(java.lang.Long[] value)`
`Variant(NodeId value)`
`Variant(NodeId[] value)`
`Variant(java.lang.Object value)` Constructer that automatically tries to detect the type.
`Variant(java.lang.Object value, DataType dataType, int arrayLength, int[] arrayDimensions)` Special constructor for multi-dimensional arrays.
`Variant(QualifiedName value)`
`Variant(QualifiedName[] value)`
`Variant(java.lang.Short value)` Creates an Int16 Variant
`Variant(java.lang.Short[] value)`
`Variant(StatusCode value)`
`Variant(StatusCode[] value)`
`Variant(java.lang.String value)` Creates a String variant
`Variant(java.lang.String[] value)`
`Variant(UByte value)` Creates an UByte variant.
`Variant(UByte[] value)`
`Variant(UInt16 value)` Creates a UInt16 variant
`Variant(UInt16[] value)`
`Variant(UInt32 value)` Creates a UInt32 variant
`Variant(UInt32[] value)`
`Variant(UInt64 value)` Creates a UInt64 variant
`Variant(UInt64[] value)`
`Variant(UtcTime value)` Creates a UtcTime variant
`Variant(UtcTime[] value)`
`Variant(Variant[] value)`
`Variant(XmlElement value)`
`Variant(XmlElement[] value)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object obj)`
`int`	`getArrayLength()`
`int[]`	`getDimensions()`
`DataType`	`getType()`
`java.lang.Object`	`getValue()`
`int`	`hashCode()`
`boolean`	`isArray()`
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Variant

public Variant(java.lang.Object value,
               DataType dataType,
               int arrayLength,
               int[] arrayDimensions)

Special constructor for multi-dimensional arrays. Note that the value object itself must actually be a flattened array, as specified in OPC-UA Part 6

Variant
```
public Variant(java.lang.Object value)
        throws UAException
```
Constructer that automatically tries to detect the type. Will work for single-dimension arrays as well. Cannot handle null.

Throws:

UAException

Variant

public Variant(java.lang.Boolean value)

Variant
```
public Variant(java.lang.Byte value)
```
Creates a Byte variant.

Variant
```
public Variant(UByte value)
```
Creates an UByte variant.

Variant

public Variant(java.lang.Byte value,
               DataType type)

Creates an Byte or UByte variant, depending on the DataType.

Variant
```
public Variant(java.lang.Short value)
```
Creates an Int16 Variant

Variant

public Variant(java.lang.Integer value)

Creates an Int32 Variant

Variant
```
public Variant(java.lang.Long value)
```
Creates an Int64 Variant

Variant
```
public Variant(UInt16 value)
```
Creates a UInt16 variant

Variant
```
public Variant(UInt32 value)
```
Creates a UInt32 variant

Variant
```
public Variant(UInt64 value)
```
Creates a UInt64 variant

Variant
```
public Variant(java.lang.Float value)
```
Creates a Float variant

Variant

public Variant(java.lang.Double value)

Creates a Double variant

Variant
```
public Variant(java.util.Date value)
```

Variant
```
public Variant(UtcTime value)
```
Creates a UtcTime variant

Variant
```
public Variant(Guid value)
```
Creates a Guid variant

Variant

public Variant(java.lang.String value)

Creates a String variant

Variant
```
public Variant(XmlElement value)
```

Variant
```
public Variant(NodeId value)
```

Variant
```
public Variant(StatusCode value)
```

Variant
```
public Variant(QualifiedName value)
```

Variant
```
public Variant(LocalizedText value)
```

Variant
```
public Variant(ExtensionObject value)
```

Variant
```
public Variant(DataValue value)
```

Variant

public Variant(java.lang.Byte[][] value)

Creates a ByteString[] Variant

Variant

public Variant(java.lang.Byte[] value,
               DataType dataType)

Creates a SByte[], or ByteString[] Variant, depending on the DataType

Variant
```
public Variant(UByte[] value)
```

Variant

public Variant(java.lang.Boolean[] value)

Variant

public Variant(java.lang.Short[] value)

Variant

public Variant(java.lang.Integer[] value)

Variant

public Variant(java.lang.Long[] value)

Variant
```
public Variant(UInt16[] value)
```

Variant
```
public Variant(UInt32[] value)
```

Variant
```
public Variant(UInt64[] value)
```

Variant

public Variant(java.lang.Float[] value)

Variant

public Variant(java.lang.Double[] value)

Variant
```
public Variant(UtcTime[] value)
```

Variant
```
public Variant(Guid[] value)
```

Variant

public Variant(java.lang.String[] value)

Variant
```
public Variant(XmlElement[] value)
```

Variant
```
public Variant(NodeId[] value)
```

Variant

public Variant(ExpandedNodeId[] value)

Variant
```
public Variant(StatusCode[] value)
```

Variant
```
public Variant(QualifiedName[] value)
```

Variant
```
public Variant(LocalizedText[] value)
```

Variant

public Variant(ExtensionObject[] value)

Variant
```
public Variant(DataValue[] value)
```

Variant
```
public Variant(Variant[] value)
```

Method Detail

getValue
```
public java.lang.Object getValue()
```

hashCode
```
public int hashCode()
```
Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:: equals in class java.lang.Object

toString
```
public java.lang.String toString()
```
Overrides:

toString in class java.lang.Object

getType
```
public DataType getType()
```

getArrayLength
```
public int getArrayLength()
```

isArray
```
public boolean isArray()
```

getDimensions
```
public int[] getDimensions()
```

Class Variant

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Variant

Variant

Variant

Variant

Variant

Variant

Variant

Variant

Variant

Variant

Variant

Variant

Variant

Variant

Variant

Variant

Variant

Variant

Variant

Variant

Variant

Variant

Variant

Variant

Variant

Variant

Variant

Variant

Variant

Variant

Variant

Variant

Variant

Variant

Variant

Variant

Variant

Variant

Variant

Variant

Variant

Variant

Variant

Variant

Variant

Variant

Variant

Variant

Variant

Method Detail

getValue

hashCode

equals

toString

getType

getArrayLength

isArray

getDimensions