com.artemis.annotations

Enum LinkPolicy.Policy

java.lang.Object

java.lang.Enum<LinkPolicy.Policy>

com.artemis.annotations.LinkPolicy.Policy

All Implemented Interfaces:

Serializable, Comparable<LinkPolicy.Policy>

Enclosing class:

LinkPolicy

public static enum LinkPolicy.Policy
extends Enum<LinkPolicy.Policy>

Enum Constant Summary

Enum Constants

Enum Constant and Description
CHECK_SOURCE Validates entity id.
CHECK_SOURCE_AND_TARGETS Validates source entity and any targets.
SKIP Performs no validation on this field's entity reference(s).

Method Summary

Modifier and Type	Method and Description
static LinkPolicy.Policy	valueOf(String name) Returns the enum constant of this type with the specified name.
static LinkPolicy.Policy[]	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

SKIP

public static final LinkPolicy.Policy SKIP

Performs no validation on this field's entity reference(s).

CHECK_SOURCE

public static final LinkPolicy.Policy CHECK_SOURCE

Validates entity id.

See Also:

LinkListener.onLinkEstablished(int, int), LinkListener.onLinkKilled(int, int)

CHECK_SOURCE_AND_TARGETS

public static final LinkPolicy.Policy CHECK_SOURCE_AND_TARGETS

Validates source entity and any targets. LinkListener.onTargetChanged(int, int, int) is only invoked if the field deals with a single entity.

See Also:

LinkListener.onTargetChanged(int, int, int), LinkListener.onTargetDead(int, int)

Method Detail

values

public static LinkPolicy.Policy[] 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 (LinkPolicy.Policy c : LinkPolicy.Policy.values())
    System.out.println(c);

Returns:

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

valueOf

public static LinkPolicy.Policy 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