agi.foundation.tracking

(agi.foundation.tracking-2024r3.jar)

Enum MatchingStrategy

java.lang.Object

java.lang.Enum<MatchingStrategy>

agi.foundation.tracking.MatchingStrategy

All Implemented Interfaces:

Enumeration, Serializable, Comparable<MatchingStrategy>

public enum MatchingStrategy
extends Enum<MatchingStrategy>
implements Enumeration

Indicates if an EntityFilterChain will place each entity in only the first EntityFilter it matches against or all filters in the Filters (get) collection.

Enum Constant Summary

Enum Constants

Enum Constant and Description
FIRST Indicates an entity will only be placed in the first EntityFilter that it matches in the Filters (get) collection.
MULTIPLE Indicates an entity will be placed in all EntityFilters<TEntity> that it matches in the Filters (get) collection.

Method Summary

Modifier and Type	Method and Description
static MatchingStrategy	getDefault() Get the enum constant that is considered to be the default.
static MatchingStrategy	getFromValue(int value) Get the enum constant that is associated with the given numeric value.
int	getValue() Get the numeric value associated with this enum constant.
static MatchingStrategy	valueOf(String name) Returns the enum constant of this type with the specified name.
static MatchingStrategy[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

FIRST

public static final MatchingStrategy FIRST

Indicates an entity will only be placed in the first EntityFilter that it matches in the Filters (get) collection.

MULTIPLE

public static final MatchingStrategy MULTIPLE

Indicates an entity will be placed in all EntityFilters<TEntity> that it matches in the Filters (get) collection.

Method Detail

values

public static MatchingStrategy[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (MatchingStrategy c : MatchingStrategy.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static MatchingStrategy valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getValue

public int getValue()

Get the numeric value associated with this enum constant.

Specified by:

getValue in interface Enumeration

Returns:

A numeric value.

getFromValue

@Nonnull
public static MatchingStrategy getFromValue(int value)

Get the enum constant that is associated with the given numeric value.

Parameters:

value - a numeric value.

Returns:

The enum constant associated with value.

getDefault

@Nonnull
public static MatchingStrategy getDefault()

Get the enum constant that is considered to be the default.

Returns:

The default enum constant.