jalse.entities

Class Entities

java.lang.Object

jalse.entities.Entities

public final class Entities
extends java.lang.Object

A utility for Entity related functionality (specifically around entity types).

An Entity type allows entities to be used in an Object-Oriented way (get/set). It does this by providing a number of annotations that specify to the proxy its behaviour.

Entity types are soft types - any entity can be 'cast' (asType(Entity, Class)) to another entity type even if it does not have the defining data. This does not set the entity as this type but entities can be marked as a type manually for easy filtering/processing ( Entity.markAsType(Class)). When creating an entity and supplying an entity type (like EntityContainer.newEntity(Class)) this automatically marks the entity as the supplied type - in fact all of the types in the entity type inheritance tree are added too (removable). An entity can be marked as multiple entity types so filtering this way can become very useful for processing similar entities.

See Also:

DefaultEntityProxyFactory, walkEntities(EntityContainer), walkEntityTree(EntityContainer, EntityVisitor)

Field Summary

Fields

Modifier and Type	Field and Description
static EntityContainer	EMPTY_ENTITYCONTAINER An empty EntityContainer.
static EntityFactory	EMPTY_ENTITYFACTORY An empty EntityFactory.

Method Summary

Modifier and Type	Method and Description
static java.util.Optional<Entity>	anyEntity(EntityContainer container) Gets any entity within the container.
static <T extends Entity> java.util.Optional<T>	anyEntityOfType(EntityContainer container, java.lang.Class<T> type) Gets any entity within the container marked with the specified type.
static <T extends Entity> T	asType(Entity entity, java.lang.Class<T> type) Wraps an Entity as the supplied Entity type.
static EntityContainer	emptyEntityContainer() Creates an immutable empty entity container.
static EntityFactory	emptyEntityFactory() Creates an immutable empty entity factory.
static boolean	findEntityRecursively(EntityContainer container, java.util.UUID id) Walks through the entity tree looking for an entity.
static int	getEntityCountRecursively(EntityContainer container) Gets the total entity count (recursive).
static java.util.Set<java.util.UUID>	getEntityIDsRecursively(EntityContainer container) Gets the IDs of all the entities (recursive).
static EntityContainer	getHighestParent(EntityContainer container) Gets the highest level parent of this container.
static EntityProxyFactory	getProxyFactory()
static java.util.Set<java.lang.Class<? extends Entity>>	getTypeAncestry(java.lang.Class<? extends Entity> type) Gets all ancestors for the specified descendant type (not including Entity).
static boolean	isEntityOrSubtype(java.lang.Class<?> type) Checks whether the type is an entity subtype.
static boolean	isEntitySubtype(java.lang.Class<?> type) Checks whether the type is an entity subtype.
static java.util.function.Predicate<Entity>	isMarkedAsType(java.lang.Class<? extends Entity> type) Checks to see if the entity has been tagged with the type.
static boolean	isOrSubtype(java.lang.Class<? extends Entity> descendant, java.lang.Class<? extends Entity> ancestor) Checks if the specified type is equal to or a descendant from the specified ancestor type.
static boolean	isSubtype(java.lang.Class<? extends Entity> descendant, java.lang.Class<? extends Entity> ancestor) Checks if the specified type is a descendant from the specified ancestor type.
static java.util.function.Predicate<Entity>	notMarkedAsType(java.lang.Class<? extends Entity> type) Checks to see if the entity has not been tagged with the type.
static java.util.Optional<Entity>	randomEntity(EntityContainer container) Gets a random entity from the container (if there is one).
static void	setProxyFactory(EntityProxyFactory newFactory)
static EntityContainer	unmodifiableEntityContainer(EntityContainer container) Creates an immutable read-only delegate entity container for the supplied container.
static EntityFactory	unmodifiableEntityFactory(EntityFactory factory) Creates an immutable read-only delegate entity factory for the supplied factory.
static void	validateType(java.lang.Class<? extends Entity> type) Validates the entity type.
static java.util.stream.Stream<Entity>	walkEntities(EntityContainer container) A lazy-walked stream of entities (recursive and breadth-first).
static java.util.stream.Stream<Entity>	walkEntities(EntityContainer container, int maxDepth) A lazy-walked stream of entities (recursive and breadth-first).
static void	walkEntityTree(EntityContainer container, EntityVisitor visitor) Walks through all entities (recursive and breadth-first).
static void	walkEntityTree(EntityContainer container, int maxDepth, EntityVisitor visitor) Walks through all entities (recursive and breadth-first).
static boolean	withinSameTree(EntityContainer one, EntityContainer two) Checks to see if an container is in the same tree as the other container (checking highest parent container).

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY_ENTITYCONTAINER

public static EntityContainer EMPTY_ENTITYCONTAINER

An empty EntityContainer.

EMPTY_ENTITYFACTORY

public static EntityFactory EMPTY_ENTITYFACTORY

An empty EntityFactory.

Method Detail

anyEntity

public static java.util.Optional<Entity> anyEntity(EntityContainer container)

Gets any entity within the container.

Parameters:

container - Entity container.

Returns:

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

anyEntityOfType

public static <T extends Entity> java.util.Optional<T> anyEntityOfType(EntityContainer container,
                                                                       java.lang.Class<T> type)

Gets any entity within the container marked with the specified type.

Parameters:

container - Entity container.

type - Entity type.

Returns:

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

See Also:

Entity.markAsType(Class)

asType

public static <T extends Entity> T asType(Entity entity,
                                          java.lang.Class<T> type)

Wraps an Entity as the supplied Entity type. This is a convenience method for EntityProxyFactory.proxyOfEntity(Entity, Class).

Parameters:

entity - Entity to wrap.

type - Entity type to wrap to.

Returns:

The wrapped Entity.

See Also:

getProxyFactory()

emptyEntityContainer

public static EntityContainer emptyEntityContainer()

Creates an immutable empty entity container.

Returns:

Empty entity container.

emptyEntityFactory

public static EntityFactory emptyEntityFactory()

Creates an immutable empty entity factory.

Returns:

Empty entity factory.

findEntityRecursively

public static boolean findEntityRecursively(EntityContainer container,
                                            java.util.UUID id)

Walks through the entity tree looking for an entity.

Parameters:

container - Entity container.

id - Entity ID to look for.

Returns:

Whether the entity was found.

See Also:

walkEntityTree(EntityContainer, EntityVisitor)

getEntityCountRecursively

public static int getEntityCountRecursively(EntityContainer container)

Gets the total entity count (recursive).

Parameters:

container - Entity container.

Returns:

Total entity count.

See Also:

walkEntityTree(EntityContainer, EntityVisitor)

getEntityIDsRecursively

public static java.util.Set<java.util.UUID> getEntityIDsRecursively(EntityContainer container)

Gets the IDs of all the entities (recursive).

Parameters:

container - Entity container.

Returns:

Set of all entity identifiers.

See Also:

walkEntityTree(EntityContainer, EntityVisitor)

getHighestParent

public static EntityContainer getHighestParent(EntityContainer container)

Gets the highest level parent of this container.

Parameters:

container - Container to get parent for.

Returns:

Highest level parent (or this container if it has no parent).

getProxyFactory

public static EntityProxyFactory getProxyFactory()

getTypeAncestry

public static java.util.Set<java.lang.Class<? extends Entity>> getTypeAncestry(java.lang.Class<? extends Entity> type)

Gets all ancestors for the specified descendant type (not including Entity).

Parameters:

type - Descendant type.

Returns:

All ancestors or an empty set if its only ancestor is Entity.

Throws:

java.lang.IllegalArgumentException - If the Entity type is invalid

See Also:

validateType(Class)

isEntityOrSubtype

public static boolean isEntityOrSubtype(java.lang.Class<?> type)

Checks whether the type is an entity subtype.

Parameters:

type - Type to check.

Returns:

Whether the type is a descendant of entity.

isEntitySubtype

public static boolean isEntitySubtype(java.lang.Class<?> type)

Checks whether the type is an entity subtype.

Parameters:

type - Type to check.

Returns:

Whether the type is a descendant of entity.

isMarkedAsType

public static java.util.function.Predicate<Entity> isMarkedAsType(java.lang.Class<? extends Entity> type)

Checks to see if the entity has been tagged with the type.

Parameters:

type - Entity type to check for.

Returns:

Predicate of true if the entity is of the type or false if it is not.

isOrSubtype

public static boolean isOrSubtype(java.lang.Class<? extends Entity> descendant,
                                  java.lang.Class<? extends Entity> ancestor)

Checks if the specified type is equal to or a descendant from the specified ancestor type.

Parameters:

descendant - Descendant type.

ancestor - Ancestor type.

Returns:

Whether the descendant is equal or descended from the ancestor type.

isSubtype

public static boolean isSubtype(java.lang.Class<? extends Entity> descendant,
                                java.lang.Class<? extends Entity> ancestor)

Checks if the specified type is a descendant from the specified ancestor type.

Parameters:

descendant - Descendant type.

ancestor - Ancestor type.

Returns:

Whether the descendant is descended from the ancestor type.

notMarkedAsType

public static java.util.function.Predicate<Entity> notMarkedAsType(java.lang.Class<? extends Entity> type)

Checks to see if the entity has not been tagged with the type.

Parameters:

type - Entity type to check for.

Returns:

Predicate of true if the entity is not of the type or false if it is.

randomEntity

public static java.util.Optional<Entity> randomEntity(EntityContainer container)

Gets a random entity from the container (if there is one).

Parameters:

container - Source container.

Returns:

Random entity (if found).

setProxyFactory

public static void setProxyFactory(EntityProxyFactory newFactory)

unmodifiableEntityContainer

public static EntityContainer unmodifiableEntityContainer(EntityContainer container)

Creates an immutable read-only delegate entity container for the supplied container.

Parameters:

container - Container to delegate for.

Returns:

Immutable entity container.

unmodifiableEntityFactory

public static EntityFactory unmodifiableEntityFactory(EntityFactory factory)

Creates an immutable read-only delegate entity factory for the supplied factory.

Parameters:

factory - Factory to delegate for.

Returns:

Immutable entity factory.

validateType

public static void validateType(java.lang.Class<? extends Entity> type)

Validates the entity type. This is a convenience method for EntityProxyFactory.validateType(Class).

Parameters:

type - Type to validate.

See Also:

getProxyFactory()

walkEntities

public static java.util.stream.Stream<Entity> walkEntities(EntityContainer container)

A lazy-walked stream of entities (recursive and breadth-first). The entire stream will not be loaded until it is iterated through. This is equivalent to walkEntities(container, Integer.MAX_VALUE)

Parameters:

container - Entity container.

Returns:

Lazy-walked recursive stream of entities.

walkEntities

public static java.util.stream.Stream<Entity> walkEntities(EntityContainer container,
                                                           int maxDepth)

A lazy-walked stream of entities (recursive and breadth-first). The entire stream will not be loaded until it is iterated through.

Parameters:

container - Entity container.

maxDepth - Maximum depth of the walk.

Returns:

Lazy-walked recursive stream of entities.

walkEntityTree

public static void walkEntityTree(EntityContainer container,
                                  EntityVisitor visitor)

Walks through all entities (recursive and breadth-first). Walking can be stopped or filtered based on the visit result returned. This is equivalent to walkEntityTree(container, Integer.MAX_VALUE, visitor)

Parameters:

container - Entity container.

visitor - Entity visitor.

See Also:

EntityVisitor

walkEntityTree

public static void walkEntityTree(EntityContainer container,
                                  int maxDepth,
                                  EntityVisitor visitor)

Walks through all entities (recursive and breadth-first). Walking can be stopped or filtered based on the visit result returned.

Parameters:

container - Entity container.

maxDepth - Maximum depth of the walk.

visitor - Entity visitor.

See Also:

EntityVisitor

withinSameTree

public static boolean withinSameTree(EntityContainer one,
                                     EntityContainer two)

Checks to see if an container is in the same tree as the other container (checking highest parent container).

Parameters:

one - Container to check.

two - Container to check.

Returns:

Whether the container is within the same tree as the other container.

See Also:

getHighestParent(EntityContainer)