com.oracle.truffle.api.object

Class Layout

java.lang.Object

com.oracle.truffle.api.object.Layout

public abstract class Layout
extends Object

Describes layout and behavior of a DynamicObject subclass and is used to create shapes. An object may change its shape but only to shapes of the same layout.

Since:

0.8 or earlier

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	Layout.Access Internal package access helper.
static class	Layout.Builder Layout builder.
static class	Layout.ImplicitCast Specifies the allowed implicit casts between primitive types without losing type information.

Field Summary

Fields

Modifier and Type	Field and Description
static String	OPTION_PREFIX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Layout() Constructor for subclasses.

Method Summary

Modifier and Type	Method and Description
abstract Shape.Allocator	createAllocator() Create an allocator for static property creation.
static Layout	createLayout() Equivalent to Layout.newLayout().build().
abstract Shape	createShape(ObjectType objectType) Create a root shape.
abstract Shape	createShape(ObjectType objectType, Object sharedData) Create a root shape.
abstract Shape	createShape(ObjectType objectType, Object sharedData, int id) Create a root shape.
protected static EnumSet<Layout.ImplicitCast>	getAllowedImplicitCasts(Layout.Builder builder)
protected static LayoutFactory	getFactory()
protected static boolean	getPolymorphicUnboxing(Layout.Builder builder)
abstract Class<? extends DynamicObject>	getType()
abstract DynamicObject	newInstance(Shape shape)
static Layout.Builder	newLayout() Creates a new Layout.Builder.

Methods inherited from class java.lang.Object

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

Field Detail

OPTION_PREFIX

public static final String OPTION_PREFIX

Since:

0.8 or earlier

See Also:

Constant Field Values

Constructor Detail

Layout

protected Layout()

Constructor for subclasses.

Since:

0.8 or earlier

Method Detail

newLayout

public static Layout.Builder newLayout()

Creates a new Layout.Builder.

Since:

0.8 or earlier

createLayout

public static Layout createLayout()

Equivalent to Layout.newLayout().build().

Since:

0.8 or earlier

newInstance

public abstract DynamicObject newInstance(Shape shape)

Since:

0.8 or earlier

getType

public abstract Class<? extends DynamicObject> getType()

Since:

0.8 or earlier

createShape

public abstract Shape createShape(ObjectType objectType)

Create a root shape.

Parameters:

objectType - that describes the object instance with this shape.

Since:

0.8 or earlier

createShape

public abstract Shape createShape(ObjectType objectType,
                                  Object sharedData)

Create a root shape.

Parameters:

objectType - that describes the object instance with this shape.

sharedData - for language-specific use

Since:

0.8 or earlier

createShape

public abstract Shape createShape(ObjectType objectType,
                                  Object sharedData,
                                  int id)

Create a root shape.

Parameters:

objectType - that describes the object instance with this shape.

sharedData - for language-specific use

id - for language-specific use

Returns:

new instance of a shape

Since:

0.8 or earlier

createAllocator

public abstract Shape.Allocator createAllocator()

Create an allocator for static property creation. Reserves all array extension slots.

Since:

0.8 or earlier

getFactory

protected static LayoutFactory getFactory()

Since:

0.8 or earlier

getAllowedImplicitCasts

protected static EnumSet<Layout.ImplicitCast> getAllowedImplicitCasts(Layout.Builder builder)

Since:

0.8 or earlier

getPolymorphicUnboxing

protected static boolean getPolymorphicUnboxing(Layout.Builder builder)

Since:

0.8 or earlier