model.entity

Class Entity

java.lang.Object

model.entity.Entity

All Implemented Interfaces:

IEntity, ISerializable, java.io.Serializable

public class Entity
extends java.lang.Object
implements IEntity

Implementation of an IEntity.

This implementation uses Java's UUID to generate unique IDs.

Author:

Rhondu Smithwick

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Entity()
Entity(java.lang.String name)

Method Summary

Modifier and Type	Method and Description
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).
java.util.Collection<IComponent>	getAllComponents() Get all the components of this entity.
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.
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.
java.lang.Boolean	removeComponent(java.lang.Class<? extends IComponent> componentClassToRemove) Remove a component.
void	setGroupIDs(java.util.Set<java.lang.String> groupIDs) Sets the groups IDs
void	setName(java.lang.String name) Set this entity's name.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface api.IEntity

addComponent, addComponents, addComponents, forceAddComponents, forceAddComponents, getComponent, getComponent, getSpec, hasComponents, hasComponents, loadSpecsFromPropertiesFile, removeAllComponents, removeComponents, removeComponents, setSpec, setSpecs

Methods inherited from interface api.ISerializable

clone, serialize, serializeToString

Constructor Detail

Entity

public Entity()

Entity

public Entity(java.lang.String name)

Method Detail

getName

public java.lang.String getName()

Description copied from interface: IEntity

Get this Entity's name.

Specified by:

getName in interface IEntity

Returns:

this entity's name

setName

public void setName(java.lang.String name)

Description copied from interface: IEntity

Set this entity's name.

Specified by:

setName in interface IEntity

Parameters:

name - this entity's new name

getID

public java.lang.String getID()

Description copied from interface: IEntity

Gets the unique id of this entity

Specified by:

getID in interface IEntity

Returns:

id the unique id of this entity

getGroupIDs

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

Description copied from interface: IEntity

Gets the group IDs

Specified by:

getGroupIDs in interface IEntity

Returns:

group Ids

setGroupIDs

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

Description copied from interface: IEntity

Sets the groups IDs

Specified by:

setGroupIDs in interface IEntity

Parameters:

groupIDs - the group IDs

addGroupIDs

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

Description copied from interface: IEntity

Adds groups IDs

Specified by:

addGroupIDs in interface IEntity

Parameters:

groupIDs - additional group IDs

getAllComponents

public java.util.Collection<IComponent> getAllComponents()

Description copied from interface: IEntity

Get all the components of this entity.

Specified by:

getAllComponents in interface IEntity

Returns:

all the components of this entity

getComponentClasses

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

Description copied from interface: IEntity

Return all the component classes this entity contains.

Specified by:

getComponentClasses in interface IEntity

Returns:

all the component classes this entity contains

getComponentList

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

Description copied from interface: IEntity

Get a list of components of this component type.

Specified by:

getComponentList in interface IEntity

Type Parameters:

T - type of component

Parameters:

componentClass - the class of component

Returns:

list of components of this component type

hasComponent

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

Description copied from interface: IEntity

Check if this entity has this component.

Specified by:

hasComponent in interface IEntity

Type Parameters:

T - type of component

Parameters:

componentClass - to check

Returns:

true if this entity has this component

forceAddComponent

public boolean forceAddComponent(IComponent componentToAdd,
                                 boolean forceAdd)

Description copied from interface: IEntity

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

Specified by:

forceAddComponent in interface IEntity

Parameters:

componentToAdd - the component to add

forceAdd - whether to force add this component

Returns:

true if this component was added

removeComponent

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

Description copied from interface: IEntity

Remove a component.

Specified by:

removeComponent in interface IEntity

Parameters:

componentClassToRemove - component class to remove

Returns:

true if component was remove

getSpecs

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

Description copied from interface: IEntity

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

Specified by:

getSpecs in interface IEntity

Returns:

the specs map

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object