Package net.algart.arrays

Class AbstractUpdatableObjectArray<E>

java.lang.Object

net.algart.arrays.AbstractArray

net.algart.arrays.AbstractObjectArray<E>

net.algart.arrays.AbstractUpdatableObjectArray<E>

All Implemented Interfaces:

Cloneable, Array, ArrayExchanger, ObjectArray<E>, UpdatableArray, UpdatableObjectArray<E>

public abstract class AbstractUpdatableObjectArray<E>
extends AbstractObjectArray<E>
implements UpdatableObjectArray<E>

Implementation of almost all basic functions of UpdatableObjectArray interface. The only ObjectArray.get(long) and UpdatableObjectArray.set(long, Object) methods are not defined in this class; all other methods are implemented via calls of these 2 methods.

Author:

Daniel Alievsky

Field Summary

Fields inherited from class net.algart.arrays.AbstractArray

capacity, length, underlyingArrays

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractUpdatableObjectArray(Class<E> elementType, long initialCapacityAndLength, boolean underlyingArraysAreParallel, Array... underlyingArrays)	Equivalent to the constructor AbstractUpdatableObjectArray(Class, long, long, boolean, Array...), where both initialCapacity and initialLength arguments are equal to initialCapacityAndLength.
protected	AbstractUpdatableObjectArray(Class<E> elementType, long initialCapacity, long initialLength, boolean underlyingArraysAreParallel, Array... underlyingArrays)	Creates an array with the given initial capacity and length.

Method Summary

Modifier and Type	Method	Description
UpdatableArray	asCopyOnNextWrite()	This implementation returns updatableClone(Arrays.SMM).
ObjectArray<E>	asImmutable()	This implementation returns an instance of the subclass of AbstractObjectArray, where the following method are overridden and call the same methods of this instance: AbstractObjectArray.get(long), AbstractObjectArray.getData(long, Object, int, int), AbstractObjectArray.getData(long, Object), AbstractObjectArray.loadResources(ArrayContext, long, long), AbstractObjectArray.flushResources(ArrayContext, long, long, boolean) and AbstractObjectArray.freeResources(ArrayContext, long, long, boolean).
UpdatableObjectArray<E>	asUnresizable()	This implementation returns this object.
<D> UpdatableObjectArray<D>	cast(Class<D> elementType)	Returns this array cast to the specified generic element type or throws ClassCastException if the elements cannot be cast to the required type (because the element type is not its subclass).
void	copy(long destIndex, long srcIndex)	This implementation calls set(destIndex, get(srcIndex)).
void	copy(long destIndex, long srcIndex, long count)	This implementation is based on a loop of calls of copy(long, long) method.
UpdatableArray	copy(Array src)	This implementation calls defaultCopy(thisInstance, src).
UpdatableObjectArray<E>	fill(long position, long count, E value)	This implementation does the following: subArr(position, count).copy(Arrays.nObjectCopies(count, value)).
final UpdatableObjectArray<E>	fill(E value)	This implementation just calls fill(0, thisArray.length(), value).
boolean	isImmutable()	This implementation returns false.
abstract void	set(long index, E value)	Equivalent to setElement(index, value).
UpdatableArray	setData(long arrayPos, Object srcArray)	This implementation calls setData(long, Object, int, int) with corresponding arguments.
UpdatableArray	setData(long arrayPos, Object srcArray, int srcArrayOffset, int count)	This implementation is based on a loop of calls of set(long, Object) method.
void	setElement(long index, Object value)	This implementation calls set(index, value).
void	setNonNew()	This implementation calls setNewStatus(false).
UpdatableArray	shallowClone()	This implementation returns (UpdatableArray)super.shallowClone().
UpdatableObjectArray<E>	subArr(long position, long count)	This implementation returns subArray(position, position + count).
UpdatableObjectArray<E>	subArray(long fromIndex, long toIndex)	This implementation returns new instance of AbstractUpdatableObjectArray with the same memory model and underlying arrays, that were passed to the constructor of this instance, and with overridden methods AbstractObjectArray.get(long), set(long, Object), AbstractObjectArray.getData(long, Object, int, int) and setData(long, Object, int, int) calling the same methods of this instance with corresponding corrections of the arguments.
void	swap(long firstIndex, long secondIndex)	This implementation swaps two elements by AbstractObjectArray.get(long) and set(long, Object) methods.
void	swap(long firstIndex, long secondIndex, long count)	This implementation is based on a loop of calls of swap(long, long) method.
UpdatableArray	swap(UpdatableArray another)	This implementation calls defaultSwap(thisInstance, another).
String	toString()	Returns a brief string description of this object.

Methods inherited from class net.algart.arrays.AbstractObjectArray

asTrustedImmutable, buffer, buffer, buffer, buffer, checkUnallowedMutation, elementType, flushResources, flushResources, freeResources, freeResources, get, getData, getData, getElement, indexOf, isCopyOnNextWrite, isUnresizable, ja, lastIndexOf, loadResources, loadResources, mutableClone, mutableType, type, updatableClone, updatableType

Methods inherited from class net.algart.arrays.AbstractArray

byteOrder, capacity, checkCopyArguments, checkSubArrArguments, checkSubArrayArguments, checkSwapArguments, defaultAppend, defaultBuffer, defaultBufferCapacity, defaultCopy, defaultCopy, defaultSwap, equals, equals, flushResources, freeResources, hashCode, hashCode, isLazy, isNew, isNewReadOnlyView, isZeroFilled, length, newJavaArray, setNewReadOnlyViewStatus, setNewStatus, standardObjectClone

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.algart.arrays.Array

byteOrder, capacity, checkUnallowedMutation, equals, flushResources, flushResources, freeResources, freeResources, getData, getData, getElement, hashCode, isCopyOnNextWrite, isEmpty, isLazy, isNew, isNewReadOnlyView, isUnresizable, length, length32, loadResources, newJavaArray

Methods inherited from interface net.algart.arrays.ObjectArray

asTrustedImmutable, buffer, buffer, buffer, buffer, elementType, get, indexOf, ja, lastIndexOf, mutableClone, mutableType, type, updatableClone, updatableType

Methods inherited from interface net.algart.arrays.UpdatableObjectArray

matrix

Constructor Details

AbstractUpdatableObjectArray

protected AbstractUpdatableObjectArray(Class<E> elementType,
 long initialCapacity,
 long initialLength,
 boolean underlyingArraysAreParallel,
 Array... underlyingArrays)

Creates an array with the given initial capacity and length.

This array is not new by default. This is correct usually, because this class is often used for creating a view of another data. However, if the instance if this class does not depend on any other data sources, you may call setNewStatus(true) in the constructor of your subclass.

Parameters:

elementType - the element type of this array.

initialCapacity - initial capacity of the array.

initialLength - initial length of the array.

underlyingArraysAreParallel - see the same argument of AbstractFloatArray(long, long, boolean, Array...).

underlyingArrays - see the same argument of AbstractArray(long, long, Array...).

Throws:

NullPointerException - if underlyingArrays argument or some of underlyingArrays[k] elements is null.

IllegalArgumentException - if the initialCapacity or initialLength arguments are illegal (negative, or capacity < length).

SizeMismatchException - if underlyingArraysAreParallel=true, underlyingArrays.length>1 and some of passed arrays have different lengths.

AbstractUpdatableObjectArray

protected AbstractUpdatableObjectArray(Class<E> elementType,
 long initialCapacityAndLength,
 boolean underlyingArraysAreParallel,
 Array... underlyingArrays)

Equivalent to the constructor AbstractUpdatableObjectArray(Class, long, long, boolean, Array...), where both initialCapacity and initialLength arguments are equal to initialCapacityAndLength.

Parameters:

elementType - the element type of this array.

initialCapacityAndLength - initial capacity and length of the array.

underlyingArraysAreParallel - see AbstractUpdatableObjectArray(Class, long, long, boolean, Array...).

underlyingArrays - see AbstractUpdatableObjectArray(Class, long, long, boolean, Array...)

Throws:

IllegalArgumentException - if the passed argument are illegal (negative).

Method Details

subArray

public UpdatableObjectArray<E> subArray(long fromIndex,
 long toIndex)

This implementation returns new instance of AbstractUpdatableObjectArray with the same memory model and underlying arrays, that were passed to the constructor of this instance, and with overridden methods AbstractObjectArray.get(long), set(long, Object), AbstractObjectArray.getData(long, Object, int, int) and setData(long, Object, int, int) calling the same methods of this instance with corresponding corrections of the arguments.

The returned instance also have overridden methods AbstractObjectArray.loadResources(ArrayContext, long, long), AbstractObjectArray.flushResources(ArrayContext, long, long, boolean) and AbstractObjectArray.freeResources(ArrayContext, long, long, boolean), that also call the same methods of this instance with corresponding correction of their fromIndex argument.

The returned instance also have overridden method AbstractArray.isLazy(), that just calls the same methods of this instance with the same arguments.

Specified by:

subArray in interface Array

Specified by:

subArray in interface UpdatableArray

Specified by:

subArray in interface UpdatableObjectArray<E>

Overrides:

subArray in class AbstractObjectArray<E>

Parameters:

fromIndex - low endpoint (inclusive) of the subarray.

toIndex - high endpoint (exclusive) of the subarray.

Returns:

a view of the specified range within this array.

Throws:

IndexOutOfBoundsException - for illegal fromIndex and toIndex (fromIndex < 0 || toIndex > length() || fromIndex > toIndex).

See Also:

• Array.subArr(long, long)

subArr

public UpdatableObjectArray<E> subArr(long position,
 long count)

Description copied from class: AbstractArray

This implementation returns subArray(position, position + count). Please note that the exception message can be not fully correct for the very exotic case position+count>Long.MAX_VALUE.

Specified by:

subArr in interface Array

Specified by:

subArr in interface UpdatableArray

Specified by:

subArr in interface UpdatableObjectArray<E>

Overrides:

subArr in class AbstractArray

Parameters:

position - start position (inclusive) of the subarray.

count - number of elements in the subarray.

Returns:

a view of the specified range within this array.

See Also:

• Array.subArray(long, long)

set

public abstract void set(long index,
 E value)

Description copied from interface: UpdatableObjectArray

Equivalent to setElement(index, value).

Specified by:

set in interface UpdatableObjectArray<E>

Parameters:

index - index of element to replace.

value - element to be stored at the specified position.

fill

public final UpdatableObjectArray<E> fill(E value)

This implementation just calls fill(0, thisArray.length(), value).

Specified by:

fill in interface UpdatableObjectArray<E>

Parameters:

value - the value to be stored in all elements of the array.

Returns:

a reference to this array.

See Also:

• UpdatableObjectArray.fill(long, long, Object)
• Arrays.zeroFill(UpdatableArray)

fill

public UpdatableObjectArray<E> fill(long position,
 long count,
 E value)

This implementation does the following: subArr(position, count).copy(Arrays.nObjectCopies(count, value)). Please override this method if it's possible to perform the same task more efficiently.

Specified by:

fill in interface UpdatableObjectArray<E>

Parameters:

position - start index (inclusive) to be filled.

count - number of filled elements.

value - the value to be stored in the elements of the array.

Returns:

a reference to this array.

Throws:

IndexOutOfBoundsException - for illegal position and count (position < 0 || count < 0 || position + count > length()).

See Also:

• UpdatableObjectArray.fill(Object)
• Arrays.zeroFill(UpdatableArray)

isImmutable

public boolean isImmutable()

This implementation returns false.

Specified by:

isImmutable in interface Array

Overrides:

isImmutable in class AbstractObjectArray<E>

Returns:

true if this instance is immutable.

See Also:

• Array.asImmutable()

asImmutable

public ObjectArray<E> asImmutable()

This implementation returns an instance of the subclass of AbstractObjectArray, where the following method are overridden and call the same methods of this instance: AbstractObjectArray.get(long), AbstractObjectArray.getData(long, Object, int, int), AbstractObjectArray.getData(long, Object), AbstractObjectArray.loadResources(ArrayContext, long, long), AbstractObjectArray.flushResources(ArrayContext, long, long, boolean) and AbstractObjectArray.freeResources(ArrayContext, long, long, boolean).

The returned instance also have overridden method AbstractArray.isLazy(), that just calls the same methods of this instance with the same arguments.

Specified by:

asImmutable in interface Array

Specified by:

asImmutable in interface ObjectArray<E>

Overrides:

asImmutable in class AbstractObjectArray<E>

Returns:

an immutable view of this array.

See Also:

• Array.isImmutable()
• Array.asTrustedImmutable()
• Array.mutableClone(MemoryModel)
• Array.updatableClone(MemoryModel)
• UpdatableArray.asUnresizable()

shallowClone

public UpdatableArray shallowClone()

This implementation returns (UpdatableArray)super.shallowClone().

Specified by:

shallowClone in interface Array

Specified by:

shallowClone in interface UpdatableArray

Overrides:

shallowClone in class AbstractArray

Returns:

a shallow copy of this object.

See Also:

• Array.length()
• Array.capacity()
• DirectAccessible.javaArrayOffset()
• Array.isCopyOnNextWrite()

setElement

public void setElement(long index,
 Object value)

This implementation calls set(index, value).

Specified by:

setElement in interface UpdatableArray

Parameters:

index - index of element to replace.

value - element to be stored at the specified position.

Throws:

IndexOutOfBoundsException - if index is out of range 0..length()-1.

NullPointerException - if value == null and it is an array of primitive elements

ClassCastException - if it is an array of primitive elements and value is not a corresponding wrapped class (Boolean, Integer, etc.)

ArrayStoreException - if it is an array of non-primitive elements and value is not an instance of AbstractObjectArray.elementType() class

setData

public UpdatableArray setData(long arrayPos,
 Object srcArray,
 int srcArrayOffset,
 int count)

This implementation is based on a loop of calls of set(long, Object) method. Please override this method if it's possible to perform the same task more efficiently than such a loop.

Specified by:

setData in interface UpdatableArray

Parameters:

arrayPos - starting position in this AlgART array.

srcArray - the source Java array.

srcArrayOffset - starting position in the source Java array.

count - the number of elements to be copied.

Returns:

a reference to this AlgART array.

Throws:

NullPointerException - if srcArray argument is null.

IllegalArgumentException - if srcArray argument is not an array.

IndexOutOfBoundsException - if copying would cause access of data outside this array or source Java array.

ArrayStoreException - if destArray element type mismatches with this array elementType().

ClassCastException - if destArray element type mismatches with this array elementType() (both this and ArrayStoreException are possible, depending on implementation).

See Also:

• DirectAccessible
• Array.getData(long, Object, int, int)

setData

public UpdatableArray setData(long arrayPos,
 Object srcArray)

This implementation calls setData(long, Object, int, int) with corresponding arguments.

Specified by:

setData in interface UpdatableArray

Parameters:

arrayPos - starting position in this AlgART array.

srcArray - the source Java array.

Returns:

a reference to this AlgART array.

Throws:

NullPointerException - if srcArray argument is null.

IllegalArgumentException - if srcArray argument is not an array.

IndexOutOfBoundsException - if copying would cause access of data outside this array or source Java array.

ArrayStoreException - if destArray element type mismatches with this array AbstractObjectArray.elementType().

ClassCastException - if destArray element type mismatches with this array AbstractObjectArray.elementType() (both this and ArrayStoreException are possible, depending on implementation).

See Also:

• DirectAccessible
• UpdatableArray.setData(long, Object, int, int)
• Array.getData(long, Object)
• UpdatableBitArray.setBits(long, long[], long, long)

copy

public void copy(long destIndex,
 long srcIndex)

This implementation calls set(destIndex, get(srcIndex)).

Specified by:

copy in interface UpdatableArray

Parameters:

destIndex - index of element to replace.

srcIndex - index of element to be copied.

Throws:

IndexOutOfBoundsException - if one of indexes is out of range 0..length()-1.

copy

public void copy(long destIndex,
 long srcIndex,
 long count)

This implementation is based on a loop of calls of copy(long, long) method.

Specified by:

copy in interface UpdatableArray

Parameters:

destIndex - starting index of element to replace.

srcIndex - starting index of element to be copied.

count - the number of elements to be copied.

Throws:

IndexOutOfBoundsException - if one of indexes is out of range 0..length()-1.

swap

public void swap(long firstIndex,
 long secondIndex)

This implementation swaps two elements by AbstractObjectArray.get(long) and set(long, Object) methods.

Specified by:

swap in interface ArrayExchanger

Specified by:

swap in interface UpdatableArray

Parameters:

firstIndex - first index of element to exchange.

secondIndex - second index of element to exchange.

Throws:

IndexOutOfBoundsException - if one of indexes is out of range 0..length()-1.

swap

public void swap(long firstIndex,
 long secondIndex,
 long count)

This implementation is based on a loop of calls of swap(long, long) method.

Specified by:

swap in interface UpdatableArray

Parameters:

firstIndex - starting first index of element to exchange.

secondIndex - starting second index of element to exchange.

count - the number of elements to be exchanged.

Throws:

IndexOutOfBoundsException - if one of indexes is out of range 0..length()-1.

copy

public UpdatableArray copy(Array src)

This implementation calls defaultCopy(thisInstance, src).

Specified by:

copy in interface UpdatableArray

Parameters:

src - the source array.

Returns:

a reference to this array.

Throws:

NullPointerException - if src argument is null.

IllegalArgumentException - if the source and this element types do not match.

See Also:

• Arrays.copy(ArrayContext, UpdatableArray, Array)

swap

public UpdatableArray swap(UpdatableArray another)

This implementation calls defaultSwap(thisInstance, another).

Specified by:

swap in interface UpdatableArray

Parameters:

another - another array.

Returns:

a reference to this array.

Throws:

NullPointerException - if another argument is null.

IllegalArgumentException - if another and this element types do not match.

setNonNew

public void setNonNew()

This implementation calls setNewStatus(false).

Specified by:

setNonNew in interface UpdatableArray

asCopyOnNextWrite

public UpdatableArray asCopyOnNextWrite()

This implementation returns updatableClone(Arrays.SMM).

Specified by:

asCopyOnNextWrite in interface Array

Specified by:

asCopyOnNextWrite in interface UpdatableArray

Overrides:

asCopyOnNextWrite in class AbstractObjectArray<E>

Returns:

a copy of this object.

See Also:

• Array.isCopyOnNextWrite()
• MemoryModel.newLazyCopy(Array)
• MemoryModel.newUnresizableLazyCopy(Array)

asUnresizable

public UpdatableObjectArray<E> asUnresizable()

This implementation returns this object. Should be overridden if the inheritor is resizable.

Specified by:

asUnresizable in interface UpdatableArray

Specified by:

asUnresizable in interface UpdatableObjectArray<E>

Returns:

an unresizable view of this array.

See Also:

• Array.isUnresizable()

cast

public <D> UpdatableObjectArray<D> cast(Class<D> elementType)

Description copied from interface: ObjectArray

Returns this array cast to the specified generic element type or throws ClassCastException if the elements cannot be cast to the required type (because the element type is not its subclass). Equivalent to (ObjectArray)thisArray, but is compiled without "unchecked cast" warning or "inconvertible type" error.

Unlike ArrayList architecture, such casting is safe here, because all methods, storing data in the AlgART array, always check the element type and do not allow saving illegal elements.

Specified by:

cast in interface ObjectArray<E>

Specified by:

cast in interface UpdatableObjectArray<E>

Overrides:

cast in class AbstractObjectArray<E>

Parameters:

elementType - the required generic type.

Returns:

this array cast to the specified generic element type.

toString

public String toString()

Description copied from interface: Array

Returns a brief string description of this object.

The result of this method may depend on implementation and usually contains a short description of the array length, capacity, element type.

Note: for character arrays, unlike CharSequence.toString(), this method works as for all other array types. If you need to convert a character array to a string, containing all characters of the array, you may use Arrays.toString(CharArray) method.

Specified by:

toString in interface Array

Overrides:

toString in class AbstractObjectArray<E>

Returns:

a brief string description of this object.