jalse.entities

Interface EntityContainer

All Known Subinterfaces:

Entity, JALSE

All Known Implementing Classes:

DefaultEntity, DefaultEntityContainer, DefaultJALSE

public interface EntityContainer

This is an Entity collection. Entities can only be added to a container by creating them and remove them by killing them. Entity creation and death can be listened for using EntityListener and EntityEvent.

See Also:

DefaultEntityContainer, EntityFactory, Entities.emptyEntityContainer(), Entities.unmodifiableEntityContainer(EntityContainer)

Method Summary

Modifier and Type	Method and Description
boolean	addEntityListener(EntityListener listener) Adds a listener for entities.
default java.util.Set<Entity>	getEntities() Gets all the entities within the containers.
default <T extends Entity> java.util.Set<T>	getEntitiesAsType(java.lang.Class<T> type) Gets all the entities as the specified type.
default <T extends Entity> java.util.Set<T>	getEntitiesOfType(java.lang.Class<T> type) Gets all the entities marked with the specified type.
Entity	getEntity(java.util.UUID id) Gets the entity with the specified ID.
default <T extends Entity> T	getEntityAsType(java.util.UUID id, java.lang.Class<T> type) This is a convenience method for getting an entity (no optional).
int	getEntityCount() Gets the direct entity count.
java.util.Set<java.util.UUID>	getEntityIDs() Gets the IDs of all the entities within the container.
java.util.Set<? extends EntityListener>	getEntityListeners() Gets all the entity listeners.
default java.util.Optional<Entity>	getOptEntity(java.util.UUID id) This is a convenience method for getting an entity (optional).
default <T extends Entity> java.util.Optional<T>	getOptEntityAsType(java.util.UUID id, java.lang.Class<T> type) This is a convenience method for getting an entity (optional).The entity is wrapped with the supplied entity type.
default boolean	hasEntities() Checks whether the container has any entities.
default boolean	hasEntity(java.util.UUID id) Checks whether the entity is contained.
default boolean	hasEntityListener(EntityListener listener) Checks whether the container contains a particular listener.
void	killEntities() Kills all entities.
boolean	killEntity(java.util.UUID id) Kills the specified entity.
default Entity	newEntity() Creates a new entity with a random ID.
default Entity	newEntity(AttributeContainer sourceContainer) Creates a new entity with a random ID.
default <T extends Entity> T	newEntity(java.lang.Class<T> type) Creates a new entity with a random ID.
default <T extends Entity> T	newEntity(java.lang.Class<T> type, AttributeContainer sourceContainer) Creates a new entity with a random ID.
default Entity	newEntity(java.util.UUID id) Creates new entity with the specified ID.
Entity	newEntity(java.util.UUID id, AttributeContainer sourceContainer) Creates new entity with the specified ID.
default <T extends Entity> T	newEntity(java.util.UUID id, java.lang.Class<T> type) Creates new entity with the specified ID.
<T extends Entity> T	newEntity(java.util.UUID id, java.lang.Class<T> type, AttributeContainer sourceContainer) Creates new entity with the specified ID.
boolean	receiveEntity(Entity e) Receives an entity (from a transfer).
boolean	removeEntityListener(EntityListener listener) Removes a entity listener.
void	removeEntityListeners() Removes all listeners for entities.
java.util.stream.Stream<Entity>	streamEntities() Provides a stream of entities from the container.
default <T extends Entity> java.util.stream.Stream<T>	streamEntitiesAsType(java.lang.Class<T> type) Gets a stream of as the specified type.
default <T extends Entity> java.util.stream.Stream<T>	streamEntitiesOfType(java.lang.Class<T> type) Gets a stream of entities marked with the specified type.
default java.util.stream.Stream<java.util.UUID>	streamEntityIDs() Streams IDs of all the entities within the container.
default java.util.Set<java.util.UUID>	transferAllEntities(EntityContainer destination) Transfers all entities to the destination.
default java.util.Set<java.util.UUID>	transferEntities(java.util.function.Predicate<Entity> predicate, EntityContainer destination) Transfers all entities to the destination.
default java.util.Set<java.util.UUID>	transferEntities(java.util.Set<java.util.UUID> entityIDs, EntityContainer destination) Transfers a number of entities
boolean	transferEntity(java.util.UUID id, EntityContainer destination) Transfers the entity to the supplied destination container.

Method Detail

addEntityListener

boolean addEntityListener(EntityListener listener)

Adds a listener for entities.

Parameters:

listener - Listener to add.

Returns:

true if container did not already contain this listener.

Throws:

java.lang.NullPointerException - if listener is null.

See Also:

ListenerSet.add(Object)

getEntities

default java.util.Set<Entity> getEntities()

Gets all the entities within the containers.

Returns:

Gets all entities or an empty set if none were found.

See Also:

streamEntities()

getEntitiesAsType

default <T extends Entity> java.util.Set<T> getEntitiesAsType(java.lang.Class<T> type)

Gets all the entities as the specified type.

Parameters:

type - Entity type to check for.

Returns:

Set of entities as the type.

See Also:

streamEntitiesAsType(Class)

getEntitiesOfType

default <T extends Entity> java.util.Set<T> getEntitiesOfType(java.lang.Class<T> type)

Gets all the entities marked with the specified type.

Parameters:

type - Entity type to check for.

Returns:

Set of entities marked with the type.

See Also:

streamEntitiesOfType(Class)

getEntity

Entity getEntity(java.util.UUID id)

Gets the entity with the specified ID.

Parameters:

id - Unique ID of the entity.

Returns:

The entity matching the supplied id or null if none found.

getEntityAsType

default <T extends Entity> T getEntityAsType(java.util.UUID id,
                                             java.lang.Class<T> type)

This is a convenience method for getting an entity (no optional). The entity is wrapped with the supplied entity type.

Parameters:

id - Unique ID of the entity.

type - Entity type to wrap to.

Returns:

The entity matching the supplied id or null if none found.

See Also:

Entities.asType(Entity, Class)

getEntityCount

int getEntityCount()

Gets the direct entity count.

Returns:

Direct child entity count.

getEntityIDs

java.util.Set<java.util.UUID> getEntityIDs()

Gets the IDs of all the entities within the container.

Returns:

Set of all entity identifiers.

getEntityListeners

java.util.Set<? extends EntityListener> getEntityListeners()

Gets all the entity listeners.

Returns:

All the entity listeners.

getOptEntity

default java.util.Optional<Entity> getOptEntity(java.util.UUID id)

This is a convenience method for getting an entity (optional).

Parameters:

id - Unique ID of the entity.

Returns:

Gets an Optional of the resulting entity or an empty Optional if it was not found.

Throws:

java.lang.NullPointerException - If the ID is null.

getOptEntityAsType

default <T extends Entity> java.util.Optional<T> getOptEntityAsType(java.util.UUID id,
                                                                    java.lang.Class<T> type)

This is a convenience method for getting an entity (optional).The entity is wrapped with the supplied entity type.

Parameters:

id - Unique ID of the entity.

type - Entity type to wrap to.

Returns:

Gets an Optional of the resulting entity or an empty Optional if it was not found.

Throws:

java.lang.NullPointerException - If type is null.

See Also:

Entities.asType(Entity, Class)

hasEntities

default boolean hasEntities()

Checks whether the container has any entities.

Returns:

Whether the container is not empty.

hasEntity

default boolean hasEntity(java.util.UUID id)

Checks whether the entity is contained.

Parameters:

id - Entity ID.

Returns:

Whether the entity was found.

hasEntityListener

default boolean hasEntityListener(EntityListener listener)

Checks whether the container contains a particular listener.

Parameters:

listener - The EntityListener to check for.

Returns:

Whether the container contains the given EntityListener.

killEntities

void killEntities()

Kills all entities.

killEntity

boolean killEntity(java.util.UUID id)

Kills the specified entity.

Parameters:

id - Entity ID.

Returns:

Whether the entity was alive.

newEntity

default Entity newEntity()

Creates a new entity with a random ID.

Returns:

The newly created entity's ID.

Throws:

java.lang.IllegalStateException - If the entity limit has been reached.

See Also:

UUID.randomUUID()

newEntity

default Entity newEntity(AttributeContainer sourceContainer)

Creates a new entity with a random ID.

Parameters:

sourceContainer - Source attribute container.

Returns:

The newly created entity's ID.

Throws:

java.lang.IllegalStateException - If the entity limit has been reached.

See Also:

UUID.randomUUID()

newEntity

default <T extends Entity> T newEntity(java.lang.Class<T> type)

Creates a new entity with a random ID. This entity is marked as the specified entity type and then wrapped to it.

Parameters:

type - Entity type.

Returns:

The newly created entity.

Throws:

java.lang.IllegalStateException - If the entity limit has been reached.

See Also:

UUID.randomUUID(), Entity.markAsType(Class), Entities.asType(Entity, Class)

newEntity

default <T extends Entity> T newEntity(java.lang.Class<T> type,
                                       AttributeContainer sourceContainer)

Creates a new entity with a random ID. This entity is marked as the specified entity type and then wrapped to it.

Parameters:

type - Entity type.

sourceContainer - Source attribute container.

Returns:

The newly created entity.

Throws:

java.lang.IllegalStateException - If the entity limit has been reached.

See Also:

UUID.randomUUID(), Entity.markAsType(Class), Entities.asType(Entity, Class)

newEntity

default Entity newEntity(java.util.UUID id)

Creates new entity with the specified ID.

Parameters:

id - Entity ID.

Returns:

The newly created entity.

Throws:

java.lang.IllegalStateException - If the entity limit has been reached.

java.lang.IllegalArgumentException - If the entity ID is already assigned.

newEntity

Entity newEntity(java.util.UUID id,
                 AttributeContainer sourceContainer)

Creates new entity with the specified ID.

Parameters:

id - Entity ID.

sourceContainer - Source attribute container.

Returns:

The newly created entity.

Throws:

java.lang.IllegalStateException - If the entity limit has been reached.

java.lang.IllegalArgumentException - If the entity ID is already assigned.

newEntity

default <T extends Entity> T newEntity(java.util.UUID id,
                                       java.lang.Class<T> type)

Creates new entity with the specified ID. This entity is marked as the specified entity type and then wrapped to it.

Parameters:

id - Entity ID.

type - Entity type.

Returns:

The newly created entity.

Throws:

java.lang.IllegalStateException - If the entity limit has been reached.

java.lang.IllegalArgumentException - If the entity ID is already assigned.

See Also:

Entity.markAsType(Class), Entities.asType(Entity, Class)

newEntity

<T extends Entity> T newEntity(java.util.UUID id,
                               java.lang.Class<T> type,
                               AttributeContainer sourceContainer)

Creates new entity with the specified ID. This entity is marked as the specified entity type and then wrapped to it.

Parameters:

id - Entity ID.

type - Entity type.

sourceContainer - Source attribute container.

Returns:

The newly created entity.

Throws:

java.lang.IllegalStateException - If the entity limit has been reached.

java.lang.IllegalArgumentException - If the entity ID is already assigned.

See Also:

Entity.markAsType(Class), Entities.asType(Entity, Class)

receiveEntity

boolean receiveEntity(Entity e)

Receives an entity (from a transfer). This method may receive an entity from within or outside the tree.

Parameters:

e - Entity to receive.

Returns:

Whether the entity was received.

See Also:

transferEntity(UUID, EntityContainer)

removeEntityListener

boolean removeEntityListener(EntityListener listener)

Removes a entity listener.

Parameters:

listener - Listener to remove.

Returns:

true if the listener was removed.

Throws:

java.lang.NullPointerException - if listener is null.

See Also:

ListenerSet.remove(Object)

removeEntityListeners

void removeEntityListeners()

Removes all listeners for entities.

streamEntities

java.util.stream.Stream<Entity> streamEntities()

Provides a stream of entities from the container.

Returns:

A stream of entities in the container.

streamEntitiesAsType

default <T extends Entity> java.util.stream.Stream<T> streamEntitiesAsType(java.lang.Class<T> type)

Gets a stream of as the specified type.

Parameters:

type - Entity type to check for.

Returns:

Stream of entities as the type.

See Also:

Entity.asType(Class), streamEntities()

streamEntitiesOfType

default <T extends Entity> java.util.stream.Stream<T> streamEntitiesOfType(java.lang.Class<T> type)

Gets a stream of entities marked with the specified type.

Parameters:

type - Entity type to check for.

Returns:

Stream of entities marked with the type.

See Also:

Entity.isMarkedAsType(Class), Entity.asType(Class), streamEntities()

streamEntityIDs

default java.util.stream.Stream<java.util.UUID> streamEntityIDs()

Streams IDs of all the entities within the container.

Returns:

Stream of all entity identifiers.

transferAllEntities

default java.util.Set<java.util.UUID> transferAllEntities(EntityContainer destination)

Transfers all entities to the destination.

Parameters:

destination - Destination to transfer to.

Returns:

Entities that could not be transfered.

See Also:

transferEntities(Set, EntityContainer)

transferEntities

default java.util.Set<java.util.UUID> transferEntities(java.util.function.Predicate<Entity> predicate,
                                                       EntityContainer destination)

Transfers all entities to the destination.

Parameters:

predicate - Predicate to filter entities.

destination - Destination to transfer to.

Returns:

Entities that could not be transfered.

transferEntities

default java.util.Set<java.util.UUID> transferEntities(java.util.Set<java.util.UUID> entityIDs,
                                                       EntityContainer destination)

Transfers a number of entities

Parameters:

entityIDs - Entities to transfer.

destination - Destination to transfer to.

Returns:

Entities that could not be transfered.

transferEntity

boolean transferEntity(java.util.UUID id,
                       EntityContainer destination)

Transfers the entity to the supplied destination container.

Parameters:

id - Entity ID.

destination - Target container.

Returns:

Whether the entity was transfered.

See Also:

receiveEntity(Entity)