com.opencloud.slee.resources.cgin

Class ArrayDataObject<T>

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<T>

ArrayDataObject<T>

All Implemented Interfaces:

DataObject, java.io.Serializable, java.lang.Iterable<T>, java.util.Collection<T>, java.util.List<T>

Direct Known Subclasses:

ArrayOfDataObject

public class ArrayDataObject<T>
extends java.util.AbstractList<T>
implements DataObject

An ArrayDataObject is a DataObject whose content is an array. It is useful where you need a DataObject as the representation for an ASN.1 SEQUENCE OF or SET OF type, and is used if the extendible adaptation is given.

This implementation assumes that the contained datatype is an opaque type with no special properties. For arrays of datatypes that implement DataObject, ArrayOfDataObject should be used.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected T[]	value

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor and Description
ArrayDataObject(T[] value) Constructs from a given initial array value.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	checkModify() Checks whether this DataObject is mutable.
ArrayDataObject<T>	clone() Perform a deep copy of this object.
static ArrayDataObject<?>	copyOf(ArrayDataObject<?> from) Creates a new ArrayDataObject, initialising its value from that of the given ArrayDataObject.
boolean	equals(java.lang.Object obj) Compares some other object to this one for equality by value.
T	get(int index) Gets the element at the given position in the list.
T[]	getValue() Gets the array value from this DataObject.
int	hashCode() Gets a hash code value for this object.
boolean	isReadOnly() Check if this object has been set read-only.
T	set(int index, T element) Sets the element at the given position in the list to the given value.
void	setReadOnly() Set this object to be "read-only".
int	size() Gets the size of the list.
java.lang.String	toString() Returns a printable representation of this.

Methods inherited from class java.util.AbstractList

add, add, addAll, clear, indexOf, iterator, lastIndexOf, listIterator, listIterator, remove, removeRange, subList

Methods inherited from class java.util.AbstractCollection

addAll, contains, containsAll, isEmpty, remove, removeAll, retainAll, toArray, toArray

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.List

addAll, contains, containsAll, isEmpty, remove, removeAll, retainAll, toArray, toArray

Field Detail

value

protected final T[] value

Constructor Detail

ArrayDataObject

public ArrayDataObject(T[] value)

Constructs from a given initial array value.

Parameters:

value - array value; must not be null.

Method Detail

getValue

public T[] getValue()

Gets the array value from this DataObject. If this instance is readonly, a copy of the array is returned, to avoid possible mutation of the array contents.

Returns:

array

get

public T get(int index)

Gets the element at the given position in the list.

Specified by:

get in interface java.util.List<T>

Specified by:

get in class java.util.AbstractList<T>

Parameters:

index - position in list

Returns:

element from list

set

public T set(int index,
    T element)

Sets the element at the given position in the list to the given value.

Specified by:

set in interface java.util.List<T>

Overrides:

set in class java.util.AbstractList<T>

Parameters:

index - position in list

element - new value

Returns:

old value from same position in list

size

public int size()

Gets the size of the list.

Specified by:

size in interface java.util.Collection<T>

Specified by:

size in interface java.util.List<T>

Specified by:

size in class java.util.AbstractCollection<T>

Returns:

number of elements in list

clone

public ArrayDataObject<T> clone()

Description copied from interface: DataObject

Perform a deep copy of this object. Read-only state of the object is not copied; the new object will be read-write by default.

Inherently immutable objects may optionally return the same object without modification from clone(), rather than constructing a new instance.

Specified by:

clone in interface DataObject

Overrides:

clone in class java.lang.Object

Returns:

a new object that is a deep copy of this object; for immutable objects, the same object may optionally be returned.

setReadOnly

public void setReadOnly()

Description copied from interface: DataObject

Set this object to be "read-only". Any subsequent attempt to modify this object will throw IllegalStateException. Once an object has been made read-only, it cannot be later set to read-write - this is a "one-way" operation.

Note that a read-only object is not necessarily immutable; if reference types are returned from accessors, then callers could theoretically mutate those objects even if the top-level object is marked as read-only. The ability to make objects read-only is intended to catch programming errors (e.g. attempting to modify a data object passed as part of a SLEE event), not to provide an absolute guarantee of immutability.

Calling setReadOnly() on an object that is already read-only is a no-op.

Some DataObject implementations may be inherently immutable. In those cases, they are considered always read-only.

Specified by:

setReadOnly in interface DataObject

isReadOnly

public boolean isReadOnly()

Description copied from interface: DataObject

Check if this object has been set read-only.

Specified by:

isReadOnly in interface DataObject

Returns:

true if the object is read-only or inherently immutable

See Also:

DataObject.setReadOnly()

checkModify

protected void checkModify()

Checks whether this DataObject is mutable.

Throws:

java.lang.IllegalStateException - if this DataObject is read-only

copyOf

public static ArrayDataObject<?> copyOf(ArrayDataObject<?> from)

Creates a new ArrayDataObject, initialising its value from that of the given ArrayDataObject.

Parameters:

from - the object from which to copy

Returns:

new ArrayDataObject

toString

public java.lang.String toString()

Returns a printable representation of this. The printable representations of components are separated by commas and the whole is enclosed in braces, like ASN.1 value notation.

Overrides:

toString in class java.util.AbstractCollection<T>

Returns:

String

equals

public boolean equals(java.lang.Object obj)

Compares some other object to this one for equality by value.

Specified by:

equals in interface java.util.Collection<T>

Specified by:

equals in interface java.util.List<T>

Overrides:

equals in class java.util.AbstractList<T>

Parameters:

obj - other object

Returns:

boolean whether values are equal

hashCode

public int hashCode()

Gets a hash code value for this object.

Specified by:

hashCode in interface java.util.Collection<T>

Specified by:

hashCode in interface java.util.List<T>

Overrides:

hashCode in class java.util.AbstractList<T>

Returns:

Arrays.deepHashCode(value)