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

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

All Implemented Interfaces:

UaNamespaceTranslateable<Variant>, Cloneable
```
public class Variant
extends Object
implements UaNamespaceTranslateable<Variant>, Cloneable
```
Variant wraps an arbitrary builtin variable, an array of builtin variables or a multi-dimension array of builtin variable. Variant is equals-comparable.
An example: Variant v = new Variant( new UnsignedInteger[4][5][6] );
The value may be builtin primitive or a Structure. e.g. new Variant( new NotificationData() );
Encoders write a structure as an ExtensionObject.

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 Variant[] EMPTY_ARRAY

static Variant NULL

Fields
Modifier and Type	Field and Description
`static Variant[]`	`EMPTY_ARRAY`
`static Variant`	`NULL`

Constructor Summary

Constructors
Constructor and Description

Variant(Object value)
Create variant.

Constructors
Constructor and Description
`Variant(Object value)` Create variant.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`<T> T`	`asClass(Class<T> clazz, T defaultValue)` Convert the variant value to any class.
`<T extends Enum<T> & Enumeration> Object`	`asEnum(Class<T> clazz)` Converts the value to the given Enumeration objects.
`Object`	`asEnum(EnumerationSpecification enumerationSpecification)` For a Variant that contains anydimensional data of OPC UA Int32 i.e.
`static Object[]`	`asObjectArray(Variant... variants)` Transforms the given Variant array to an Object array having the variants values as elements.
`Object`	`asOptionSet(OptionSetSpecification optionSetSpecification)` For a Variant that contains anydimensional data of OPC UA Numeric "OptionSet" types, transform the data to the `OptionSetSpecification.getJavaClass()`.
`static Variant[]`	`asVariantArray(Object... objects)` Transforms given objects to a Variant array.
`boolean`	`booleanValue()` Returns the value of the specified Variant as a `boolean`.
`byte`	`byteValue()` Returns the value of the specified Variant as a `byte`.
`Variant`	`clone()`
`protected String`	`compositeClassToString()` compositeClassToString.
`static Variant`	`defaultValue(Class<?> compositeClass)` Get a new Variant instance initialized to a default value of javaClass.
`static Variant`	`defaultValue(Class<?> compositeClass, int valueRank)` Get a new Variant instance initialized to a default value of javaClass.
`static Variant`	`defaultValue(Class<?> compositeClass, UaArrayDimensions arrayDimensions)` Get a new Variant instance initialized to a default value of javaClass.
`static Variant`	`defaultValue(Class<?> compositeClass, UnsignedInteger[] arrayDimensions)` Get a new Variant instance initialized to a default value of javaClass.
`static Variant`	`defaultValue(EncoderContext encoderContext, UaNodeId dataTypeId)` Get a new Variant instance initialized to a default value of a DataType.
`static Variant`	`defaultValue(EncoderContext encoderContext, UaNodeId dataTypeId, int valueRank)`
`static Variant`	`defaultValue(EncoderContext encoderContext, UaNodeId dataTypeId, UaArrayDimensions arrayDimensions)` Get a new Variant instance initialized to a default value of a DataType.
`static Variant`	`defaultValue(EncoderContext encoderContext, UaNodeId dataTypeId, UnsignedInteger[] arrayDimensions)` Get a new Variant instance initialized to a default value of a DataType.
`double`	`doubleValue()` Returns the value of the specified Variant as a `double`.
`boolean`	`equals(Object obj)`
`float`	`floatValue()` Returns the value of the specified Variant as a `float`.
`int[]`	`getArrayDimensions()` Returns the current dimensions of `getValue()` or an empty array, if it is not an array.
`Object`	`getArrayElement(int... indices)` Get the array element corresponding to the indices.
`Class<?>`	`getCompositeClass()` Returns the class type of the variant value.
`int`	`getDimension()` Returns the number of array dimensions of `getValue()` as defined by `MultiDimensionArrayUtils.getDimension(Object)`.
`Object`	`getValue()` Returns the value the `Variant` was constructed with.
`int`	`hashCode()`
`int`	`intValue()` Returns the value of the specified Variant as an `int`.
`boolean`	`isArray()` Returns true, if `getValue()` is not null and it's getClass().isArray() is true.
`boolean`	`isComparable()` Returns true, if `getValue()` is an instance of `Comparable`.
`boolean`	`isEmpty()` Returns true, if `getValue()` is null.
`boolean`	`isNumber()` Returns true, if `getValue()` is an instance of `Number` of `Boolean` (which can be used as Integer) and can therefore be converted `toNumber()`.
`long`	`longValue()` Returns the value of the specified Variant as a `long`.
`short`	`shortValue()` Returns the value of the specified Variant as a `short`.
`Number`	`toNumber()` Returns the value of the specified Variant as a `Number`.
`String`	`toString()`
`String`	`toString(boolean includeCompositeClass)` Convert the value to string, optionally including the compositeClass.
`String`	`toStringWithType()` Convert the value to string, including the compositeClass.
`boolean`	`valueEquals(Variant value2)` Compares the value of a variant with another variant.
`Variant`	`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
finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - NULL
```
public static final Variant NULL
```
  - EMPTY_ARRAY
```
public static final Variant[] EMPTY_ARRAY
```
- Constructor Detail
  - Variant
```
public Variant(Object value)
```
    Create variant.
    
    Parameters:
    
    value - scalar, array or multi-dimension array
- Method Detail
  - asObjectArray
```
public static Object[] asObjectArray(Variant... variants)
```
    Transforms the given Variant array to an Object array having the variants values as elements.
  - asVariantArray
```
public static Variant[] asVariantArray(Object... objects)
```
    Transforms given objects to a Variant array. Returns null if given null. Throws IllegalArgumentException if any of the given types cannot be put to Variant.
  - defaultValue
```
public static Variant defaultValue(Class<?> compositeClass)
```
    Get a new Variant instance initialized to a default value of javaClass.
    
    Parameters:
    
    compositeClass - the class to use to initialize the Variant. Expects that the class is a native JavaClass corresponding to the OPC UA built-in types.
    
    Returns:
    
    a new Variant instance.
  - defaultValue
```
public static Variant defaultValue(Class<?> compositeClass,
                                   int valueRank)
```
    Get a new Variant instance initialized to a default value of javaClass. If valueRank and arrayDimensions are defined, creates an array whose elements are initialized to the default value. If any one of the arrayDimensions is 0, initializes the array with size 1 in that dimension.
    
    Parameters:
    
    compositeClass - the class to use to initialize the Variant. Expects that the class is a native JavaClass corresponding to the OPC UA built-in types.
    
    valueRank - the dimension required for the array. If ValueRanks#acceptsScalar(valueRank) a scalar value is always returned.
    
    Returns:
    
    a new Variant instance.
  - defaultValue
```
public static Variant defaultValue(Class<?> compositeClass,
                                   UaArrayDimensions arrayDimensions)
```
    Get a new Variant instance initialized to a default value of javaClass. If valueRank and arrayDimensions are defined, creates an array whose elements are initialized to the default value. If any one of the arrayDimensions is 0, initializes the array with size 1 in that dimension.
    
    Parameters:
    
    compositeClass - the class to use to initialize the Variant. Expects that the class is a native JavaClass corresponding to the OPC UA built-in types.
    
    arrayDimensions - the size of the array in each dimension.
    
    Returns:
    
    a new Variant instance.
  - defaultValue
```
public static Variant defaultValue(Class<?> compositeClass,
                                   UnsignedInteger[] arrayDimensions)
```
    Get a new Variant instance initialized to a default value of javaClass. If valueRank and arrayDimensions are defined, creates an array whose elements are initialized to the default value. If any one of the arrayDimensions is 0, initializes the array with size 1 in that dimension.
    
    Parameters:
    
    compositeClass - the class to use to initialize the Variant. Expects that the class is a native JavaClass corresponding to the OPC UA built-in types.
    
    arrayDimensions - the size of the array in each dimension.
    
    Returns:
    
    a new Variant instance.
  - defaultValue
```
public static Variant defaultValue(EncoderContext encoderContext,
                                   UaNodeId dataTypeId)
```
    Get a new Variant instance initialized to a default value of a DataType.
    
    Parameters:
    
    encoderContext - the encoder context that can provide the correct DataTypeSpecification for the DataType. Typically, you can get this from the UaApplication instance.
    
    dataTypeId - the NodeId of the OPC UA DataType that you wish to use for (each element of) the default value.
    
    Returns:
    
    a new Variant instance.
  - defaultValue
```
public static Variant defaultValue(EncoderContext encoderContext,
                                   UaNodeId dataTypeId,
                                   int valueRank)
```
  - defaultValue
```
public static Variant defaultValue(EncoderContext encoderContext,
                                   UaNodeId dataTypeId,
                                   UaArrayDimensions arrayDimensions)
```
    Get a new Variant instance initialized to a default value of a DataType. If valueRank and arrayDimensions are defined, creates an array whose elements are initialized to the default value. If any one of the arrayDimensions is 0, initializes the array with size 1 in that dimension.
    
    Parameters:
    
    encoderContext - the encoder context that can provide the correct DataTypeSpecification for the DataType. Typically, you can get this from the UaApplication instance.
    
    dataTypeId - the NodeId of the OPC UA DataType that you wish to use for (each element of) the default value.
    
    arrayDimensions - the size of the array in each dimension.
    
    Returns:
    
    a new Variant instance.
  - defaultValue
```
public static Variant defaultValue(EncoderContext encoderContext,
                                   UaNodeId dataTypeId,
                                   UnsignedInteger[] arrayDimensions)
```
    Get a new Variant instance initialized to a default value of a DataType. If valueRank and arrayDimensions are defined, creates an array whose elements are initialized to the default value. If any one of the arrayDimensions is 0, initializes the array with size 1 in that dimension.
    
    Parameters:
    
    encoderContext - the encoder context that can provide the correct DataTypeSpecification for the DataType. Typically, you can get this from the UaApplication instance.
    
    dataTypeId - the NodeId of the OPC UA DataType that you wish to use for (each element of) the default value.
    
    arrayDimensions - the size of the array in each dimension.
    
    Returns:
    
    a new Variant instance.
  - asClass
```
public <T> T asClass(Class<T> clazz,
                     T defaultValue)
```
    Convert the variant value to any class. If it cannot be converted returns defaultValue.
  - asEnum
```
public <T extends Enum<T> & Enumeration> Object asEnum(Class<T> clazz)
```
    Converts the value to the given Enumeration objects. NOTE! this works only if the value of this Variant is Integer or somedimensional array of them. NOTE! If there is no matching Enumeration value for internal value Integers, null is used.
    
    Parameters:
    
    clazz - enumeration class
    
    Returns:
    
    equivalent scalar/X-dim array of Enumerations of given class or null if internal value is null
    
    Throws:
    
    ClassCastException - if internal value is not Integer (or somedimensional array of them)
  - asEnum
```
public Object asEnum(EnumerationSpecification enumerationSpecification)
```
    For a Variant that contains anydimensional data of OPC UA Int32 i.e. java.lang.Integers, transforms the data to the respective OPC UA Enumeration objects based on the given EnumerationSpecification. Integer values that do not map to the given EnumerationSpecification's range are set to null. Returns null, if contained null value. Return value has same dimensions as getValue() has. For array data for EnumerationSpecifications without any constants returns raw Enumeration-typed arrays (of proper dimensions).
    
    Throws:
    
    ClassCastException - if this variant doesn't contain java.lang.Integer values (scalar or of any dimension).
  - asOptionSet
```
public Object asOptionSet(OptionSetSpecification optionSetSpecification)
```
    For a Variant that contains anydimensional data of OPC UA Numeric "OptionSet" types, transform the data to the OptionSetSpecification.getJavaClass(). Returns null if given null. If given OptionSetStructureSpecification, doesn't do any conversion (as this only makes sense for UInteger-based OptionSets).
    
    Throws:
    
    ClassCastException - if this variant doesn't contain correct UInteger-based value for the given OptionSetSpecification.getBaseTypeId().
  - booleanValue
```
public boolean booleanValue()
```
    Returns the value of the specified Variant as a boolean.
    
    Returns:
    
    the Variant value as boolean, if it can be cast to such
    
    Throws:
    
    ClassCastException - if the value cannot be cast to boolean
  - byteValue
```
public byte byteValue()
```
    Returns the value of the specified Variant as a byte. This may involve rounding or truncation.
    
    Returns:
    
    the numeric value represented by this object after conversion to type byte.
    
    Throws:
    
    ClassCastException - if the value cannot be cast to Number
  - clone
```
public Variant clone()
```
    Overrides:
    
    clone in class Object
  - doubleValue
```
public double doubleValue()
```
    Returns the value of the specified Variant as a double. This may involve rounding.
    
    Returns:
    
    the numeric value represented by this object after conversion to type double.
    
    Throws:
    
    ClassCastException - if the value cannot be cast to Number
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - floatValue
```
public float floatValue()
```
    Returns the value of the specified Variant as a float. This may involve rounding.
    
    Returns:
    
    the numeric value represented by this object after conversion to type float.
    
    Throws:
    
    ClassCastException - if the value cannot be cast to Number
  - getArrayDimensions
```
public int[] getArrayDimensions()
```
    Returns the current dimensions of getValue() or an empty array, if it is not an array.
  - getArrayElement
```
public Object getArrayElement(int... indices)
```
    Get the array element corresponding to the indices. The indices must match with the dimensions of the underlying array value.
  - getCompositeClass
```
public Class<?> getCompositeClass()
```
    Returns the class type of the variant value. If the value was an array (or multidimensional array), then this is the individual element type of the value.
  - getDimension
```
public int getDimension()
```
    Returns the number of array dimensions of getValue() as defined by MultiDimensionArrayUtils.getDimension(Object).
  - getValue
```
public Object getValue()
```
    Returns the value the Variant was constructed with.
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - intValue
```
public int intValue()
```
    Returns the value of the specified Variant as an int. This may involve rounding or truncation.
    
    Returns:
    
    the numeric value represented by this object after conversion to type int.
    
    Throws:
    
    ClassCastException - if the value cannot be cast to Number
  - isArray
```
public boolean isArray()
```
    Returns true, if getValue() is not null and it's getClass().isArray() is true.
  - isComparable
```
public boolean isComparable()
```
    Returns true, if getValue() is an instance of Comparable.
  - isEmpty
```
public boolean isEmpty()
```
    Returns true, if getValue() is null.
  - isNumber
```
public boolean isNumber()
```
    Returns true, if getValue() is an instance of Number of Boolean (which can be used as Integer) and can therefore be converted toNumber().
  - longValue
```
public long longValue()
```
    Returns the value of the specified Variant as a long. This may involve rounding or truncation.
    
    Returns:
    
    the numeric value represented by this object after conversion to type long.
    
    Throws:
    
    ClassCastException - if the value cannot be cast to Number
  - shortValue
```
public short shortValue()
```
    Returns the value of the specified Variant as a short. This may involve rounding or truncation.
    
    Returns:
    
    the numeric value represented by this object after conversion to type short.
    
    Throws:
    
    ClassCastException - if the value cannot be cast to Number
  - toNumber
```
public Number toNumber()
```
    Returns the value of the specified Variant as a Number.
    
    Returns:
    
    the Variant value as Number, if it can be cast to such
    
    Throws:
    
    ClassCastException - if the value cannot be cast to Number
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - toString
```
public String toString(boolean includeCompositeClass)
```
    Convert the value to string, optionally including the compositeClass.
    
    Parameters:
    
    includeCompositeClass - whether to also add the name of the compositeClass
    
    Returns:
    
    the value as string
  - toStringWithType
```
public String toStringWithType()
```
    Convert the value to string, including the compositeClass.
    
    Returns:
    
    a String object.
  - valueEquals
```
public boolean valueEquals(Variant value2)
```
    Compares the value of a variant with another variant. If the values are of the same class, equals(Object) is called. If both variants isNumber(), compares the floatValue() of each.
    
    Parameters:
    
    value2 - the value to compare to
    
    Returns:
    
    true if the values of the variants are equal
  - withTranslatedNamespaces
```
public Variant 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<Variant>
  - compositeClassToString
```
protected String compositeClassToString()
```
    compositeClassToString.
    
    Returns:
    
    a String object.

Class Variant

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

NULL

EMPTY_ARRAY

Constructor Detail

Variant

Method Detail

asObjectArray

asVariantArray

defaultValue

defaultValue

defaultValue

defaultValue

defaultValue

defaultValue

defaultValue

defaultValue

asClass

asEnum

asEnum

asOptionSet

booleanValue

byteValue

clone

doubleValue

equals

floatValue

getArrayDimensions

getArrayElement

getCompositeClass

getDimension

getValue

hashCode

intValue

isArray

isComparable

isEmpty

isNumber

longValue

shortValue

toNumber

toString

toString

toStringWithType

valueEquals

withTranslatedNamespaces

compositeClassToString