jalse.entities

Interface EntityVisitor

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface EntityVisitor

EntityVisitor allows Entity within an EntityContainer to be walked through one by one recursively. These are walked through breadth-first and their walking can be filtered by suppling different EntityVisitor.EntityVisitResult.

1. EntityVisitor.EntityVisitResult.CONTINUE the walker will continue as normal.
2. EntityVisitor.EntityVisitResult.IGNORE_CHILDREN the walker will not walk through any children of this entity.
3. EntityVisitor.EntityVisitResult.IGNORE_SIBLINGS the walker will ignore all new siblings (only processing the current entity and it's children).
4. EntityVisitor.EntityVisitResult.EXIT the walker will exit walking and reset.

Entities can be walked through using Entities.walkEntityTree(EntityContainer, int, EntityVisitor).

See Also:

Entities

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	EntityVisitor.EntityVisitResult Result to be returned when visiting an Entity.

Method Summary

Modifier and Type	Method and Description
EntityVisitor.EntityVisitResult	visit(Entity e) The walker visiting this entity.

Method Detail

visit

EntityVisitor.EntityVisitResult visit(Entity e)

The walker visiting this entity.

Parameters:

e - Entity to visit.

Returns:

Result of the visit.