com.carrotsearch.console.jcommander.Parameter Maven / Gradle / Ivy
The newest version!
/*
* console-tools
*
* Copyright (C) 2019, Carrot Search s.c.
* All rights reserved.
*/
package com.carrotsearch.console.jcommander;
import static java.lang.annotation.ElementType.FIELD;
import static java.lang.annotation.ElementType.METHOD;
import com.carrotsearch.console.jcommander.converters.CommaParameterSplitter;
import com.carrotsearch.console.jcommander.converters.IParameterSplitter;
import com.carrotsearch.console.jcommander.converters.NoConverter;
import com.carrotsearch.console.jcommander.validators.NoValidator;
import com.carrotsearch.console.jcommander.validators.NoValueValidator;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;
@Retention(java.lang.annotation.RetentionPolicy.RUNTIME)
@Target({FIELD, METHOD})
@SuppressWarnings("all")
public @interface Parameter {
/**
* An array of allowed command line parameters (e.g. "-d", "--outputdir", etc...). If this
* attribute is omitted, the field it's annotating will receive all the unparsed options. There
* can only be at most one such annotation.
*/
String[] names() default {};
/** A description of this option. */
String description() default "";
/** Whether this option is required. */
boolean required() default false;
/** The key used to find the string in the message bundle. */
String descriptionKey() default "";
/**
* How many parameter values this parameter will consume. For example, an arity of 2 will allow
* "-pair value1 value2".
*/
int arity() default -1;
/**
* If true, this parameter is a password and it will be prompted on the console (if available).
*/
boolean password() default false;
/**
* The string converter to use for this field. If the field is of type List and not
* listConverter attribute was specified, JCommander will split the input in individual
* values and convert each of them separately.
*/
Class> converter() default NoConverter.class;
/**
* The list string converter to use for this field. If it's specified, the field has to be of type
* List and the converter needs to return a List that's compatible with that type.
*/
Class> listConverter() default NoConverter.class;
/** If true, this parameter won't appear in the usage(). */
boolean hidden() default false;
/** Validate the parameter found on the command line. */
Class validateWith() default NoValidator.class;
/** Validate the value for this parameter. */
Class validateValueWith() default NoValueValidator.class;
/** @return true if this parameter has a variable arity. See @{IVariableArity} */
boolean variableArity() default false;
/**
* What splitter to use (applicable only on fields of type List). By default, a comma
* separated splitter will be used.
*/
Class splitter() default CommaParameterSplitter.class;
/** If true, console will not echo typed input Used in conjunction with password = true */
boolean echoInput() default false;
/**
* If true, this parameter is for help. If such a parameter is specified, required parameters are
* no longer checked for their presence.
*/
boolean help() default false;
/**
* If true, this parameter can be overwritten through a file or another appearance of the
* parameter
*
* @return
*/
boolean forceNonOverwritable() default false;
}