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

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

```
public class UaArrayDimensions
extends Object
```
An immutable representation of the concept of ArrayDimensions. Can be used to model the value of Attributes.ArrayDimensions, where the values represents the maximums number of elements per dimension, or 0 if unknown/unlimited. Can also be used to model the actual, exact, dimensions of a (possibly multidimensional) value. Instances can be constructed via static factory methods. This class is considered to be sealed, i.e. static factory methods may return subclasses of this class, but no new subclasses can be defined outside of the SDK.

Field Summary

Fields
Modifier and Type Field and Description

static UaArrayDimensions EMPTY

Fields
Modifier and Type	Field and Description
`static UaArrayDimensions`	`EMPTY`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`UnsignedInteger`	`get(int index)` Returns the element at index.
`List<UnsignedInteger>`	`getValue()` Deprecated. use `toList()` instead.
`int`	`hashCode()`
`boolean`	`isEmpty()` Returns true if `size()` is 0, false otherwise.
`static boolean`	`isNullOrEmpty(UaArrayDimensions arrayDimensions)` Returns true if given `UaArrayDimensions` is null or `isEmpty()` is true, false otherwise.
`boolean`	`isUnlimited()` Returns true, if any dimension `isUnlimited(int)`, i.e.
`boolean`	`isUnlimited(int index)` Returns true, if the dimension with the index is not limited in size, i.e.
`static UaArrayDimensions`	`ones(int dimensions)` Returns an `UaArrayDimensions` that has the given dimensions and value 1 for each element.
`static UaArrayDimensions`	`parse(String string)` Parses `UaArrayDimensions` from given `String` of comma separated `UnsignedInteger` values.
`int`	`size()` Returns the number of dimensions.
`UnsignedInteger[]`	`toArray()` Returns (a new) array of the data.
`int[]`	`toIntArray()` Returns (a new) array of the data as int[].
`List<UnsignedInteger>`	`toList()` Returns an unmodifiable list representing the ArrayDimensions.
`long[]`	`toLongArray()` Returns (a new) array of the data as long[].
`String`	`toString()`
`static UaArrayDimensions`	`unlimited(int dimensions)` Returns an `UaArrayDimensions` that has the given dimensions and value 0 for each element.
`static UaArrayDimensions`	`valueOf()` Returns `EMPTY`.
`static UaArrayDimensions`	`valueOf(int[] values)` Returns `UaArrayDimensions` containing the given values.
`static UaArrayDimensions`	`valueOf(List<UnsignedInteger> values)` Returns `UaArrayDimensions` containing the given values.
`static UaArrayDimensions`	`valueOf(long... value)` Returns `UaArrayDimensions` containing the given values.
`static UaArrayDimensions`	`valueOf(UnsignedInteger... value)` Returns `UaArrayDimensions` containing the given values.
`static UaArrayDimensions`	`zeros(int dimensions)` Returns an `UaArrayDimensions` that has the given dimensions and value 0 for each element.

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

- Field Detail
  - EMPTY
```
public static final UaArrayDimensions EMPTY
```
- Method Detail
  - isNullOrEmpty
```
public static boolean isNullOrEmpty(UaArrayDimensions arrayDimensions)
```
    Returns true if given UaArrayDimensions is null or isEmpty() is true, false otherwise.
  - ones
```
public static UaArrayDimensions ones(int dimensions)
```
    Returns an UaArrayDimensions that has the given dimensions and value 1 for each element. Throws IllegalArgumentException if given dimensions < 0.
  - parse
```
public static UaArrayDimensions parse(String string)
```
    Parses UaArrayDimensions from given String of comma separated UnsignedInteger values. The String can optionally begin and end with a square bracket (as output by toString()). Returns EMPTY for null and empty Strings. Throws IllegalArgumentException on invalid input.
  - unlimited
```
public static UaArrayDimensions unlimited(int dimensions)
```
    Returns an UaArrayDimensions that has the given dimensions and value 0 for each element. Throws IllegalArgumentException if given dimensions < 0.
  - valueOf
```
public static UaArrayDimensions valueOf()
```
    Returns EMPTY.
  - valueOf
```
public static UaArrayDimensions valueOf(int[] values)
```
    Returns UaArrayDimensions containing the given values. Each given int is converted to UnsignedInteger.valueOf(long), with this method throwing IllegalArgumentException if UnsignedInteger.valueOf(long), would throw. Returns null if given null array.
  - valueOf
```
public static UaArrayDimensions valueOf(List<UnsignedInteger> values)
```
    Returns UaArrayDimensions containing the given values. Returns null if given null. Any null element in the list itself is treated as UnsignedInteger.ZERO.
  - valueOf
```
public static UaArrayDimensions valueOf(long... value)
```
    Returns UaArrayDimensions containing the given values. Each given long is converted to UnsignedInteger.valueOf(long), with this method throwing IllegalArgumentException if UnsignedInteger.valueOf(long), would throw. Returns null if given null array.
  - valueOf
```
public static UaArrayDimensions valueOf(UnsignedInteger... value)
```
    Returns UaArrayDimensions containing the given values. Returns null if given null array. Any null element in the array itself is treated as UnsignedInteger.ZERO.
  - zeros
```
public static UaArrayDimensions zeros(int dimensions)
```
    Returns an UaArrayDimensions that has the given dimensions and value 0 for each element. Throws IllegalArgumentException if given dimensions < 0.
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - get
```
public UnsignedInteger get(int index)
```
    Returns the element at index.
    
    Parameters:
    
    index - the index of the dimension
    
    Throws:
    
    IndexOutOfBoundsException - if the index is beyond the dimensions
  - getValue
```
@Deprecated
public List<UnsignedInteger> getValue()
```
    Deprecated. use toList() instead.
    
    Returns an unmodifiable list representing the ArrayDimensions.
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - isEmpty
```
public boolean isEmpty()
```
    Returns true if size() is 0, false otherwise.
  - isUnlimited
```
public boolean isUnlimited()
```
    Returns true, if any dimension isUnlimited(int), i.e. equals to 0.
    
    See Also:
    
    isUnlimited(int)
  - isUnlimited
```
public boolean isUnlimited(int index)
```
    Returns true, if the dimension with the index is not limited in size, i.e. is 0.
    
    See Also:
    
    isUnlimited()
  - size
```
public int size()
```
    Returns the number of dimensions. This is the same as the size of toList().
  - toArray
```
public UnsignedInteger[] toArray()
```
    Returns (a new) array of the data. This is same as calling List.toArray() on the getValue().
  - toIntArray
```
public int[] toIntArray()
```
    Returns (a new) array of the data as int[]. This is same as calling List.toArray() on the getValue() and transforming the values to int. Note that the value for any element shouldn't be over int32 max value, but if they are, int32 max value is used instead in the returned array.
  - toList
```
public List<UnsignedInteger> toList()
```
    Returns an unmodifiable list representing the ArrayDimensions.
  - toLongArray
```
public long[] toLongArray()
```
    Returns (a new) array of the data as long[]. This is same as calling List.toArray() on the getValue() and transforming the values to long.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class UaArrayDimensions

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

EMPTY

Method Detail

isNullOrEmpty

ones

parse

unlimited

valueOf

valueOf

valueOf

valueOf

valueOf

zeros

equals

get

getValue

hashCode

isEmpty

isUnlimited

isUnlimited

size

toArray

toIntArray

toList

toLongArray

toString