com.artemis.annotations.One 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.Component;

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

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

}