com.simsilica.es

Class Filters

java.lang.Object

com.simsilica.es.Filters

public class Filters
extends java.lang.Object

Static utility methods pertaining to ComponentFilter instances.

Constructor Summary

Constructors

Constructor and Description
Filters()

Method Summary

Modifier and Type	Method and Description
static <T extends EntityComponent> ComponentFilter<T>	and(java.lang.Class<T> type, ComponentFilter<? super T>... operands) Creates a ComponentFilter that returns true if all of the supplied filters are true.
static <T extends EntityComponent> ComponentFilter<T>	fieldEquals(java.lang.Class<T> type, java.lang.String field, java.lang.Object value) Creates a ComponentFilter that returns true if the specified field of the specified component type matches the specified value.
static <T extends EntityComponent> ComponentFilter<T>	or(java.lang.Class<T> type, ComponentFilter<? super T>... operands) Creates a ComponentFilter that returns true if any of the supplied filters are true.

Methods inherited from class java.lang.Object

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

Constructor Detail

Filters

public Filters()

Method Detail

fieldEquals

public static <T extends EntityComponent> ComponentFilter<T> fieldEquals(java.lang.Class<T> type,
                                                                         java.lang.String field,
                                                                         java.lang.Object value)

Creates a ComponentFilter that returns true if the specified field of the specified component type matches the specified value. Returns false for all other cases: different type, field doesn't exist, or value is different. The value comparison is done with .equals(). Two null values are considered equal.

or

public static <T extends EntityComponent> ComponentFilter<T> or(java.lang.Class<T> type,
                                                                ComponentFilter<? super T>... operands)

Creates a ComponentFilter that returns true if any of the supplied filters are true. The OR filter will early out and stop at the first true filter. Child filters are evaluated in the order provided.

and

public static <T extends EntityComponent> ComponentFilter<T> and(java.lang.Class<T> type,
                                                                 ComponentFilter<? super T>... operands)

Creates a ComponentFilter that returns true if all of the supplied filters are true. The AND filter will early out and stop at the first false filter. Child filters are evaluated in the order provided.