org.ObjectLayout

Class PrimitiveArrayBuilder<S extends AbstractPrimitiveArray>

java.lang.Object

org.ObjectLayout.PrimitiveArrayBuilder<S>

Type Parameters:

S - The class of the PrimitiveArray that is to be instantiated by the builder

public class PrimitiveArrayBuilder<S extends AbstractPrimitiveArray>
extends java.lang.Object

A builder used for instantiating a AbstractPrimitiveArray<T>

PrimitiveArrayBuilder follows the commonly used builder pattern, and is useful for capturing the instantiation parameters of StructuredArrays.

PrimitiveArrayBuilders can be created for "flat" and "nested" StructuredArray constructs, and can range from the simplest forms used when default constructors are employed, to forms that supply customized per-element construction arguments that can take construction context (such as index, containing array, and arbitrary data passed in a contextCookie) into account.

A simple example of using a PrimitiveArrayBuilder to instantiate a PrimitiveLongArray is:

 StructuredArray<MyElementClass> array =
      new PrimitiveArrayBuilder(PrimitiveLongArray.class, length).
          build();
 

An example of passing specific construction arguments to the array constructor is:

 Constructor<MyArrayClass> constructor = MyArrayClass.class.getConstructor(int.Class, int.Class);

 StructuredArray<MyElementClass> array =
      new PrimitiveArrayBuilder(
          MyArrayClass.class,
          length).
          arrayCtorAndArgs(constructor, initArg1, initArg2).
          build();
 

Constructor Summary

Constructors

Constructor and Description
PrimitiveArrayBuilder(java.lang.Class<S> arrayClass, long length) Constructs a new PrimitiveArrayBuilder object for creating arrays of type S with the given length.

Method Summary

Modifier and Type	Method and Description
PrimitiveArrayBuilder<S>	arrayCtorAndArgs(java.lang.reflect.Constructor<S> constructor, java.lang.Object... args) Set the Constructor and construction arguments to be used in constructing arrays.
PrimitiveArrayBuilder<S>	arrayCtorAndArgs(CtorAndArgs<S> arrayCtorAndArgs) Set the CtorAndArgs to be used in constructing arrays.
S	build() Build a AbstractPrimitiveArray according to the information captured in this builder
CtorAndArgs<S>	getArrayCtorAndArgs() Get the CtorAndArgs describing the constructor and arguments used to instantiate arrays with this builder.
PrimitiveArrayModel<S>	getArrayModel() Get the PrimitiveArrayModel that describes the arrays built by this builder
PrimitiveArrayBuilder<S>	resolve() Resolve any not-yet-resolved constructor information needed by this builder.

Methods inherited from class java.lang.Object

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

Constructor Detail

PrimitiveArrayBuilder

public PrimitiveArrayBuilder(java.lang.Class<S> arrayClass,
                             long length)

Constructs a new PrimitiveArrayBuilder object for creating arrays of type S with the given length.

Parameters:

arrayClass - The class of the array to be built by this builder

length - The length of the array to be build by this builder

Method Detail

arrayCtorAndArgs

public PrimitiveArrayBuilder<S> arrayCtorAndArgs(CtorAndArgs<S> arrayCtorAndArgs)

Set the CtorAndArgs to be used in constructing arrays. Setting the means for array construction is Required if the array class (S) does not support a default constructor, or if a non-default construction of the array instance is needed.

Parameters:

arrayCtorAndArgs - The constructor and arguments used for constructing arrays

Returns:

The builder

arrayCtorAndArgs

public PrimitiveArrayBuilder<S> arrayCtorAndArgs(java.lang.reflect.Constructor<S> constructor,
                                                 java.lang.Object... args)

Set the Constructor and construction arguments to be used in constructing arrays. Setting the means for array construction is Required if the array class (S) does not support a default constructor, or if a non-default construction of the array instance is needed.

Parameters:

constructor - The constructor used for constructing arrays

args - The construction arguments supplied for the constructor

Returns:

The builder

resolve

public PrimitiveArrayBuilder<S> resolve()
                                 throws java.lang.NoSuchMethodException

Resolve any not-yet-resolved constructor information needed by this builder. Calling resolve() is not necessary ahead of building, but it is useful for ensuring resolution works ahead of actual building attempts.

Returns:

This builder

Throws:

java.lang.NoSuchMethodException - if the array constructor or element constructor fail to resolve given the current information in the builder

build

public S build()
        throws java.lang.NoSuchMethodException

Build a AbstractPrimitiveArray according to the information captured in this builder

Returns:

A newly instantiated AbstractPrimitiveArray

Throws:

java.lang.NoSuchMethodException - if the array constructor or element constructor fail to resolve given the current information in the builder

getArrayModel

public PrimitiveArrayModel<S> getArrayModel()

Get the PrimitiveArrayModel that describes the arrays built by this builder

Returns:

The PrimitiveArrayModel that describes the arrays built by this builder

getArrayCtorAndArgs

public CtorAndArgs<S> getArrayCtorAndArgs()

Get the CtorAndArgs describing the constructor and arguments used to instantiate arrays with this builder. May be null if non of arrayCtorAndArgs, resolve() or build() have been called yet.

Returns:

The CtorAndArgs describing the constructor and arguments used to instantiate arrays with this builder.