org.ObjectLayout

Class ConstructionContext<T>

java.lang.Object

org.ObjectLayout.ConstructionContext<T>

public class ConstructionContext<T>
extends java.lang.Object

The construction context for object instantiated within a StructuredArray

Constructor Summary

Constructors

Constructor and Description
ConstructionContext(java.lang.Object cookie)

Method Summary

Modifier and Type	Method and Description
StructuredArray<T>	getArray() Get the immediately containing StructuredArray.
ConstructionContext<StructuredArray<T>>	getContainingContext() Get the containing context.
java.lang.Object	getContextCookie() Get the construction context cookie object.The construction context cookie of the outermost array is taken from the (optionally supplied) StructuredArrayBuilder used in instantiating the array (via StructuredArrayBuilder.getContextCookie()).
long	getIndex() Get the index (of the element being constructed) in the immediately containing StructuredArray.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConstructionContext

public ConstructionContext(java.lang.Object cookie)

Method Detail

getIndex

public long getIndex()

Get the index (of the element being constructed) in the immediately containing StructuredArray.

Returns:

The index in the immediately containing StructuredArray

getArray

public StructuredArray<T> getArray()

Get the immediately containing StructuredArray.

Returns:

the immediately containing StructuredArray

getContainingContext

public ConstructionContext<StructuredArray<T>> getContainingContext()

Get the containing context. The containing context will be non-null if the array this context relates to is nested in another StructuredArray.

Returns:

the containing context

getContextCookie

public java.lang.Object getContextCookie()

Get the construction context cookie object.The construction context cookie of the outermost array is taken from the (optionally supplied) StructuredArrayBuilder used in instantiating the array (via StructuredArrayBuilder.getContextCookie()). The construction context cookie for nested arrays (if those exist) is taken from the CtorAndArgs used to construct the nested array, such that a CtorAndArgsProvider can receive and propagate an appropriate contextCookie. A good example of context cookie in use can be found in the implementation of CopyCtorAndArgsProvider.

Returns:

the construction context cookie