com.lhkbob.entreri.property

Class ObjectProperty.Factory

java.lang.Object

com.lhkbob.entreri.property.ObjectProperty.Factory

All Implemented Interfaces:

PropertyFactory<ObjectProperty>

Enclosing class:

ObjectProperty

public static class ObjectProperty.Factory
extends Object
implements PropertyFactory<ObjectProperty>

Factory to create ObjectProperties.

Author:

Michael Ludwig

Constructor Summary

Constructors

Constructor and Description
ObjectProperty.Factory(Attributes attrs)
ObjectProperty.Factory(Clone.Policy policy)

Method Summary

Methods

Modifier and Type	Method and Description
void	clone(ObjectProperty src, int srcIndex, ObjectProperty dst, int dstIndex) Copy the value from src at component index, srcIndex to dst at dstIndex.
ObjectProperty	create() Return a new Property instance.
void	setDefaultValue(ObjectProperty property, int index) Set the default value that the component at the specified index will see before it's init() method is invoked.

Methods inherited from class java.lang.Object

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

Constructor Detail

ObjectProperty.Factory

public ObjectProperty.Factory(Attributes attrs)

ObjectProperty.Factory

public ObjectProperty.Factory(Clone.Policy policy)

Method Detail

create

public ObjectProperty create()

Description copied from interface: PropertyFactory

Return a new Property instance. This must be a new instance that has not been returned previously or the entity framework will have undefined behavior.

Specified by:

create in interface PropertyFactory<ObjectProperty>

Returns:

A new Property of type T

setDefaultValue

public void setDefaultValue(ObjectProperty property,
                   int index)

Description copied from interface: PropertyFactory

Set the default value that the component at the specified index will see before it's init() method is invoked. In some cases, this could be used in-place of initializing in init() method.

Specified by:

setDefaultValue in interface PropertyFactory<ObjectProperty>

Parameters:

property - The property whose value will be updated

index - The component index to be updated

clone

public void clone(ObjectProperty src,
         int srcIndex,
         ObjectProperty dst,
         int dstIndex)

Description copied from interface: PropertyFactory

Copy the value from src at component index, srcIndex to dst at dstIndex. This is used when a component is created and cloned from a template with Entity.add(com.lhkbob.entreri.Component). For many cases a plain copy-by-value or copy-by-reference is sufficient, but some component types might require more complicated cloning rules.

Specified by:

clone in interface PropertyFactory<ObjectProperty>

Parameters:

src - The source property that is being cloned

srcIndex - The index into src of the component being cloned

dst - The destination property created from the template

dstIndex - The index into dst of the component being created