com.tngtech.configbuilder.annotation.valueextractor.CommandLineValueDescriptor Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of config-builder Show documentation

The Config Builder creates fully configured instances of config classes, using values from various sources like properties files, command line arguments etc.

The newest version!

package com.tngtech.configbuilder.annotation.valueextractor;

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

/**
 * This annotation is used to mark a method as description text supplier for command line options.
 * The annotated method must be static and accept a single String parameter, which is the longOpt name of a command line option.
 * There may be at most one such method per class.

 * If a field is annotated with {@link com.tngtech.configbuilder.annotation.valueextractor.CommandLineValue} but has no description,
 * then this method is called to generate the description text.

 * Usage: @CommandLineValueDescriptor
 */
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface CommandLineValueDescriptor {}