de.rhocas.featuregen.ap.FeatureIDEVariant Maven / Gradle / Ivy
package de.rhocas.featuregen.ap;
import de.rhocas.featuregen.ap.FeatureIDEVariantProcessor;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import org.eclipse.xtend.lib.macro.Active;
/**
* This active annotation is used to generate a variant from a FeatureIDE configuration file.
*
* @author Nils Christian Ehmke
*
* @since 1.0.0
*/
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.CLASS)
@Active(FeatureIDEVariantProcessor.class)
public @interface FeatureIDEVariant {
/**
* The path to a variant configuration file from the {@code FeatureIDE} containing a set of features. The file path is usually relative to the annotated
* class. If the file path starts with a slash ({@code /}), the file path is assumed to be relative to the project source folder. If this value is not
* given at all, it is assumed that the configuration model is contained in an xml file next to the annotated class with the same name as the annotated
* class.
*
* Please note: Due to restrictions of the active annotations, the file must be contained in the same project and the same source folder
* as the annotated class. Otherwise a build with various build tools might fail.
*
* @since 1.0.0
*/
public String value() default "";
/**
* The class which is annotated with {@link FeatureIDEFeatures}.
*
* @since 1.0.0
*/
public Class featuresClass();
}