Constant Field Values

Contents

• picocli.*

picocli.*

picocli.AutoComplete

Modifier and Type	Constant Field	Value
public static final int	EXIT_CODE_COMMAND_SCRIPT_EXISTS	2
public static final int	EXIT_CODE_COMPLETION_SCRIPT_EXISTS	3
public static final int	EXIT_CODE_EXECUTION_ERROR	4
public static final int	EXIT_CODE_INVALID_INPUT	1
public static final int	EXIT_CODE_SUCCESS	0
private static final java.lang.String	SCRIPT_FOOTER	"\n# Define a completion specification (a compspec) for the\n# `%1$s`, `%1$s.sh`, and `%1$s.bash` commands.\n# Uses the bash `complete` builtin (see [6]) to specify that shell function\n# `_complete_%1$s` is responsible for generating possible completions for the\n# current word on the command line.\n# The `-o default` option means that if the function generated no matches, the\n# default Bash completions and the Readline default filename completions are performed.\ncomplete -F _complete_%1$s -o default %1$s %1$s.sh %1$s.bash\n"
private static final java.lang.String	SCRIPT_HEADER	"#!/usr/bin/env bash\n#\n# %1$s Bash Completion\n# =======================\n#\n# Bash completion support for the `%1$s` command,\n# generated by [picocli](http://picocli.info/) version %2$s.\n#\n# Installation\n# ------------\n#\n# 1. Source all completion scripts in your .bash_profile\n#\n# cd $YOUR_APP_HOME/bin\n# for f in $(find . -name \"*_completion\"); do line=\". $(pwd)/$f\"; grep \"$line\" ~/.bash_profile || echo \"$line\" >> ~/.bash_profile; done\n#\n# 2. Open a new bash console, and type `%1$s [TAB][TAB]`\n#\n# 1a. Alternatively, if you have [bash-completion](https://github.com/scop/bash-completion) installed:\n# Place this file in a `bash-completion.d` folder:\n#\n# * /etc/bash-completion.d\n# * /usr/local/etc/bash-completion.d\n# * ~/bash-completion.d\n#\n# Documentation\n# -------------\n# The script is called by bash whenever [TAB] or [TAB][TAB] is pressed after\n# \'%1$s (..)\'. By reading entered command line parameters,\n# it determines possible bash completions and writes them to the COMPREPLY variable.\n# Bash then completes the user input if only one entry is listed in the variable or\n# shows the options if more than one is listed in COMPREPLY.\n#\n# References\n# ----------\n# [1] http://stackoverflow.com/a/12495480/1440785\n# [2] http://tiswww.case.edu/php/chet/bash/FAQ\n# [3] https://www.gnu.org/software/bash/manual/html_node/The-Shopt-Builtin.html\n# [4] http://zsh.sourceforge.net/Doc/Release/Options.html#index-COMPLETE_005fALIASES\n# [5] https://stackoverflow.com/questions/17042057/bash-check-element-in-array-for-elements-in-another-array/17042655#17042655\n# [6] https://www.gnu.org/software/bash/manual/html_node/Programmable-Completion.html#Programmable-Completion\n# [7] https://stackoverflow.com/questions/3249432/can-a-bash-tab-completion-script-be-used-in-zsh/27853970#27853970\n#\n\nif [ -n \"$BASH_VERSION\" ]; then\n # Enable programmable completion facilities when using bash (see [3])\n shopt -s progcomp\nelif [ -n \"$ZSH_VERSION\" ]; then\n # Make alias a distinct command for completion purposes when using zsh (see [4])\n setopt COMPLETE_ALIASES\n alias compopt=complete\n\n # Enable bash completion in zsh (see [7])\n autoload -U +X compinit && compinit\n autoload -U +X bashcompinit && bashcompinit\nfi\n\n# CompWordsContainsArray takes an array and then checks\n# if all elements of this array are in the global COMP_WORDS array.\n#\n# Returns zero (no error) if all elements of the array are in the COMP_WORDS array,\n# otherwise returns 1 (error).\nfunction CompWordsContainsArray() {\n declare -a localArray\n localArray=(\"$@\")\n local findme\n for findme in \"${localArray[@]}\"; do\n if ElementNotInCompWords \"$findme\"; then return 1; fi\n done\n return 0\n}\nfunction ElementNotInCompWords() {\n local findme=\"$1\"\n local element\n for element in \"${COMP_WORDS[@]}\"; do\n if [[ \"$findme\" = \"$element\" ]]; then return 1; fi\n done\n return 0\n}\n\n# The `currentPositionalIndex` function calculates the index of the current positional parameter.\n#\n# currentPositionalIndex takes three parameters:\n# the command name,\n# a space-separated string with the names of options that take a parameter, and\n# a space-separated string with the names of boolean options (that don\'t take any params).\n# When done, this function echos the current positional index to std_out.\n#\n# Example usage:\n# local currIndex=$(currentPositionalIndex \"mysubcommand\" \"$ARG_OPTS\" \"$FLAG_OPTS\")\nfunction currentPositionalIndex() {\n local commandName=\"$1\"\n local optionsWithArgs=\"$2\"\n local booleanOptions=\"$3\"\n local previousWord\n local result=0\n\n for i in $(seq $((COMP_CWORD - 1)) -1 0); do\n previousWord=${COMP_WORDS[i]}\n if [ \"${previousWord}\" = \"$commandName\" ]; then\n break\n fi\n if [[ \"${optionsWithArgs}\" =~ ${previousWord} ]]; then\n ((result-=2)) # Arg option and its value not counted as positional param\n elif [[ \"${booleanOptions}\" =~ ${previousWord} ]]; then\n ((result-=1)) # Flag option itself not counted as positional param\n fi\n ((result++))\n done\n echo \"$result\"\n}\n\n"

picocli.CommandLine

Modifier and Type	Constant Field	Value
public static final java.lang.String	VERSION	"4.6.1"

picocli.picocli.CommandLine.AutoHelpMixin

Modifier and Type	Constant Field	Value
private static final java.lang.String	KEY	"mixinStandardHelpOptions"

picocli.CommandLine.DuplicateNameException

Modifier and Type	Constant Field	Value
private static final long	serialVersionUID	-4126747467955626054L

picocli.CommandLine.DuplicateOptionAnnotationsException

Modifier and Type	Constant Field	Value
private static final long	serialVersionUID	-3355128012575075641L

picocli.CommandLine.ExecutionException

Modifier and Type	Constant Field	Value
private static final long	serialVersionUID	7764539594267007998L

picocli.CommandLine.ExitCode

Modifier and Type	Constant Field	Value
public static final int	OK	0
public static final int	SOFTWARE	1
public static final int	USAGE	2

picocli.CommandLine.Help

Modifier and Type	Constant Field	Value
protected static final java.lang.String	DEFAULT_COMMAND_NAME	"<main class>"
protected static final java.lang.String	DEFAULT_SEPARATOR	"="

picocli.CommandLine.Help.Ansi.IStyle

Modifier and Type	Constant Field	Value
public static final java.lang.String	CSI	"\u001b["

picocli.CommandLine.Help.TextTable

Modifier and Type	Constant Field	Value
private static final int	LONG_OPTION_COLUMN	3
private static final int	OPTION_SEPARATOR_COLUMN	2

picocli.CommandLine.InitializationException

Modifier and Type	Constant Field	Value
private static final long	serialVersionUID	8423014001666638895L

picocli.CommandLine.MaxValuesExceededException

Modifier and Type	Constant Field	Value
private static final long	serialVersionUID	6536145439570100641L

picocli.CommandLine.MissingParameterException

Modifier and Type	Constant Field	Value
private static final long	serialVersionUID	5075678535706338753L

picocli.CommandLine.MissingTypeConverterException

Modifier and Type	Constant Field	Value
private static final long	serialVersionUID	-6050931703233083760L

picocli.CommandLine.Model.ArgGroupSpec

Modifier and Type	Constant Field	Value
static final int	DEFAULT_ORDER	-1
private static final java.lang.String	NO_HEADING	"__no_heading__"
private static final java.lang.String	NO_HEADING_KEY	"__no_heading_key__"

picocli.CommandLine.Model.ArgSpec

Modifier and Type	Constant Field	Value
static final java.lang.String	DESCRIPTION_VARIABLE_COMPLETION_CANDIDATES	"${COMPLETION-CANDIDATES}"
static final java.lang.String	DESCRIPTION_VARIABLE_DEFAULT_VALUE	"${DEFAULT-VALUE}"
static final java.lang.String	DESCRIPTION_VARIABLE_FALLBACK_VALUE	"${FALLBACK-VALUE}"
static final java.lang.String	DESCRIPTION_VARIABLE_MAP_FALLBACK_VALUE	"${MAP-FALLBACK-VALUE}"
private static final java.lang.String	NO_DEFAULT_VALUE	"__no_default_value__"
static final java.lang.String	NULL_VALUE	"_NULL_"
private static final java.lang.String	UNSPECIFIED	"__unspecified__"

picocli.CommandLine.Model.CommandSpec

Modifier and Type	Constant Field	Value
public static final java.lang.String	DEFAULT_COMMAND_NAME	"<main class>"

picocli.CommandLine.Model.OptionSpec

Modifier and Type	Constant Field	Value
public static final java.lang.String	DEFAULT_FALLBACK_VALUE	""
static final int	DEFAULT_ORDER	-1

picocli.CommandLine.Model.ParserSpec

Modifier and Type	Constant Field	Value
static final java.lang.String	DEFAULT_END_OF_OPTIONS_DELIMITER	"--"
static final java.lang.String	DEFAULT_SEPARATOR	"="

picocli.picocli.CommandLine.Model.RuntimeTypeInfo

Modifier and Type	Constant Field	Value
static final java.lang.String	ERRORMSG	"Unsupported generic type %s. Only List<T>, Map<K,V>, Optional<T>, and Map<K, Optional<V>> are supported. Type parameters may be char[], a non-array type, or a wildcard type with an upper or lower bound."

picocli.CommandLine.Model.UsageMessageSpec

Modifier and Type	Constant Field	Value
static final java.lang.String	DEFAULT_COMMAND_LIST_HEADING	"Commands:%n"
static final char	DEFAULT_REQUIRED_OPTION_MARKER	32
static final java.lang.String	DEFAULT_SINGLE_VALUE	""
private static final double	DEFAULT_SYNOPSIS_AUTO_INDENT_THRESHOLD	0.5
static final java.lang.String	DEFAULT_SYNOPSIS_HEADING	"Usage: "
private static final int	DEFAULT_SYNOPSIS_INDENT	-1
static final java.lang.String	DEFAULT_SYNOPSIS_SUBCOMMANDS	"[COMMAND]"
static final int	DEFAULT_USAGE_LONG_OPTIONS_WIDTH	20
public static final int	DEFAULT_USAGE_WIDTH	80
private static final double	MAX_SYNOPSIS_AUTO_INDENT_THRESHOLD	0.9
private static final int	MINIMUM_USAGE_WIDTH	55
public static final java.lang.String	SECTION_KEY_AT_FILE_PARAMETER	"atFileParameterList"
public static final java.lang.String	SECTION_KEY_COMMAND_LIST	"commandList"
public static final java.lang.String	SECTION_KEY_COMMAND_LIST_HEADING	"commandListHeading"
public static final java.lang.String	SECTION_KEY_DESCRIPTION	"description"
public static final java.lang.String	SECTION_KEY_DESCRIPTION_HEADING	"descriptionHeading"
public static final java.lang.String	SECTION_KEY_END_OF_OPTIONS	"endOfOptionsList"
public static final java.lang.String	SECTION_KEY_EXIT_CODE_LIST	"exitCodeList"
public static final java.lang.String	SECTION_KEY_EXIT_CODE_LIST_HEADING	"exitCodeListHeading"
public static final java.lang.String	SECTION_KEY_FOOTER	"footer"
public static final java.lang.String	SECTION_KEY_FOOTER_HEADING	"footerHeading"
public static final java.lang.String	SECTION_KEY_HEADER	"header"
public static final java.lang.String	SECTION_KEY_HEADER_HEADING	"headerHeading"
public static final java.lang.String	SECTION_KEY_OPTION_LIST	"optionList"
public static final java.lang.String	SECTION_KEY_OPTION_LIST_HEADING	"optionListHeading"
public static final java.lang.String	SECTION_KEY_PARAMETER_LIST	"parameterList"
public static final java.lang.String	SECTION_KEY_PARAMETER_LIST_HEADING	"parameterListHeading"
public static final java.lang.String	SECTION_KEY_SYNOPSIS	"synopsis"
public static final java.lang.String	SECTION_KEY_SYNOPSIS_HEADING	"synopsisHeading"

picocli.CommandLine.MutuallyExclusiveArgsException

Modifier and Type	Constant Field	Value
private static final long	serialVersionUID	-5557715106221420986L

picocli.CommandLine.Option

Modifier and Type	Constant Field	Value
public static final java.lang.String	NULL_VALUE	"_NULL_"

picocli.CommandLine.OverwrittenOptionException

Modifier and Type	Constant Field	Value
private static final long	serialVersionUID	1338029208271055776L

picocli.CommandLine.ParameterException

Modifier and Type	Constant Field	Value
private static final long	serialVersionUID	1477112829129763139L

picocli.CommandLine.ParameterIndexGapException

Modifier and Type	Constant Field	Value
private static final long	serialVersionUID	-1520981133257618319L

picocli.CommandLine.Parameters

Modifier and Type	Constant Field	Value
public static final java.lang.String	NULL_VALUE	"_NULL_"

picocli.CommandLine.PicocliException

Modifier and Type	Constant Field	Value
private static final long	serialVersionUID	-2574128880125050818L

picocli.CommandLine.TypeConversionException

Modifier and Type	Constant Field	Value
private static final long	serialVersionUID	4251973913816346114L

picocli.CommandLine.UnmatchedArgumentException

Modifier and Type	Constant Field	Value
private static final long	serialVersionUID	-8700426380701452440L

picocli.codegen.*

picocli.codegen.annotation.processing.AbstractCommandSpecProcessor

Modifier and Type	Constant Field	Value
private static final java.lang.String	COMMAND_DEFAULT_NAME	"<main class>"

picocli.codegen.aot.graalvm.ReflectionConfigGenerator

Modifier and Type	Constant Field	Value
private static final java.lang.String	REFLECTED_BINDING_FIELD_SCOPE	"scope"
private static final java.lang.String	REFLECTED_FIELD_BINDING_CLASS	"picocli.CommandLine$Model$FieldBinding"
private static final java.lang.String	REFLECTED_FIELD_BINDING_FIELD	"field"
private static final java.lang.String	REFLECTED_METHOD_BINDING_CLASS	"picocli.CommandLine$Model$MethodBinding"
private static final java.lang.String	REFLECTED_METHOD_BINDING_METHOD	"method"
private static final java.lang.String	REFLECTED_PROXY_METHOD_BINDING_CLASS	"picocli.CommandLine$Model$PicocliInvocationHandler$ProxyBinding"
private static final java.lang.String	SYSPROP_CODEGEN_EXCLUDES	"picocli.codegen.excludes"

picocli.codegen.aot.graalvm.processor.picocli.codegen.aot.graalvm.processor.AbstractGenerator

Modifier and Type	Constant Field	Value
public static final java.lang.String	OPTION_VERBOSE	"verbose"

picocli.codegen.aot.graalvm.processor.NativeImageConfigGeneratorProcessor

Modifier and Type	Constant Field	Value
public static final java.lang.String	BASE_PATH	"META-INF/native-image/picocli-generated/"
public static final java.lang.String	OPTION_PROJECT	"project"

picocli.codegen.aot.graalvm.processor.picocli.codegen.aot.graalvm.processor.ProxyConfigGen

Modifier and Type	Constant Field	Value
public static final java.lang.String	OPTION_DISABLE	"disable.proxy.config"
public static final java.lang.String	OPTION_INTERFACE_CLASSES	"other.proxy.interfaces"

picocli.codegen.aot.graalvm.processor.picocli.codegen.aot.graalvm.processor.ReflectConfigGen

Modifier and Type	Constant Field	Value
public static final java.lang.String	OPTION_DISABLE	"disable.reflect.config"

picocli.codegen.aot.graalvm.processor.picocli.codegen.aot.graalvm.processor.ResourceConfigGen

Modifier and Type	Constant Field	Value
public static final java.lang.String	OPTION_BUNDLES	"other.resource.bundles"
public static final java.lang.String	OPTION_DISABLE	"disable.resource.config"
public static final java.lang.String	OPTION_RESOURCE_REGEX	"other.resource.patterns"

picocli.codegen.docgen.manpage.ManPageGenerator

Modifier and Type	Constant Field	Value
static final int	EXIT_CODE_TEMPLATE_EXISTS	4