com.artemis

Class ComponentMapper<A extends Component>

java.lang.Object

com.artemis.ComponentMapper<A>

public abstract class ComponentMapper<A extends Component>
extends Object

Constructor Summary

Constructors

Constructor and Description
ComponentMapper()

Method Summary

Methods

Modifier and Type	Method and Description
abstract A	get(Entity e) Fast but unsafe retrieval of a component for this entity.
abstract A	get(Entity e, boolean forceNewInstance) Fast but unsafe retrieval of a component for this entity.
static <T extends Component> ComponentMapper<T>	getFor(Class<T> type, World world) Returns a component mapper for this type of components.
abstract A	getSafe(Entity e) Fast and safe retrieval of a component for this entity.
abstract A	getSafe(Entity e, boolean forceNewInstance) Fast and safe retrieval of a component for this entity.
abstract boolean	has(Entity e) Checks if the entity has this type of component.

Methods inherited from class java.lang.Object

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

Constructor Detail

ComponentMapper

public ComponentMapper()

Method Detail

get

public abstract A get(Entity e)
                                 throws ArrayIndexOutOfBoundsException

Fast but unsafe retrieval of a component for this entity.

No bounding checks, so this could throw an ArrayIndexOutOfBoundsExeption, however in most scenarios you already know the entity possesses this component.

Parameters:

e - the entity that should possess the component

Returns:

the instance of the component

Throws:

ArrayIndexOutOfBoundsException

get

public abstract A get(Entity e,
    boolean forceNewInstance)
                                 throws ArrayIndexOutOfBoundsException

Fast but unsafe retrieval of a component for this entity.

No bounding checks, so this could throw an ArrayIndexOutOfBoundsExeption, however in most scenarios you already know the entity possesses this component.

Parameters:

e - the entity that should possess the component

forceNewInstance - Returns a new instance of the component (only applies to PackedComponents)

Returns:

the instance of the component

Throws:

ArrayIndexOutOfBoundsException

getSafe

public abstract A getSafe(Entity e)

Fast and safe retrieval of a component for this entity.

If the entity does not have this component then null is returned.

Parameters:

e - the entity that should possess the component

Returns:

the instance of the component

getSafe

public abstract A getSafe(Entity e,
        boolean forceNewInstance)

Fast and safe retrieval of a component for this entity.

If the entity does not have this component then null is returned.

Parameters:

e - the entity that should possess the component

forceNewInstance - If true, returns a new instance of the component (only applies to PackedComponents)

Returns:

the instance of the component

has

public abstract boolean has(Entity e)

Checks if the entity has this type of component.

Parameters:

e - the entity to check

Returns:

true if the entity has this component type, false if it doesn't

getFor

public static <T extends Component> ComponentMapper<T> getFor(Class<T> type,
                                              World world)

Returns a component mapper for this type of components.

Type Parameters:

T - the class type of components

Parameters:

type - the class of components this mapper uses

world - the world that this component mapper should use

Returns:

a new mapper