com.lhkbob.entreri.property

Interface ShareableProperty<T>

Type Parameters:

T - The type stored by the property

All Superinterfaces:

Property

public interface ShareableProperty<T>
extends Property

ShareableProperty designates a special type of property that can mutate a shared instance to a specific component's value, instead of returning internal references. Often, shareable properties are capable of actually unpacking the type into primitive arrays and restoring the value into the shared instance for improved cache coherence.

Because simple primitives cannot be shared, ShareableProperty declares the required methods using generics.

Author:

Michael Ludwig

Method Summary

Methods

Modifier and Type	Method and Description
T	createShareableInstance() Create a new instance of type T for use by components that need a shareable instance to pass into get(int, Object).
void	get(int index, T result) Get the property value at index, but instead of returning a new instance or the value, the result parameter is mutated to equal the property value.

Methods inherited from interface com.lhkbob.entreri.property.Property

getCapacity, setCapacity, swap

Method Detail

createShareableInstance

T createShareableInstance()

Create a new instance of type T for use by components that need a shareable instance to pass into get(int, Object).

Returns:

A new instance of type T

get

void get(int index,
       T result)

Get the property value at index, but instead of returning a new instance or the value, the result parameter is mutated to equal the property value. It can be assumed the instance was previously created by a call to createShareableInstance().

Parameters:

index - The index to access

result - The instance of T to modify