diff --git a/docs/apidocs/allclasses-index.html b/docs/apidocs/allclasses-index.html index 253a4700..3e14f035 100644 --- a/docs/apidocs/allclasses-index.html +++ b/docs/apidocs/allclasses-index.html @@ -1,535 +1,303 @@ -
ByteOrder
String
InetAddress
IStringConverter
Parameter
Summary:
Detail:
IUsageFormatter
UnixStyleUsageFormatter
public class DefaultUsageFormatter -extends java.lang.Object -implements IUsageFormatter
DefaultUsageFormatter(JCommander commander)
DefaultUsageFormatter(JCommander commander)
void
appendAllParametersDetails(java.lang.StringBuilder out, - int indentCount, - java.lang.String indent, - java.util.List<ParameterDescription> sortedParameters)
appendAllParametersDetails(StringBuilder out, + int indentCount, + String indent, + List<ParameterDescription> sortedParameters)
appendCommands(java.lang.StringBuilder out, - int indentCount, - int descriptionIndent, - java.lang.String indent)
appendCommands(StringBuilder out, + int indentCount, + int descriptionIndent, + String indent)
appendMainLine(java.lang.StringBuilder out, - boolean hasOptions, - boolean hasCommands, - int indentCount, - java.lang.String indent)
appendMainLine(StringBuilder out, + boolean hasOptions, + boolean hasCommands, + int indentCount, + String indent)
java.lang.String
getCommandDescription(java.lang.String commandName)
getCommandDescription(String commandName)
static java.lang.String
getI18nString(java.util.ResourceBundle bundle, - java.lang.String key, - java.lang.String def)
static String
getI18nString(ResourceBundle bundle, + String key, + String def)
s(int count)
s(int count)
usage(java.lang.String commandName)
final void
usage(String commandName)
JCommander.getConsole()
usage(java.lang.StringBuilder out)
usage(StringBuilder out)
usage(java.lang.StringBuilder out, - java.lang.String indent)
usage(StringBuilder out, + String indent)
usage(java.lang.String commandName, - java.lang.StringBuilder out)
usage(String commandName, + StringBuilder out)
usage(java.lang.String commandName, - java.lang.StringBuilder out, - java.lang.String indent)
usage(String commandName, + StringBuilder out, + String indent)
wrapDescription(java.lang.StringBuilder out, - int indent, - int currentLineIndent, - java.lang.String description)
wrapDescription(StringBuilder out, + int indent, + int currentLineIndent, + String description)
JCommander.getColumnSize()
wrapDescription(java.lang.StringBuilder out, - int indent, - java.lang.String description)
wrapDescription(StringBuilder out, + int indent, + String description)
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
public DefaultUsageFormatter(JCommander commander)
public final void usage(java.lang.String commandName)
usage
public final void usage(java.lang.String commandName, - java.lang.StringBuilder out)
public final void usage(java.lang.StringBuilder out)
public final void usage(java.lang.String commandName, - java.lang.StringBuilder out, - java.lang.String indent)
public void usage(java.lang.StringBuilder out, - java.lang.String indent)
appendAllParametersDetails(StringBuilder, int, String, List)
appendCommands(StringBuilder, int, int, String)
public void appendMainLine(java.lang.StringBuilder out, - boolean hasOptions, - boolean hasCommands, - int indentCount, - java.lang.String indent)
out
hasOptions
hasCommands
indentCount
indent
public void appendAllParametersDetails(java.lang.StringBuilder out, - int indentCount, - java.lang.String indent, - java.util.List<ParameterDescription> sortedParameters)
sortedParameters
public void appendCommands(java.lang.StringBuilder out, - int indentCount, - int descriptionIndent, - java.lang.String indent)
JCommander.getRawCommands()
JCommander.findCommandByAlias(String)
descriptionIndent
public java.lang.String getCommandDescription(java.lang.String commandName)
JCommander.getBundle()
getCommandDescription
commandName
public void wrapDescription(java.lang.StringBuilder out, - int indent, - int currentLineIndent, - java.lang.String description)
currentLineIndent
description
public void wrapDescription(java.lang.StringBuilder out, - int indent, - java.lang.String description)
wrapDescription(StringBuilder, int, int, String)
public static java.lang.String getI18nString(java.util.ResourceBundle bundle, - java.lang.String key, - java.lang.String def)
public static java.lang.String s(int count)
@Retention(RUNTIME) -@Target(FIELD) -public @interface DynamicParameter
assignment
category
descriptionKey
boolean
hidden
java.lang.String[]
names
String[]
int
order
required
java.lang.Class<? extends IValueValidator>[]
validateValueWith
java.lang.Class<? extends IParameterValidator>[]
validateWith
Class<? extends IValueValidator>[]
Class<? extends IParameterValidator>[]
java.lang.String[] names
{}
boolean required
false
java.lang.String description
""
java.lang.String descriptionKey
boolean hidden
java.lang.Class<? extends IParameterValidator>[] validateWith
{com.beust.jcommander.validators.NoValidator.class}
java.lang.String assignment
"="
java.lang.Class<? extends IValueValidator>[] validateValueWith
{com.beust.jcommander.validators.NoValueValidator.class}
int order
-1
java.lang.String category
public class FuzzyMap -extends java.lang.Object
FuzzyMap()
static <V> V
findInMap(java.util.Map<? extends com.beust.jcommander.FuzzyMap.IKey,V> map, - com.beust.jcommander.FuzzyMap.IKey name, - boolean caseSensitive, - boolean allowAbbreviations)
findInMap(Map<? extends com.beust.jcommander.FuzzyMap.IKey,V> map, + com.beust.jcommander.FuzzyMap.IKey name, + boolean caseSensitive, + boolean allowAbbreviations)
public FuzzyMap()
public static <V> V findInMap(java.util.Map<? extends com.beust.jcommander.FuzzyMap.IKey,V> map, - com.beust.jcommander.FuzzyMap.IKey name, - boolean caseSensitive, - boolean allowAbbreviations)
EnvironmentVariableDefaultProvider
PropertyFileDefaultProvider
public interface IDefaultProvider
getDefaultValueFor(java.lang.String optionName)
getDefaultValueFor(String optionName)
java.lang.String getDefaultValueFor(java.lang.String optionName)
optionName
public interface IMainParameter
ParameterDescription
getDescription()
ParameterDescription getDescription()
IParameterValidator2
NoValidator
PositiveInteger
public interface IParameterValidator
validate(java.lang.String name, - java.lang.String value)
validate(String name, + String value)
void validate(java.lang.String name, - java.lang.String value) - throws ParameterException
name
value
ParameterException
IParameterValidator
public interface IParameterValidator2 -extends IParameterValidator
validate(java.lang.String name, - java.lang.String value, - ParameterDescription pd)
validate(String name, + String value, + ParameterDescription pd)
validate
void validate(java.lang.String name, - java.lang.String value, - ParameterDescription pd) - throws ParameterException
pd
DefaultParameterizedParser
public interface IParameterizedParser
java.util.List<Parameterized>
parseArg(java.lang.Object annotatedObj)
List<Parameterized>
parseArg(Object annotatedObj)
java.util.List<Parameterized> parseArg(java.lang.Object annotatedObj)
annotatedObj
public interface IParametersValidator
validate(java.util.Map<java.lang.String,java.lang.Object> parameters)
validate(Map<String,Object> parameters)
void validate(java.util.Map<java.lang.String,java.lang.Object> parameters) - throws ParameterException
parameters
BaseConverter
BigDecimalConverter
BooleanConverter
ByteOrderConverter
CharArrayConverter
CharsetConverter
DefaultListConverter
DoubleConverter
EnumConverter
FileConverter
FloatConverter
InetAddressConverter
IntegerConverter
ISO8601DateConverter
LongConverter
NoConverter
PathConverter
StringConverter
URIConverter
URLConverter
public interface IStringConverter<T>
T
convert(java.lang.String value)
convert(String value)
T convert(java.lang.String value)
DefaultConverterFactory
public interface IStringConverterFactory
IStringConverterInstanceFactory
java.lang.Class<? extends IStringConverter<?>>
getConverter(java.lang.Class<?> forType)
Class<? extends IStringConverter<?>>
getConverter(Class<?> forType)
java.lang.Class<? extends IStringConverter<?>> getConverter(java.lang.Class<?> forType)
public interface IStringConverterInstanceFactory
IStringConverterFactory
IStringConverter<?>
getConverterInstance(Parameter parameter, - java.lang.Class<?> forType, - java.lang.String optionName)
getConverterInstance(Parameter parameter, + Class<?> forType, + String optionName)
parameter
forType
IStringConverter<?> getConverterInstance(Parameter parameter, - java.lang.Class<?> forType, - java.lang.String optionName)
DefaultUsageFormatter
public interface IUsageFormatter
void usage(java.lang.String commandName)
void usage(java.lang.String commandName, - java.lang.StringBuilder out)
void usage(java.lang.StringBuilder out)
void usage(java.lang.String commandName, - java.lang.StringBuilder out, - java.lang.String indent)
void usage(java.lang.StringBuilder out, - java.lang.String indent)
java.lang.String getCommandDescription(java.lang.String commandName)
NoValueValidator
public interface IValueValidator<T>
validate(java.lang.String name, - T value)
validate(String name, + T value)
void validate(java.lang.String name, - T value) - throws ParameterException
public interface IVariableArity
processVariableArity(java.lang.String optionName, - java.lang.String[] options)
processVariableArity(String optionName, + String[] options)
int processVariableArity(java.lang.String optionName, - java.lang.String[] options)
options
JCommander
public static class JCommander.Builder -extends java.lang.Object
Builder()
JCommander.Builder
acceptUnknownOptions(boolean b)
addCommand(java.lang.Object command)
addCommand(java.lang.String name, - java.lang.Object command, - java.lang.String... aliases)
addConverterFactory(IStringConverterFactory factory)
acceptUnknownOptions(boolean b)
addCommand(Object command)
addCommand(String name, + Object command, + String... aliases)
addConverterFactory(IStringConverterFactory factory)
addConverterInstanceFactory(IStringConverterInstanceFactory factory)
addObject(java.lang.Object o)
addConverterInstanceFactory(IStringConverterInstanceFactory factory)
addObject(Object o)
allowAbbreviatedOptions(boolean b)
allowParameterOverwriting(boolean b)
args(java.lang.String[] args)
atFileCharset(java.nio.charset.Charset charset)
build()
columnSize(int columnSize)
console(Console console)
defaultProvider(IDefaultProvider provider)
allowAbbreviatedOptions(boolean b)
allowParameterOverwriting(boolean b)
args(String[] args)
atFileCharset(Charset charset)
columnSize(int columnSize)
console(Console console)
defaultProvider(IDefaultProvider provider)
expandAtSign(java.lang.Boolean expand)
expandAtSign(Boolean expand)
@file
programName(java.lang.String name)
programName(String name)
resourceBundle(java.util.ResourceBundle bundle)
ResourceBundle
usageFormatter(IUsageFormatter usageFormatter)
verbose(int verbose)
resourceBundle(ResourceBundle bundle)
usageFormatter(IUsageFormatter usageFormatter)
verbose(int verbose)
public Builder()
public JCommander.Builder addObject(java.lang.Object o)
o
object
Iterable
public JCommander.Builder resourceBundle(java.util.ResourceBundle bundle)
null
public JCommander.Builder args(java.lang.String[] args)
public JCommander.Builder console(Console console)
public JCommander.Builder expandAtSign(java.lang.Boolean expand)
public JCommander.Builder programName(java.lang.String name)
public JCommander.Builder columnSize(int columnSize)
public JCommander.Builder defaultProvider(IDefaultProvider provider)
public JCommander.Builder addConverterFactory(IStringConverterFactory factory)
factory
public JCommander.Builder verbose(int verbose)
public JCommander.Builder allowAbbreviatedOptions(boolean b)
public JCommander.Builder acceptUnknownOptions(boolean b)
public JCommander.Builder allowParameterOverwriting(boolean b)
public JCommander.Builder atFileCharset(java.nio.charset.Charset charset)
public JCommander.Builder addConverterInstanceFactory(IStringConverterInstanceFactory factory)
public JCommander.Builder addCommand(java.lang.Object command)
public JCommander.Builder addCommand(java.lang.String name, - java.lang.Object command, - java.lang.String... aliases)
public JCommander.Builder usageFormatter(IUsageFormatter usageFormatter)
public JCommander build()
public static final class JCommander.ProgramName -extends java.lang.Object
equals(java.lang.Object obj)
getDisplayName()
getName()
hashCode()
toString()
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
equals(Object obj)
public java.lang.String getName()
public java.lang.String getDisplayName()
public int hashCode()
hashCode
java.lang.Object
Object
public boolean equals(java.lang.Object obj)
equals
public java.lang.String toString()
toString
public class JCommander -extends java.lang.Object
static class
JCommander.ProgramName
static final class
DEBUG_PROPERTY
protected IParameterizedParser
parameterizedParser
static final String
JCommander()
JCommander(java.lang.Object object)
JCommander(java.lang.Object object, - java.lang.String... args)
JCommander(java.lang.Object object, - java.util.ResourceBundle bundle)
JCommander(java.lang.Object object, - java.util.ResourceBundle bundle, - java.lang.String... args)
JCommander(Object object)
JCommander(Object object, + String... args)
JCommander(Object object, + ResourceBundle bundle)
JCommander(Object object, + ResourceBundle bundle, + String... args)
addCommand(java.lang.Object object)
addCommand(java.lang.String name, - java.lang.Object object)
addCommand(Object object)
addCommand(String name, + Object object)
addCommand(java.lang.String name, - java.lang.Object object, - java.lang.String... aliases)
addCommand(String name, + Object object, + String... aliases)
addConverterFactory(IStringConverterFactory converterFactory)
addConverterFactory(IStringConverterFactory converterFactory)
addConverterInstanceFactory(IStringConverterInstanceFactory converterInstanceFactory)
addConverterInstanceFactory(IStringConverterInstanceFactory converterInstanceFactory)
addObject(java.lang.Object object)
addObject(Object object)
convertValue(Parameterized parameterized, - java.lang.Class type, - java.lang.String optionName, - java.lang.String value)
createDescriptions()
convertValue(Parameterized parameterized, + Class type, + String optionName, + String value)
findCommandByAlias(java.lang.String commandOrAlias)
java.util.ResourceBundle
getBundle()
getColumnSize()
java.util.Map<java.lang.String,JCommander>
getCommands()
Console
getConsole()
java.util.Map<com.beust.jcommander.FuzzyMap.IKey,ParameterDescription>
getDescriptions()
java.util.Map<Parameterized,ParameterDescription>
getFields()
IMainParameter
getMainParameter()
getMainParameterDescription()
getMainParameterValue()
java.util.List<java.lang.Object>
getObjects()
com.beust.jcommander.JCommander.Options
getOptions()
java.util.Comparator<? super ParameterDescription>
getParameterDescriptionComparator()
java.util.List<ParameterDescription>
getParameters()
getParsedAlias()
findCommandByAlias(String commandOrAlias)
Map<String,JCommander>
Map<com.beust.jcommander.FuzzyMap.IKey,ParameterDescription>
Map<Parameterized,ParameterDescription>
List<Object>
Comparator<? super ParameterDescription>
List<ParameterDescription>
getParsedCommand()
getProgramDisplayName()
getProgramName()
java.util.Map<JCommander.ProgramName,JCommander>
getRawCommands()
java.util.List<java.lang.String>
getUnknownOptions()
getUsageFormatter()
Map<JCommander.ProgramName,JCommander>
List<String>
isParameterOverwritingAllowed()
static JCommander.Builder
newBuilder()
parse(java.lang.String... args)
parse(String... args)
parseWithoutValidation(java.lang.String... args)
parseWithoutValidation(String... args)
setAcceptUnknownOptions(boolean b)
setAllowAbbreviatedOptions(boolean b)
setAllowParameterOverwriting(boolean b)
setAtFileCharset(java.nio.charset.Charset charset)
setAcceptUnknownOptions(boolean b)
setAllowAbbreviatedOptions(boolean b)
setAllowParameterOverwriting(boolean b)
setAtFileCharset(Charset charset)
@files
setCaseSensitiveOptions(boolean b)
setColumnSize(int columnSize)
setConsole(Console console)
setDefaultProvider(IDefaultProvider defaultProvider)
setCaseSensitiveOptions(boolean b)
setColumnSize(int columnSize)
setConsole(Console console)
setDefaultProvider(IDefaultProvider defaultProvider)
setDescriptionsBundle(java.util.ResourceBundle bundle)
setExpandAtSign(boolean expandAtSign)
setDescriptionsBundle(ResourceBundle bundle)
setExpandAtSign(boolean expandAtSign)
setParameterDescriptionComparator(java.util.Comparator<? super ParameterDescription> c)
setParameterizedParser(IParameterizedParser parameterizedParser)
setProgramName(java.lang.String name)
setParameterDescriptionComparator(Comparator<? super ParameterDescription> c)
setParameterizedParser(IParameterizedParser parameterizedParser)
setProgramName(String name)
setProgramName(java.lang.String name, - java.lang.String... aliases)
setProgramName(String name, + String... aliases)
setUsageFormatter(IUsageFormatter usageFormatter)
setUsageFormatter(IUsageFormatter usageFormatter)
setVerbose(int verbose)
usage()
setVerbose(int verbose)
usageFormatter
public static final java.lang.String DEBUG_PROPERTY
protected IParameterizedParser parameterizedParser
public JCommander()
public JCommander(java.lang.Object object)
public JCommander(java.lang.Object object, - java.util.ResourceBundle bundle)
bundle
public JCommander(java.lang.Object object, - java.util.ResourceBundle bundle, - java.lang.String... args)
args
@Deprecated -public JCommander(java.lang.Object object, - java.lang.String... args)
public void setParameterizedParser(IParameterizedParser parameterizedParser)
public void setExpandAtSign(boolean expandAtSign)
public void setConsole(Console console)
public Console getConsole()
PrintStream
System.out
public final void addObject(java.lang.Object object)
public final void setDescriptionsBundle(java.util.ResourceBundle bundle)
public void parse(java.lang.String... args)
public void parseWithoutValidation(java.lang.String... args)
public void createDescriptions()
public java.lang.String getMainParameterDescription()
public void setProgramName(java.lang.String name)
public java.lang.String getProgramName()
public java.lang.String getProgramDisplayName()
public void setProgramName(java.lang.String name, - java.lang.String... aliases)
aliases
public void usage()
public void usage(java.lang.String commandName)
public void usage(java.lang.String commandName, - java.lang.StringBuilder out)
public void usage(java.lang.String commandName, - java.lang.StringBuilder out, - java.lang.String indent)
public void usage(java.lang.StringBuilder out)
public void setUsageFormatter(IUsageFormatter usageFormatter)
java.lang.IllegalArgumentException
IllegalArgumentException
public IUsageFormatter getUsageFormatter()
public com.beust.jcommander.JCommander.Options getOptions()
public java.util.Map<com.beust.jcommander.FuzzyMap.IKey,ParameterDescription> getDescriptions()
public IMainParameter getMainParameter()
public static JCommander.Builder newBuilder()
public java.util.Map<Parameterized,ParameterDescription> getFields()
public java.util.Comparator<? super ParameterDescription> getParameterDescriptionComparator()
public void setParameterDescriptionComparator(java.util.Comparator<? super ParameterDescription> c)
public void setColumnSize(int columnSize)
public int getColumnSize()
public java.util.ResourceBundle getBundle()
public java.util.List<ParameterDescription> getParameters()
public ParameterDescription getMainParameterValue()
public void setDefaultProvider(IDefaultProvider defaultProvider)
public void addConverterFactory(IStringConverterFactory converterFactory)
converterFactory
public void addConverterInstanceFactory(IStringConverterInstanceFactory converterInstanceFactory)
converterInstanceFactory
public java.lang.Object convertValue(Parameterized parameterized, - java.lang.Class type, - java.lang.String optionName, - java.lang.String value)
type
public void addCommand(java.lang.String name, - java.lang.Object object)
public void addCommand(java.lang.Object object)
public void addCommand(java.lang.String name, - java.lang.Object object, - java.lang.String... aliases)
public java.util.Map<java.lang.String,JCommander> getCommands()
public java.util.Map<JCommander.ProgramName,JCommander> getRawCommands()
public java.lang.String getParsedCommand()
public java.lang.String getParsedAlias()
public java.util.List<java.lang.Object> getObjects()
public JCommander findCommandByAlias(java.lang.String commandOrAlias)
public void setVerbose(int verbose)
public void setCaseSensitiveOptions(boolean b)
public void setAllowAbbreviatedOptions(boolean b)
public void setAcceptUnknownOptions(boolean b)
public java.util.List<java.lang.String> getUnknownOptions()
public void setAllowParameterOverwriting(boolean b)
public boolean isParameterOverwritingAllowed()
public void setAtFileCharset(java.nio.charset.Charset charset)
charset
java.io.Serializable
Serializable
public class MissingCommandException -extends ParameterException
MissingCommandException(java.lang.String message)
MissingCommandException(java.lang.String message, - java.lang.String command)
MissingCommandException(String message)
MissingCommandException(String message, + String command)
getUnknownCommand()
getJCommander, setJCommander, usage
addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
public MissingCommandException(java.lang.String message)
public MissingCommandException(java.lang.String message, - java.lang.String command)
public java.lang.String getUnknownCommand()
@Retention(RUNTIME) -@Target({FIELD,METHOD}) -public @interface Parameter
static int
DEFAULT_ARITY
arity
converter
defaultValueDescription
echoInput
forceNonOverwritable
help
listConverter
password
java.lang.Class<? extends IParameterSplitter>
splitter
Class<? extends IParameterSplitter>
variableArity
static final int
static final int DEFAULT_ARITY
java.lang.String defaultValueDescription
int arity
boolean password
java.lang.Class<? extends IStringConverter<?>> converter
com.beust.jcommander.converters.NoConverter.class
java.lang.Class<? extends IStringConverter<?>> listConverter
boolean variableArity
java.lang.Class<? extends IParameterSplitter> splitter
com.beust.jcommander.converters.CommaParameterSplitter.class
boolean echoInput
boolean help
boolean forceNonOverwritable
public class ParameterDescription -extends java.lang.Object
ParameterDescription(java.lang.Object object, - DynamicParameter annotation, - Parameterized parameterized, - java.util.ResourceBundle bundle, - JCommander jc)
ParameterDescription(java.lang.Object object, - Parameter annotation, - Parameterized parameterized, - java.util.ResourceBundle bundle, - JCommander jc)
ParameterDescription(Object object, + DynamicParameter annotation, + Parameterized parameterized, + ResourceBundle bundle, + JCommander jc)
ParameterDescription(Object object, + Parameter annotation, + Parameterized parameterized, + ResourceBundle bundle, + JCommander jc)
addValue(java.lang.String value)
addValue(java.lang.String value, - boolean isDefault)
addValue(String value)
addValue(String value, + boolean isDefault)
getCategory()
getDefault()
getDefaultValueDescription()
getLongestName()
getNames()
getObject()
WrappedParameter
getParameter()
getParameterAnnotation()
Parameterized
getParameterized()
isAssigned()
isDynamicParameter()
isHelp()
isNonOverwritableForced()
setAssigned(boolean b)
validateParameter(java.lang.Class<? extends IParameterValidator> validator, - java.lang.String name, - java.lang.String value)
validateValueParameter(java.lang.Class<? extends IValueValidator> validator, - java.lang.String name, - java.lang.Object value)
setAssigned(boolean b)
validateParameter(Class<? extends IParameterValidator> validator, + String name, + String value)
validateValueParameter(Class<? extends IValueValidator> validator, + String name, + Object value)
public ParameterDescription(java.lang.Object object, - DynamicParameter annotation, - Parameterized parameterized, - java.util.ResourceBundle bundle, - JCommander jc)
public ParameterDescription(java.lang.Object object, - Parameter annotation, - Parameterized parameterized, - java.util.ResourceBundle bundle, - JCommander jc)
public java.lang.String getLongestName()
public java.lang.Object getDefault()
public java.lang.Object getDefaultValueDescription()
public java.lang.String getDescription()
public java.lang.Object getObject()
public java.lang.String getNames()
public java.lang.String getCategory()
public WrappedParameter getParameter()
public Parameterized getParameterized()
public void addValue(java.lang.String value)
public boolean isAssigned()
public void setAssigned(boolean b)
public void addValue(java.lang.String value, - boolean isDefault)
public Parameter getParameterAnnotation()
public void validateValueParameter(java.lang.Class<? extends IValueValidator> validator, - java.lang.String name, - java.lang.Object value)
public void validateParameter(java.lang.Class<? extends IParameterValidator> validator, - java.lang.String name, - java.lang.String value)
public boolean isDynamicParameter()
public boolean isHelp()
public boolean isNonOverwritableForced()
MissingCommandException
public class ParameterException -extends java.lang.RuntimeException
ParameterException(java.lang.String string)
ParameterException(java.lang.String string, - java.lang.Throwable t)
ParameterException(java.lang.Throwable t)
ParameterException(String string)
ParameterException(String string, + Throwable t)
ParameterException(Throwable t)
getJCommander()
setJCommander(JCommander jc)
setJCommander(JCommander jc)
public ParameterException(java.lang.Throwable t)
public ParameterException(java.lang.String string)
public ParameterException(java.lang.String string, - java.lang.Throwable t)
public void setJCommander(JCommander jc)
public JCommander getJCommander()
public class Parameterized -extends java.lang.Object
Parameterized(WrappedParameter wp, - ParametersDelegate pd, - java.lang.reflect.Field field, - java.lang.reflect.Method method)
Parameterized(WrappedParameter wp, + ParametersDelegate pd, + Field field, + Method method)
java.lang.reflect.Type
findFieldGenericType()
get(java.lang.Object object)
ParametersDelegate
getDelegateAnnotation()
getGenericType()
java.lang.Class<?>
getType()
getWrappedParameter()
isDynamicParameter(java.lang.reflect.Field field)
static java.util.List<Parameterized>
parseArg(java.lang.Object arg)
set(java.lang.Object object, - java.lang.Object value)
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
Type
get(Object object)
Class<?>
isDynamicParameter(Field field)
static List<Parameterized>
parseArg(Object arg)
set(Object object, + Object value)
public Parameterized(WrappedParameter wp, - ParametersDelegate pd, - java.lang.reflect.Field field, - java.lang.reflect.Method method)
public static java.util.List<Parameterized> parseArg(java.lang.Object arg)
public WrappedParameter getWrappedParameter()
public java.lang.Class<?> getType()
public java.lang.Object get(java.lang.Object object)
public boolean isDynamicParameter(java.lang.reflect.Field field)
public void set(java.lang.Object object, - java.lang.Object value)
public ParametersDelegate getDelegateAnnotation()
public java.lang.reflect.Type getGenericType()
public Parameter getParameter()
public java.lang.reflect.Type findFieldGenericType()
@Retention(RUNTIME) -@Target(TYPE) -@Inherited -public @interface Parameters
commandDescription
JCommander.addCommand(java.lang.String, java.lang.Object)
JCommander.usage()
commandDescriptionKey
commandNames
java.lang.Class<? extends IParametersValidator>[]
parametersValidators
Class<? extends IParametersValidator>[]
resourceBundle
separators
java.lang.String resourceBundle
java.lang.String separators
" "
java.lang.String commandDescription
java.lang.String commandDescriptionKey
java.lang.String[] commandNames
java.lang.Class<? extends IParametersValidator>[] parametersValidators
@Retention(RUNTIME) -@Target(FIELD) -public @interface ParametersDelegate
When applied to a field all of its child fields annotated - with Parameter will be included during arguments + with Parameter will be included during arguments parsing.
Mainly useful when creating complex command based CLI interfaces, where several commands can share a set of arguments, but using object inheritance is not enough, due to no-multiple-inheritance - restriction. Using ParametersDelegate any number of + restriction. Using ParametersDelegate any number of command sets can be shared by using composition pattern.
Delegations can be chained (nested).
@Deprecated -@Retention(RUNTIME) -@Target(TYPE) -public @interface ResourceBundle
java.lang.String value
public class StringKey -extends java.lang.Object