com.github.egatlovs.variablemanager.annotations.FieldName Maven / Gradle / Ivy

Go to download
package com.github.egatlovs.variablemanager.annotations;

import java.lang.annotation.Retention;
import java.lang.annotation.Target;

import static java.lang.annotation.ElementType.FIELD;
import static java.lang.annotation.ElementType.TYPE;
import static java.lang.annotation.RetentionPolicy.RUNTIME;

/**
 * FieldName

 * 

 * You can annotate fields and classes with {@code @FieldName} to set a
 * custom name and prefix. The processing unit will recognize this and use that
 * name for the Fields name in the execution.

 * If name is set it will be used for the actual name of the field inside the
 * execution.

 * 

 * Note that if you use this Annotation the name is required. If you
 * don't annotate a field which will be processed the actual name of the field
 * will be used.

 * 

 * If prefix is set to some string the execution field will be named with the
 * prefix, an underscore and the specified name afterwards. 

 * 

 * Example: 

 * {@code prefix + "_" + name}

 * 

 * If prefix is set to null or is an empty String it will be ignored and the
 * execution field will be named with the name value you specified.

 * 

 * Default values:

 * name has no default value

 * prefix = ""

 *
 * @author egatlovs
 */
@Retention(RUNTIME)
@Target({TYPE, FIELD})
public @interface FieldName {

    String name();

    String prefix() default "";

}