com.artemis.annotations.AspectDescriptor 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 com.artemis.*;

import java.lang.annotation.*;

/**
 * Auto-configures fields pertaining to aspects. The annotated field
 * must be one the following types: {@link Archetype}, {@link Aspect}, {@link Aspect.Builder},
 * {@link EntitySubscription}, {@link EntityTransmuter}.
 *
 * This annotation works similar to {@link Wire}; fields are configured
 * during {@link EntitySystem#initialize()}, or explicitly via {@link World#inject(Object)}.
 *
 * Note on EntityTransmuters/Archetypes
 * all and exclude correspond to create/remove. Archetypes
 * only feature create. Any types specified in one are ignored.
 *
 * @see Wire
 */
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.FIELD})
@Documented
public @interface AspectDescriptor {
	/**
	 * @return required types
	 */
	Class[] all() default {};

	/**
	 * @return match at least one
	 */
	Class[] one() default {};

	/**
	 * @return excluding types
	 */
	Class[] exclude() default {};
}