com.artemis.annotations.LinkPolicy Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of artemis-odb Show documentation

Fork of Artemis Entity System Framework.

There is a newer version: 2.3.0

package com.artemis.annotations;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * Annotation for entity-referencing fields in component types. This annotation
 * allows overriding the default link policy. Fields referencing a single
 * entity - int or {@link com.artemis.Entity} - default to
 * {@link Policy#CHECK_SOURCE_AND_TARGETS}, while Bag and IntBag of entities are
 * assigned {@link Policy#CHECK_SOURCE}.
 */
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
public @interface LinkPolicy {
	Policy value();

	enum Policy {
		/**
		 * Performs no validation on this field's entity reference(s).
		 */
		SKIP,

		/**
		 * Validates entity id.
		 *
		 * @see com.artemis.link.LinkListener#onLinkEstablished(int, int)
		 * @see com.artemis.link.LinkListener#onLinkKilled(int, int)
		 */
		CHECK_SOURCE,

		/**
		 * Validates source entity and any targets.
		 * {@link com.artemis.link.LinkListener#onTargetChanged(int, int, int)} is
		 * only invoked if the field deals with a single entity.
		 *
		 *  @see com.artemis.link.LinkListener#onTargetChanged(int, int, int)
		 *  @see com.artemis.link.LinkListener#onTargetDead(int, int)
		 */
		CHECK_SOURCE_AND_TARGETS
	}
}