com.lhkbob.entreri.property

Class ObjectProperty

java.lang.Object

com.lhkbob.entreri.property.ObjectProperty

All Implemented Interfaces:

Property

public final class ObjectProperty
extends Object
implements Property

ObjectProperty is an implementation of Property that stores the property data as a number of packed Object references for each property. Because it is not primitive data, cache locality will suffer compared to the primitive property types, but it will allow you to store arbitrary objects.

However, ObjectProperty assumes that all component values can be null, and the default value is null. If this is not an acceptable contract then a custom property must be defined with a factory capable of constructing proper default instances.

Author:

Michael Ludwig

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ObjectProperty.Factory Factory to create ObjectProperties.

Constructor Summary

Constructors

Constructor and Description
ObjectProperty() Create an ObjectProperty.

Method Summary

Methods

Modifier and Type	Method and Description
static PropertyFactory<ObjectProperty>	factory(Clone.Policy policy) Return a PropertyFactory that creates ObjectProperties using the given cloning policy.
Object	get(int componentIndex) Get the value stored in this property for the given component index.
int	getCapacity() Get the current capacity of the property.
Object[]	getIndexedData() Return the backing int array of this property's IndexedDataStore.
void	set(int componentIndex, Object val) Store val in this property for the given component index.
void	setCapacity(int size) Resize the internal storage to support indexed lookups from 0 to size - 1.
void	swap(int a, int b) Swap the value at indexA with indexB.

Methods inherited from class java.lang.Object

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

Constructor Detail

ObjectProperty

public ObjectProperty()

Create an ObjectProperty.

Method Detail

factory

public static PropertyFactory<ObjectProperty> factory(Clone.Policy policy)

Return a PropertyFactory that creates ObjectProperties using the given cloning policy.

Returns:

A PropertyFactory for ObjectProperty

getIndexedData

public Object[] getIndexedData()

Return the backing int array of this property's IndexedDataStore. The array may be longer than necessary for the number of components in the system. Data can be accessed for a component directly using the component's index.

Returns:

The Object data for all packed properties that this property has been packed with

get

public Object get(int componentIndex)

Get the value stored in this property for the given component index.

Parameters:

componentIndex - The component's index

Returns:

The object at the given offset for the given component

Throws:

ArrayIndexOutOfBoundsException - if the componentIndex is invalid

set

public void set(int componentIndex,
       Object val)

Store val in this property for the given component index.

Parameters:

componentIndex - The index of the component being modified

val - The value to store, can be null

Throws:

ArrayIndexOutOfBoundsException - if the componentIndex is invalid

swap

public void swap(int a,
        int b)

Description copied from interface: Property

Swap the value at indexA with indexB.

This is for internal use only to manage, and should not be called on decorated properties returned by EntitySystem.decorate(Class, PropertyFactory).

Specified by:

swap in interface Property

Parameters:

a - The index of the first value

b - The index of the second value

getCapacity

public int getCapacity()

Description copied from interface: Property

Get the current capacity of the property. All instances must start with a capacity of at least 1. The capacity represents the number of component instances the property can handle. If a component property is decomposed into multiple primitives that is still a single value instance when considering the capacity.

This is for internal use only to manage, and should not be called on decorated properties returned by EntitySystem.decorate(Class, PropertyFactory).

Specified by:

getCapacity in interface Property

Returns:

The current capacity of the property

setCapacity

public void setCapacity(int size)

Description copied from interface: Property

Resize the internal storage to support indexed lookups from 0 to size - 1. If >size is less than the current capacity, all previous values with an index less than size must be preserved, and the remainder are discarded. If size is greater than the current capacity, all previous indexed values must be preserved and the new values can be undefined.

This is for internal use only to manage, and should not be called on decorated properties returned by EntitySystem.decorate(Class, PropertyFactory).

Specified by:

setCapacity in interface Property

Parameters:

size - The new capacity, will be at least 1