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

import com.artemis.Component;
import com.artemis.EntityFactory;

/**
 * Associates components to {@link EntityFactory EntityFactories}, either by
 * annotating at the class or method level. For all methods declared by an
 * {@link EntityFactory}, the parameters must match fields declared by the component.
 * Only primitive, enum and string types are currently supported. The {@link UseSetter} annotation
 * can be employed when setter invocation is desirable. 
 * 
 * Annotated methods always work with a single component type, while multiple component
 * types can be given when annotation an {@link EntityFactory} interface. 
 * 
 * @see EntityFactory
 * @see Sticky
 * @see UseSetter
 */
@Retention(RetentionPolicy.CLASS)
@Target({ElementType.TYPE, ElementType.METHOD})
public @interface Bind {
	Class[] value();
}