com.prosysopc.ua

Class StructureUtils

java.lang.Object

com.prosysopc.ua.StructureUtils

public class StructureUtils
extends Object

This class contains utils for codegenerated Structures.

Method Summary

Modifier and Type	Method and Description
static <T> T	clone(T object) Clone given object if it can be, otherwise the given object is returned.
static Map<FieldSpecification,Object>	createFieldsMap(StructureSpecification spec, Object[] values) Creates "Fields Map" for Structure.toFieldsMap().
static <T extends Structure> T[]	fixEmptyStructureArrayType(Class<T> clazz, Variant value) If the given Variant value is exactly Structure[0] or BigDecimal[0], then this method returns an empty array of the given Class parameter.
static int	hashCode(Object... objects) Calculates a hash code for given objects.
static boolean	scalarOrArrayEquals(Object first, Object second) Compares the two given objects for equals.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

clone

public static <T> T clone(T object)

Clone given object if it can be, otherwise the given object is returned. Given inputs shall be structure fields. If for some reason the clone operation fails, the given object is returned instead. Array inputs are deep-cloned (elements are cloned, if they do implement Cloneable, otherwise same reference is used). Empty arrays in Java are immutable and thus not cloned.

Type Parameters:

T - this is in order to avoid casts after calls

Parameters:

object - object to clone (null is allowed and returned if given)

Returns:

cloned object, if needed/possible

createFieldsMap

public static Map<FieldSpecification,Object> createFieldsMap(StructureSpecification spec,
                                                             Object[] values)

Creates "Fields Map" for Structure.toFieldsMap(). The given values array size must exactly match the number of fields of the Structure.

fixEmptyStructureArrayType

public static <T extends Structure> T[] fixEmptyStructureArrayType(Class<T> clazz,
                                                                   Variant value)

If the given Variant value is exactly Structure[0] or BigDecimal[0], then this method returns an empty array of the given Class parameter. Otherwise casts the value to the array. The purpose of this method is to fix the shortcoming that an empty array of Structure does not have type information in the binary encodings and is therefore deserialized as raw Structure[0] (or BigDecimal[0], which shares the same binary form) array which cannot be casted to the correct type via normal java cast.

Parameters:

clazz - Component class type this method should return

value - a Variant with value of correct type or Structure[0] (or BigDecimal[0])

Returns:

an array of the given clazz, or null if the value contained within the Variant is null

Throws:

ClassCastException - if the Variant contains a value that cannot be casted to correct type (and is not Structure[0] or BigDecimal[0]).

hashCode

public static int hashCode(Object... objects)

Calculates a hash code for given objects. Each input can be a scalar or anydimensional array. Calls Object.hashCode() of the object for scalars, Arrays.hashCode(Object[])e for 1-dim arrays and Arrays.deepHashCode(Object[]) for multidim arrays. Multidim arrays shall not contiain themselvers as elements as per Arrays.deepHashCode(Object[]) documentation.

Parameters:

objects - the objects

Returns:

hash code for given objects

scalarOrArrayEquals

public static boolean scalarOrArrayEquals(Object first,
                                          Object second)

Compares the two given objects for equals. The given objects can be a scalar or anydimensional array. Null is only equal to null. Assuming both arguments are non-null, scalars are compared using first.equals(second), 1-dim arrays with Arrays.equals(Object[], Object[]) and multidimensional arrays with Arrays.deepEquals(Object[], Object[]). Multidimensional arrays shall not contain themselves as elements as per Arrays.deepEquals(Object[], Object[]) documentation.

Parameters:

first - null, scalar or anydimensional array (non-primitive)

second - null, scalar or one anydimensional array (non-primitive)

Returns:

true if first equals second