BaseComponentMapper (artemis-odb 2.2.0 API)

java.lang.Object
- com.artemis.BaseComponentMapper<A>

Direct Known Subclasses:: ComponentMapper

public abstract class BaseComponentMapper<A extends Component>
extends Object

Field Summary

Fields
Modifier and Type Field and Description

ComponentType type
The type of components this mapper handles.

Fields
Modifier and Type	Field and Description
`ComponentType`	`type` The type of components this mapper handles.

Constructor Summary

Constructors
Modifier Constructor and Description

protected BaseComponentMapper(ComponentType type)

Constructors
Modifier	Constructor and Description
`protected`	`BaseComponentMapper(ComponentType type)`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`A`	`create(Entity entity)` Create component for this entity.
`abstract A`	`create(int entityId)`
`A`	`get(Entity e)` Fast but unsafe retrieval of a component for this entity.
`abstract A`	`get(int entityId)` Fast but unsafe retrieval of a component for this entity.
`static <T extends Component> BaseComponentMapper<T>`	`getFor(Class<T> type, World world)` Returns a component mapper for this type of components.
`A`	`getSafe(Entity entity, A fallback)` Fast and safe retrieval of a component for this entity.
`A`	`getSafe(int entityId, A fallback)` Fast and safe retrieval of a component for this entity.
`ComponentType`	`getType()` Returns the ComponentType of this ComponentMapper.
`boolean`	`has(Entity e)` Checks if the entity has this type of component.
`abstract boolean`	`has(int entityId)`
`abstract A`	`internalCreate(int entityId)`
`protected abstract void`	`internalRemove(int entityId)`
`void`	`remove(Entity entity)` Remove component from entity.
`abstract void`	`remove(int entityId)`
`A`	`set(Entity entity, boolean value)` Create or remove a component from an entity.
`A`	`set(int entityId, boolean value)` Create or remove a component from an entity.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - type
```
public final ComponentType type
```
    The type of components this mapper handles.
- Constructor Detail
  - BaseComponentMapper
```
protected BaseComponentMapper(ComponentType type)
```
- Method Detail
  - getFor
```
public static <T extends Component> BaseComponentMapper<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
  - get
```
public A get(Entity e)
      throws ArrayIndexOutOfBoundsException
```
    Fast but unsafe retrieval of a component for this entity. This method trades performance for safety. User is expected to avoid calling this method on recently (in same system) removed components or invalid entity ids. Might return null, throw ArrayIndexOutOfBoundsException or a partially recycled component if called on in-system removed components. Only exception are components marked with DelayedComponentRemoval, when calling this method from within a subscription listener.
    
    Parameters:
    
    e - the entity that should possess the component
    
    Returns:
    
    the instance of the component.
    
    Throws:
    
    ArrayIndexOutOfBoundsException
  - get
```
public abstract A get(int entityId)
               throws ArrayIndexOutOfBoundsException
```
    Fast but unsafe retrieval of a component for this entity. This method trades performance for safety. User is expected to avoid calling this method on recently (in same system) removed components or invalid entity ids. Might return null, throw ArrayIndexOutOfBoundsException or a partially recycled component if called on in-system removed components. Only exception are components marked with DelayedComponentRemoval, when calling this method from within a subscription listener.
    
    Parameters:
    
    entityId - the entity that should possess the component
    
    Returns:
    
    the instance of the component.
    
    Throws:
    
    ArrayIndexOutOfBoundsException
  - has
```
public boolean has(Entity e)
            throws ArrayIndexOutOfBoundsException
```
    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
    
    Throws:
    
    ArrayIndexOutOfBoundsException
  - has
```
public abstract boolean has(int entityId)
```
  - create
```
public A create(Entity entity)
```
    Create component for this entity. Will avoid creation if component preexists.
    
    Parameters:
    
    entity - the entity that should possess the component
    
    Returns:
    
    the instance of the component.
  - remove
```
public abstract void remove(int entityId)
```
  - remove
```
public void remove(Entity entity)
```
    Remove component from entity. Does nothing if already removed.
    
    Parameters:
    
    entity - entity to remove.
  - internalRemove
```
protected abstract void internalRemove(int entityId)
```
  - create
```
public abstract A create(int entityId)
```
  - internalCreate
```
public abstract A internalCreate(int entityId)
```
  - getSafe
```
public A getSafe(int entityId,
                 A fallback)
```
    Fast and safe retrieval of a component for this entity. If the entity does not have this component then fallback is returned.
    
    Parameters:
    
    entityId - Entity that should possess the component
    
    fallback - fallback component to return, or null to return null.
    
    Returns:
    
    the instance of the component
  - set
```
public A set(int entityId,
             boolean value)
```
    Create or remove a component from an entity. Does nothing if already removed or created respectively.
    
    Parameters:
    
    entityId - Entity id to change.
    
    value - true to create component (if missing), false to remove (if exists).
    
    Returns:
    
    the instance of the component, or null if removed.
  - set
```
public A set(Entity entity,
             boolean value)
```
    Create or remove a component from an entity. Does nothing if already removed or created respectively.
    
    Parameters:
    
    entity - Entity to change.
    
    value - true to create component (if missing), false to remove (if exists).
    
    Returns:
    
    the instance of the component, or null if removed.
  - getSafe
```
public A getSafe(Entity entity,
                 A fallback)
```
    Fast and safe retrieval of a component for this entity. If the entity does not have this component then fallback is returned.
    
    Parameters:
    
    entity - Entity that should possess the component
    
    fallback - fallback component to return, or null to return null.
    
    Returns:
    
    the instance of the component
  - getType
```
public ComponentType getType()
```
    Returns the ComponentType of this ComponentMapper. see type
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class BaseComponentMapper<A extends Component>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

type

Constructor Detail

BaseComponentMapper

Method Detail

getFor

get

get

has

has

create

remove

remove

internalRemove

create

internalCreate

getSafe

set

set

getSafe

getType

toString