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

/**
 * Customize how the fluid generator processes your class.
 *
 * Is ignored when your fluid generator is not used in your project.
 *
 * @author Daan van Yperen
 */
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
@Documented
public @interface Fluid {

    /**
     * Name to use as a prefix for all methods relating to this
     * component.
     *
     * If left empty artemis will use the default: classname starting
     * with lowercase character. MyPos.class: "myPos"
     */
    String name() default "";

    /**
     * If you are using getters with parameters, but you prefer the fluid
     * interface to just swallow the return value and return {@code E} instead,
     * set this to true.
     */
    boolean swallowGettersWithParameters() default false;

    /**
     * Exclude class from fluid interface.
     */
    boolean exclude() default false;
}