org.ObjectLayout

Class PrimitiveCharArray

java.lang.Object

org.ObjectLayout.AbstractPrimitiveArray

org.ObjectLayout.PrimitiveCharArray

public class PrimitiveCharArray
extends AbstractPrimitiveArray

A subclassable array of chars. PrimitiveCharArray 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
PrimitiveCharArray() Default constructor
PrimitiveCharArray(PrimitiveCharArray sourceArray) Copying constructor

Method Summary

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

PrimitiveCharArray

public PrimitiveCharArray()

Default constructor

PrimitiveCharArray

public PrimitiveCharArray(PrimitiveCharArray sourceArray)

Copying constructor

Parameters:

sourceArray - the array to copy

Method Detail

asArray

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

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

Returns:

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

Throws:

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

getLength

public long getLength()

Get the length of the array

Returns:

the length of the array

get

public char 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 char 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,
                char 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,
                char 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 PrimitiveCharArray newInstance(long length)

Create a new instance of PrimitiveCharArray with a given length.

Parameters:

length - the length of the array.

Returns:

a new instance of PrimitiveCharArray with the given length

newInstance

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

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

Type Parameters:

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

Parameters:

arrayClass - The class of the array to be created (extends PrimitiveCharArray)

length - the length of the array.

Returns:

a new instance of <A extends PrimitiveCharArray> with a given length

newInstance

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

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

Type Parameters:

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

Parameters:

lookup - The lookup object to use for accessing the arrayClass constructor

arrayClass - The class of the array to be created (extends PrimitiveCharArray)

length - the length of the array.

Returns:

a new instance of <A extends PrimitiveCharArray> with a given length

newInstance

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

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

Type Parameters:

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

Parameters:

length - The length of the array.

arrayCtorAndArgs - for creating the array

Returns:

a new instance of <A extends PrimitiveCharArray>

newInstance

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

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

Type Parameters:

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

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 PrimitiveCharArray>

copyInstance

public static <A extends PrimitiveCharArray> A copyInstance(A source)
                                                     throws java.lang.NoSuchMethodException

Create a new <A extends PrimitiveCharArray> 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 PrimitiveCharArray)

Parameters:

source - The array to replicate

Returns:

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

Throws:

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

copyInstance

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

Create a new <A extends PrimitiveCharArray> 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 PrimitiveCharArray)

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 PrimitiveCharArray> copied from the source array

Throws:

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