com.artemis.annotations.All 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.

The newest version!

package com.artemis.annotations;

import com.artemis.*;

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

/**
 * Auto-configures fields or systems pertaining to aspects.
 *
 * 
On fields, this annotation works similar to {@link Wire}; fields are configured
 * during {@link EntitySystem#initialize()}, or explicitly via {@link World#inject(Object)}.
 *
 * On BaseEntitySystem subclasses, this annotation configures the aspects for the system,
 *  replacing the need to use constructor parameters./p>
 *
 * The annotated field must be one the following types: {@link Archetype}, {@link Aspect}, {@link Aspect.Builder},
 * {@link EntitySubscription}, {@link EntityTransmuter}.
 * 
 * This annotation can be combined with {@link One} and {@link Exclude}, 
 * but will be ignored if {@link AspectDescriptor} is present.
 *
 * Note on EntityTransmuters/Archetypes
 * {@link #value()} corresponds to create.
 * 
 * @see One
 * @see Exclude
 * @see AspectDescriptor
 * @see Wire
 * 
 * @author Ken Schosinsky
 * @author Felix Bridault
 */
@Retention(RetentionPolicy.RUNTIME)
@Target({ ElementType.FIELD, ElementType.METHOD, ElementType.TYPE })
@Documented
@UnstableApi
public @interface All {

	/**
	 * @return required types
	 */
	Class[] value() default {};
}