org.ObjectLayout

Class ReferenceArray<T>

java.lang.Object

org.ObjectLayout.AbstractPrimitiveArray

org.ObjectLayout.ReferenceArray<T>

Type Parameters:

T - The reference type

public class ReferenceArray<T>
extends AbstractPrimitiveArray

A subclassable array of object references. ReferenceArray is designed with semantics specifically chosen and restricted such that a "flat" memory layout of the implemented data structure would be possible on optimizing JVMs. While fully functional on all JVM implementation (of Java SE 6 and above), the semantics are such that a JVM may transparently optimise the implementation to provide a compact contiguous layout that facilitates dead-reckoning (as opposed to de-referenced) access to elements

Constructor Summary

Constructors

Constructor and Description
ReferenceArray() Default constructor
ReferenceArray(ReferenceArray<T> sourceArray) Copy constructor

Method Summary

Modifier and Type	Method and Description
T[]	asArray() Get a reference to a T[] that represents the contents of this array.
static <T,A extends ReferenceArray<T>> A	copyInstance(A source) Create a new <A extends ReferenceArray<T>> instance, using a copy constructor to replicate the contents of the given source array
static <T,A extends ReferenceArray<T>> A	copyInstance(java.lang.invoke.MethodHandles.Lookup lookup, A source) Create a new <A extends ReferenceArray<T>> instance, using a copy constructor to replicate the contents of the given source array
T	get(int index) Get the value of an element in the array.
T	get(long index) Get the value of an element in the array.
long	getLength() Get the length of the array
static <T,A extends ReferenceArray<T>> A	newInstance(java.lang.Class<A> arrayClass, long length) Create a new instance of <A extends ReferenceArray<T>> with a given length.
static <A extends ReferenceArray> A	newInstance(CtorAndArgs<A> arrayCtorAndArgs, long length) Create a new instance of <A extends ReferenceArray> with a given length, array constructor, and array constructor arguments.
static <T> ReferenceArray<T>	newInstance(long length) Create a new instance of ReferenceArray<T> with a given length.
static <T,A extends ReferenceArray<T>> A	newInstance(long length, java.lang.reflect.Constructor<A> arrayConstructor, java.lang.Object... arrayConstructorArgs) Create a new instance of <A extends ReferenceArray<T>> with a given length, array constructor, and array constructor arguments.
static <T,A extends ReferenceArray<T>> A	newInstance(java.lang.invoke.MethodHandles.Lookup lookup, java.lang.Class<A> arrayClass, long length) Create a new instance of <A extends ReferenceArray<T>> with a given length.
void	set(int index, T value) set the value of an element in the array.
void	set(long index, T value) set the value of an element in the array.

Methods inherited from class java.lang.Object

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

Constructor Detail

ReferenceArray

public ReferenceArray()

Default constructor

ReferenceArray

public ReferenceArray(ReferenceArray<T> sourceArray)

Copy constructor

Parameters:

sourceArray - the array to copy

Method Detail

asArray

public T[] asArray()
            throws java.lang.IllegalStateException

Get a reference to a T[] that represents the contents of this array. Will throw an exception if array is too long to represent as a T[].

Returns:

a reference to a T[] that represents the contents of this array

Throws:

java.lang.IllegalStateException - if array is too long to represent as a T[]

getLength

public long getLength()

Get the length of the array

Returns:

the length of the array

get

public T get(int index)

Get the value of an element in the array.

Parameters:

index - the index of the element

Returns:

the value of the element at the given index

get

public T get(long index)

Get the value of an element in the array.

Parameters:

index - the index of the element

Returns:

the value of the element at the given index

set

public void set(int index,
                T value)

set the value of an element in the array.

Parameters:

index - the index of the element to set

value - the value to assign to the element

set

public void set(long index,
                T value)

set the value of an element in the array.

Parameters:

index - the index of the element to set

value - the value to assign to the element

newInstance

public static <T> ReferenceArray<T> newInstance(long length)

Create a new instance of ReferenceArray<T> with a given length.

Type Parameters:

T - the reference type

Parameters:

length - the length of the array

Returns:

A newly created ReferenceArray<T>

newInstance

public static <T,A extends ReferenceArray<T>> A newInstance(java.lang.Class<A> arrayClass,
                                                            long length)

Create a new instance of <A extends ReferenceArray<T>> with a given length.

Type Parameters:

T - the reference type

A - The class of the array to be created (extends ReferenceArray<T>)

Parameters:

arrayClass - The class of the array to be created (extends ReferenceArray<T>)

length - the length of the array.

Returns:

a new instance of <A extends ReferenceArray<T>> with a given length

newInstance

public static <T,A extends ReferenceArray<T>> A newInstance(java.lang.invoke.MethodHandles.Lookup lookup,
                                                            java.lang.Class<A> arrayClass,
                                                            long length)

Create a new instance of <A extends ReferenceArray<T>> with a given length.

Type Parameters:

T - the reference type

A - The class of the array to be created (extends ReferenceArray<T>)

Parameters:

lookup - The lookup object to use for accessing the array's constructor

arrayClass - The class of the array to be created (extends ReferenceArray<T>)

length - the length of the array.

Returns:

a new instance of <A extends ReferenceArray<T>> with a given length

newInstance

public static <A extends ReferenceArray> A newInstance(CtorAndArgs<A> arrayCtorAndArgs,
                                                       long length)

Create a new instance of <A extends ReferenceArray> with a given length, array constructor, and array constructor arguments.

Type Parameters:

A - The class of the array to be created (extends ReferenceArray)

Parameters:

length - The length of the array.

arrayCtorAndArgs - for creating the array

Returns:

a new instance of <A extends ReferenceArray>

newInstance

public static <T,A extends ReferenceArray<T>> A newInstance(long length,
                                                            java.lang.reflect.Constructor<A> arrayConstructor,
                                                            java.lang.Object... arrayConstructorArgs)

Create a new instance of <A extends ReferenceArray<T>> with a given length, array constructor, and array constructor arguments.

Type Parameters:

T - the reference type

A - The class of the array to be created (extends ReferenceArray<T>)

Parameters:

length - The length of the array.

arrayConstructor - The array constructor to use

arrayConstructorArgs - The arguments to pass to the array constructor

Returns:

a new instance of <A extends ReferenceArray<T>>

copyInstance

public static <T,A extends ReferenceArray<T>> A copyInstance(A source)
                                                      throws java.lang.NoSuchMethodException

Create a new <A extends ReferenceArray<T>> instance, using a copy constructor to replicate the contents of the given source array

Type Parameters:

A - The class of the array to be created (extends ReferenceArray<T>)

T - The class of the element in the array to be created

Parameters:

source - The array to replicate

Returns:

a new instance of <A extends ReferenceArray<T>> copied from the source array

Throws:

java.lang.NoSuchMethodException - if <A> does not have a copy constructor

copyInstance

public static <T,A extends ReferenceArray<T>> A copyInstance(java.lang.invoke.MethodHandles.Lookup lookup,
                                                             A source)
                                                      throws java.lang.NoSuchMethodException

Create a new <A extends ReferenceArray<T>> instance, using a copy constructor to replicate the contents of the given source array

Type Parameters:

A - The class of the array to be created (extends ReferenceArray<T>)

T - The class of the element in the array to be created

Parameters:

lookup - The lookup object to use for accessing the array's constructor

source - The array to replicate

Returns:

a new instance of <A extends ReferenceArray<T>> copied from the source array

Throws:

java.lang.NoSuchMethodException - if <A> does not have a copy constructor