net.openhft.chronicle.values

Class ValueModel

java.lang.Object

net.openhft.chronicle.values.ValueModel

public class ValueModel
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static String	$$HEAP
static String	$$NATIVE

Method Summary

Modifier and Type	Method and Description
static ValueModel	acquire(Class<?> valueType) Returns a ValueModel for the given valueType, if the latter is a value interface, or if it the heap or native implementation for some value interface, returns the ValueModel for that value interface.
Stream<net.openhft.chronicle.values.FieldModel>	fields()
Class<?>	heapClass() Generates (if not yet) and returns a heap implementation for this ValueModel.
Class<?>	nativeClass() Generates (if not yet) and returns a native (flyweight) implementation for this ValueModel.
int	recommendedOffsetAlignment() Returns the recommended alignment of a flyweight bytes offset, to satisfy alignments of all the fields.
int	sizeInBytes()

Methods inherited from class java.lang.Object

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

Field Detail

$$NATIVE

public static final String $$NATIVE

See Also:

Constant Field Values

$$HEAP

public static final String $$HEAP

See Also:

Constant Field Values

Method Detail

acquire

public static ValueModel acquire(Class<?> valueType)

Returns a ValueModel for the given valueType, if the latter is a value interface, or if it the heap or native implementation for some value interface, returns the ValueModel for that value interface.

Parameters:

valueType - a value interface or the heap or native implementation class for some value interface

Returns:

a ValueModel for the given value interface, or if the given valueType is the heap or native implementation for some value interface, returns the ValueModel of that value interface

Throws:

IllegalArgumentException - if the given valueType is not a value interface, or the heap or native implementation of some value interface, or the Chronicle Values library is not able to construct a ValueModel from this interface

fields

public Stream<net.openhft.chronicle.values.FieldModel> fields()

recommendedOffsetAlignment

public int recommendedOffsetAlignment()

Returns the recommended alignment of a flyweight bytes offset, to satisfy alignments of all the fields. It is the most coarse among all of it's fields' offset and don't cross alignments.

Returns a positive integer >= 1.

Returns:

the alignment of the flyweight value itself, to satisfy fields' alignments

sizeInBytes

public int sizeInBytes()

nativeClass

public Class<?> nativeClass()

Generates (if not yet) and returns a native (flyweight) implementation for this ValueModel.

Returns:

a native (flyweight) implementation for this ValueModel

Throws:

ImplGenerationFailedException - if generation failed

heapClass

public Class<?> heapClass()

Generates (if not yet) and returns a heap implementation for this ValueModel.

Returns:

a heap implementation for this ValueModel

Throws:

ImplGenerationFailedException - if generation failed