api

Interface IEntity

All Superinterfaces:

ISerializable, java.io.Serializable

All Known Implementing Classes:

Entity

public interface IEntity
extends ISerializable

Interface for an entity.

Author:

Rhondu Smithwick, Tom Wu

Method Summary

Modifier and Type	Method and Description
default boolean	addComponent(IComponent componentToAdd) Attempt to add a component (non force).
default java.util.List<java.lang.Boolean>	addComponents(IComponent... componentsToAdd) Attempt to add a array/varargs of components (non force).
default java.util.List<java.lang.Boolean>	addComponents(java.util.List<IComponent> componentsToAdd) Attempt to add a list of components (non force).
void	addGroupIDs(java.lang.String... groupIDs) Adds groups IDs
boolean	forceAddComponent(IComponent componentToAdd, boolean forceAdd) Force add a component regardless of specs (enable true forceAdd).
default java.util.List<java.lang.Boolean>	forceAddComponents(boolean forceAdd, IComponent... componentsToAdd) Force add array/vargs of components regardless of specs (enable true forceAdd).
default java.util.List<java.lang.Boolean>	forceAddComponents(java.util.List<IComponent> componentsToAdd, boolean forceAdd) Force add list of components regardless of specs (enable true forceAdd).
java.util.Collection<IComponent>	getAllComponents() Get all the components of this entity.
default <T extends IComponent> T	getComponent(java.lang.Class<T> componentClass) Get a single component of this type.
default <T extends IComponent> T	getComponent(java.lang.Class<T> componentClass, int index) Get a component of this type that was the index inserted.
java.util.Set<java.lang.Class<? extends IComponent>>	getComponentClasses() Return all the component classes this entity contains.
<T extends IComponent> java.util.List<T>	getComponentList(java.lang.Class<T> componentClass) Get a list of components of this component type.
java.util.Set<java.lang.String>	getGroupIDs() Gets the group IDs
java.lang.String	getID() Gets the unique id of this entity
java.lang.String	getName() Get this Entity's name.
default int	getSpec(java.lang.Class<? extends IComponent> componentClass) Get spec of a componentClass (how many components for this class).
java.util.Map<java.lang.Class<? extends IComponent>,java.lang.Integer>	getSpecs() Get the specs, which is a map of component classes to how many this entity should have of each.
<T extends IComponent> boolean	hasComponent(java.lang.Class<T> componentClass) Check if this entity has this component.
default boolean	hasComponents(java.lang.Class<? extends IComponent>... componentClasses) Check if this entity has this array/varargs of components.
default boolean	hasComponents(java.util.List<java.lang.Class<? extends IComponent>> componentClasses) Check if this entity has this list of components.
default void	loadSpecsFromPropertiesFile(java.lang.String fileName) Load the specs from a resource properties file.
default java.lang.Boolean	removeAllComponents() Remove all the components of this entity.
java.lang.Boolean	removeComponent(java.lang.Class<? extends IComponent> componentClassToRemove) Remove a component.
default java.util.List<java.lang.Boolean>	removeComponents(java.lang.Class<? extends IComponent>... componentClassesToRemove) Remove array/varargs of components
default java.util.List<java.lang.Boolean>	removeComponents(java.util.List<java.lang.Class<? extends IComponent>> componentClassesToRemove) Remove list of components
void	setGroupIDs(java.util.Set<java.lang.String> groupIDs) Sets the groups IDs
void	setName(java.lang.String name) Set this entity's name.
default <T extends IComponent> void	setSpec(java.lang.Class<T> componentClass, int numToHave) Add a spec.
default void	setSpecs(java.util.Map<java.lang.Class<? extends IComponent>,java.lang.Integer> map) Set specs with a map.

Methods inherited from interface api.ISerializable

clone, serialize, serializeToString

Method Detail

getName

java.lang.String getName()

Get this Entity's name.

Returns:

this entity's name

setName

void setName(java.lang.String name)

Set this entity's name.

Parameters:

name - this entity's new name

getID

java.lang.String getID()

Gets the unique id of this entity

Returns:

id the unique id of this entity

getGroupIDs

java.util.Set<java.lang.String> getGroupIDs()

Gets the group IDs

Returns:

group Ids

setGroupIDs

void setGroupIDs(java.util.Set<java.lang.String> groupIDs)

Sets the groups IDs

Parameters:

groupIDs - the group IDs

addGroupIDs

void addGroupIDs(java.lang.String... groupIDs)

Adds groups IDs

Parameters:

groupIDs - additional group IDs

getAllComponents

java.util.Collection<IComponent> getAllComponents()

Get all the components of this entity.

Returns:

all the components of this entity

getComponentList

<T extends IComponent> java.util.List<T> getComponentList(java.lang.Class<T> componentClass)

Get a list of components of this component type.

Type Parameters:

T - type of component

Parameters:

componentClass - the class of component

Returns:

list of components of this component type

getComponent

default <T extends IComponent> T getComponent(java.lang.Class<T> componentClass)

Get a single component of this type.

Type Parameters:

T - the type of component

Parameters:

componentClass - the class of component

Returns:

a single component of this type

getComponent

default <T extends IComponent> T getComponent(java.lang.Class<T> componentClass,
                                              int index)
                                       throws java.lang.IllegalArgumentException

Get a component of this type that was the index inserted.

Type Parameters:

T - the type of component

Parameters:

componentClass - the class of component

index - the component number that it was inserted

Returns:

component of this type that was the index inserted

Throws:

java.lang.IllegalArgumentException - if no such index

See Also:

getComponentList(Class)

getComponentClasses

java.util.Set<java.lang.Class<? extends IComponent>> getComponentClasses()

Return all the component classes this entity contains.

Returns:

all the component classes this entity contains

hasComponent

<T extends IComponent> boolean hasComponent(java.lang.Class<T> componentClass)

Check if this entity has this component.

Type Parameters:

T - type of component

Parameters:

componentClass - to check

Returns:

true if this entity has this component

hasComponents

default boolean hasComponents(java.util.List<java.lang.Class<? extends IComponent>> componentClasses)

Check if this entity has this list of components.

Parameters:

componentClasses - list of components to check

Returns:

true if entity has all these components

See Also:

hasComponent(Class)

hasComponents

default boolean hasComponents(java.lang.Class<? extends IComponent>... componentClasses)

Check if this entity has this array/varargs of components.

Parameters:

componentClasses - list of components to check

Returns:

true if entity has all these components

See Also:

hasComponents(List)

forceAddComponent

boolean forceAddComponent(IComponent componentToAdd,
                          boolean forceAdd)

Force add a component regardless of specs (enable true forceAdd).

Parameters:

componentToAdd - the component to add

forceAdd - whether to force add this component

Returns:

true if this component was added

forceAddComponents

default java.util.List<java.lang.Boolean> forceAddComponents(java.util.List<IComponent> componentsToAdd,
                                                             boolean forceAdd)

Force add list of components regardless of specs (enable true forceAdd).

Parameters:

componentsToAdd - the components to add

forceAdd - whether to force add these components

Returns:

list of true values that indicates if a component was added

See Also:

forceAddComponent(IComponent, boolean)

forceAddComponents

default java.util.List<java.lang.Boolean> forceAddComponents(boolean forceAdd,
                                                             IComponent... componentsToAdd)

Force add array/vargs of components regardless of specs (enable true forceAdd).

Parameters:

componentsToAdd - the components to add

forceAdd - whether to force add these components

Returns:

list of true values that indicates if a component was added

See Also:

forceAddComponents(List, boolean)

addComponent

default boolean addComponent(IComponent componentToAdd)

Attempt to add a component (non force).

Parameters:

componentToAdd - the component to add

Returns:

true if component added

See Also:

forceAddComponent(IComponent, boolean)

addComponents

default java.util.List<java.lang.Boolean> addComponents(java.util.List<IComponent> componentsToAdd)

Attempt to add a list of components (non force).

Parameters:

componentsToAdd - list of components to add

Returns:

list of true values that indicates if a component was added

See Also:

forceAddComponents(List, boolean)

addComponents

default java.util.List<java.lang.Boolean> addComponents(IComponent... componentsToAdd)

Attempt to add a array/varargs of components (non force).

Parameters:

componentsToAdd - array/varargs of components to add

Returns:

list of true values that indicates if a component was added

See Also:

addComponents(List)

removeComponent

java.lang.Boolean removeComponent(java.lang.Class<? extends IComponent> componentClassToRemove)

Remove a component.

Type Parameters:

T - type of component

Parameters:

componentClassToRemove - component class to remove

Returns:

true if component was remove

removeComponents

default java.util.List<java.lang.Boolean> removeComponents(java.util.List<java.lang.Class<? extends IComponent>> componentClassesToRemove)

Remove list of components

Parameters:

componentClassesToRemove - list of component classes to remove

Returns:

list of true values that indicates if a component was removed

See Also:

removeComponent(Class)

removeComponents

default java.util.List<java.lang.Boolean> removeComponents(java.lang.Class<? extends IComponent>... componentClassesToRemove)

Remove array/varargs of components

Parameters:

componentClassesToRemove - array/varargs of component classes to remove

Returns:

list of true values that indicates if a component was removed

See Also:

removeComponents(List)

removeAllComponents

default java.lang.Boolean removeAllComponents()

Remove all the components of this entity.

Returns:

true if all components removed

getSpecs

java.util.Map<java.lang.Class<? extends IComponent>,java.lang.Integer> getSpecs()

Get the specs, which is a map of component classes to how many this entity should have of each.

Returns:

the specs map

loadSpecsFromPropertiesFile

default void loadSpecsFromPropertiesFile(java.lang.String fileName)

Load the specs from a resource properties file.

Parameters:

fileName - the fileName

setSpecs

default void setSpecs(java.util.Map<java.lang.Class<? extends IComponent>,java.lang.Integer> map)

Set specs with a map.

Parameters:

map - to set specs with

See Also:

getSpecs()

getSpec

default int getSpec(java.lang.Class<? extends IComponent> componentClass)

Get spec of a componentClass (how many components for this class).

Parameters:

componentClass - componentClass whose spec to get

Returns:

spec of this component

See Also:

getSpecs()

setSpec

default <T extends IComponent> void setSpec(java.lang.Class<T> componentClass,
                                            int numToHave)

Add a spec.

Type Parameters:

T - type of component

Parameters:

componentClass - class of the component

numToHave - how many this entity should have of this component

See Also:

getSpecs()