Index (jcommander 2.1 API)

A B C D E F G H I J L M N O P R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

acceptUnknownOptions(boolean) - Method in class com.beust.jcommander.JCommander.Builder
addCommand(Object) - Method in class com.beust.jcommander.JCommander
addCommand(Object) - Method in class com.beust.jcommander.JCommander.Builder
addCommand(String, Object) - Method in class com.beust.jcommander.JCommander: Add a command object.
addCommand(String, Object, String...) - Method in class com.beust.jcommander.JCommander: Add a command object and its aliases.
addCommand(String, Object, String...) - Method in class com.beust.jcommander.JCommander.Builder
addConverterFactory(IStringConverterFactory) - Method in class com.beust.jcommander.JCommander: Adds a factory to lookup string converters.
addConverterFactory(IStringConverterFactory) - Method in class com.beust.jcommander.JCommander.Builder: Adds a factory to lookup string converters.
addConverterInstanceFactory(IStringConverterInstanceFactory) - Method in class com.beust.jcommander.JCommander: Adds a factory to lookup string converters.
addConverterInstanceFactory(IStringConverterInstanceFactory) - Method in class com.beust.jcommander.JCommander.Builder
addObject(Object) - Method in class com.beust.jcommander.JCommander: Adds the provided arg object to the set of objects that this commander will parse arguments into.
addObject(Object) - Method in class com.beust.jcommander.JCommander.Builder: Adds the provided arg object to the set of objects that this commander will parse arguments into.
addValue(Parameterized, Object, Object) - Method in class com.beust.jcommander.WrappedParameter
addValue(Parameterized, Object, Object, Field) - Method in class com.beust.jcommander.WrappedParameter
addValue(String) - Method in class com.beust.jcommander.ParameterDescription
addValue(String, boolean) - Method in class com.beust.jcommander.ParameterDescription: Add the specified value to the field.
allowAbbreviatedOptions(boolean) - Method in class com.beust.jcommander.JCommander.Builder
allowParameterOverwriting(boolean) - Method in class com.beust.jcommander.JCommander.Builder
appendAllParametersDetails(StringBuilder, int, String, List<ParameterDescription>) - Method in class com.beust.jcommander.DefaultUsageFormatter: Appends the details of all parameters in the given order to the argument string builder, indenting every line with indentCount-many indent.
appendAllParametersDetails(StringBuilder, int, String, List<ParameterDescription>) - Method in class com.beust.jcommander.UnixStyleUsageFormatter: Appends the details of all parameters in the given order to the argument string builder, indenting every line with indentCount-many indent.
appendCommands(StringBuilder, int, int, String) - Method in class com.beust.jcommander.DefaultUsageFormatter: Appends the details of all commands to the argument string builder, indenting every line with indentCount-many indent.
appendMainLine(StringBuilder, boolean, boolean, int, String) - Method in class com.beust.jcommander.DefaultUsageFormatter: Appends the main line segment of the usage to the argument string builder, indenting every line with indentCount-many indent.
args(String[]) - Method in class com.beust.jcommander.JCommander.Builder
arity() - Element in annotation interface com.beust.jcommander.Parameter
arity() - Method in class com.beust.jcommander.WrappedParameter
assignment() - Element in annotation interface com.beust.jcommander.DynamicParameter: The character(s) used to assign the values.
atFileCharset(Charset) - Method in class com.beust.jcommander.JCommander.Builder

B

BaseConverter<T> - Class in com.beust.jcommander.converters: Base class for converters that store the name of the option.
BaseConverter(String) - Constructor for class com.beust.jcommander.converters.BaseConverter
BigDecimalConverter - Class in com.beust.jcommander.converters: Converts a String to a BigDecimal.
BigDecimalConverter(String) - Constructor for class com.beust.jcommander.converters.BigDecimalConverter
BooleanConverter - Class in com.beust.jcommander.converters: Converts a string to a boolean.
BooleanConverter(String) - Constructor for class com.beust.jcommander.converters.BooleanConverter
build() - Method in class com.beust.jcommander.JCommander.Builder
Builder() - Constructor for class com.beust.jcommander.JCommander.Builder
ByteOrderConverter - Class in com.beust.jcommander.converters: Converts a String to a ByteOrder.
ByteOrderConverter() - Constructor for class com.beust.jcommander.converters.ByteOrderConverter

C

category() - Element in annotation interface com.beust.jcommander.DynamicParameter: If specified, the category name will be used to order the description of this parameter when usage() is invoked before the number order() is used.
category() - Element in annotation interface com.beust.jcommander.Parameter: If specified, the category name will be used to order the description of this parameter when usage() is invoked before the number order() is used.
category() - Method in class com.beust.jcommander.WrappedParameter
CharArrayConverter - Class in com.beust.jcommander.converters: Converts a String to a char[].
CharArrayConverter() - Constructor for class com.beust.jcommander.converters.CharArrayConverter
CharsetConverter - Class in com.beust.jcommander.converters: Converts a String to a Charset.
CharsetConverter() - Constructor for class com.beust.jcommander.converters.CharsetConverter
columnSize(int) - Method in class com.beust.jcommander.JCommander.Builder
com.beust.jcommander - package com.beust.jcommander
com.beust.jcommander.converters - package com.beust.jcommander.converters
com.beust.jcommander.defaultprovider - package com.beust.jcommander.defaultprovider
com.beust.jcommander.internal - package com.beust.jcommander.internal
com.beust.jcommander.parser - package com.beust.jcommander.parser
com.beust.jcommander.validators - package com.beust.jcommander.validators
commandDescription() - Element in annotation interface com.beust.jcommander.Parameters: If the annotated class was added to JCommander as a command with JCommander.addCommand(java.lang.String, java.lang.Object), then this string will be displayed in the description when JCommander.usage() is invoked.
commandDescriptionKey() - Element in annotation interface com.beust.jcommander.Parameters
commandNames() - Element in annotation interface com.beust.jcommander.Parameters: An array of allowed command names.
CommaParameterSplitter - Class in com.beust.jcommander.converters
CommaParameterSplitter() - Constructor for class com.beust.jcommander.converters.CommaParameterSplitter
console(Console) - Method in class com.beust.jcommander.JCommander.Builder
Console - Interface in com.beust.jcommander.internal
convert(String) - Method in class com.beust.jcommander.converters.BigDecimalConverter
convert(String) - Method in class com.beust.jcommander.converters.BooleanConverter
convert(String) - Method in class com.beust.jcommander.converters.ByteOrderConverter
convert(String) - Method in class com.beust.jcommander.converters.CharArrayConverter
convert(String) - Method in class com.beust.jcommander.converters.CharsetConverter
convert(String) - Method in class com.beust.jcommander.converters.DefaultListConverter
convert(String) - Method in class com.beust.jcommander.converters.DoubleConverter
convert(String) - Method in class com.beust.jcommander.converters.EnumConverter
convert(String) - Method in class com.beust.jcommander.converters.FileConverter
convert(String) - Method in class com.beust.jcommander.converters.FloatConverter
convert(String) - Method in class com.beust.jcommander.converters.InetAddressConverter
convert(String) - Method in class com.beust.jcommander.converters.IntegerConverter
convert(String) - Method in class com.beust.jcommander.converters.ISO8601DateConverter
convert(String) - Method in class com.beust.jcommander.converters.LongConverter
convert(String) - Method in class com.beust.jcommander.converters.NoConverter
convert(String) - Method in class com.beust.jcommander.converters.PathConverter
convert(String) - Method in class com.beust.jcommander.converters.StringConverter
convert(String) - Method in class com.beust.jcommander.converters.URIConverter
convert(String) - Method in class com.beust.jcommander.converters.URLConverter
convert(String) - Method in interface com.beust.jcommander.IStringConverter
converter() - Element in annotation interface com.beust.jcommander.Parameter: The string converter to use for this field.
convertValue(Parameterized, Class, String, String) - Method in class com.beust.jcommander.JCommander
createDescriptions() - Method in class com.beust.jcommander.JCommander: Create the ParameterDescriptions for all the \@Parameter found.

D

DEBUG_PROPERTY - Static variable in class com.beust.jcommander.JCommander
DEFAULT_ARITY - Static variable in annotation interface com.beust.jcommander.Parameter: How many parameter values this parameter will consume.
DEFAULT_FILE_NAME - Static variable in class com.beust.jcommander.defaultprovider.PropertyFileDefaultProvider
DefaultConsole - Class in com.beust.jcommander.internal
DefaultConsole() - Constructor for class com.beust.jcommander.internal.DefaultConsole
DefaultConsole(PrintStream) - Constructor for class com.beust.jcommander.internal.DefaultConsole
DefaultConverterFactory - Class in com.beust.jcommander.internal
DefaultConverterFactory() - Constructor for class com.beust.jcommander.internal.DefaultConverterFactory
DefaultListConverter<T> - Class in com.beust.jcommander.converters: A converter to obtain a list of elements.
DefaultListConverter(IParameterSplitter, IStringConverter<T>) - Constructor for class com.beust.jcommander.converters.DefaultListConverter: Constructs a new converter.
DefaultParameterizedParser - Class in com.beust.jcommander.parser: Pulled from the JCommander where is reflects the object to determine the Parameter annotations.
DefaultParameterizedParser() - Constructor for class com.beust.jcommander.parser.DefaultParameterizedParser
defaultProvider(IDefaultProvider) - Method in class com.beust.jcommander.JCommander.Builder: Define the default provider for this instance.
DefaultUsageFormatter - Class in com.beust.jcommander: The default usage formatter.
DefaultUsageFormatter(JCommander) - Constructor for class com.beust.jcommander.DefaultUsageFormatter
defaultValueDescription() - Element in annotation interface com.beust.jcommander.Parameter: Description of default value.
description() - Element in annotation interface com.beust.jcommander.DynamicParameter: A description of this option.
description() - Element in annotation interface com.beust.jcommander.Parameter: A description of this option.
descriptionKey() - Element in annotation interface com.beust.jcommander.DynamicParameter: The key used to find the string in the message bundle.
descriptionKey() - Element in annotation interface com.beust.jcommander.Parameter: The key used to find the string in the message bundle.
DoubleConverter - Class in com.beust.jcommander.converters: Convert a string to a double.
DoubleConverter(String) - Constructor for class com.beust.jcommander.converters.DoubleConverter
DynamicParameter - Annotation Interface in com.beust.jcommander

E

echoInput() - Element in annotation interface com.beust.jcommander.Parameter: If true, console will not echo typed input Used in conjunction with password = true
echoInput() - Method in class com.beust.jcommander.WrappedParameter
EnumConverter<T> - Class in com.beust.jcommander.converters: A converter to parse enums
EnumConverter(String, Class<T>) - Constructor for class com.beust.jcommander.converters.EnumConverter: Constructs a new converter.
EnvironmentVariableDefaultProvider - Class in com.beust.jcommander.defaultprovider: A default provider that reads its default values from an environment variable.
EnvironmentVariableDefaultProvider() - Constructor for class com.beust.jcommander.defaultprovider.EnvironmentVariableDefaultProvider: Creates a default provider reading the environment variable JCOMMANDER_OPTS using the prefixes pattern -/.
EnvironmentVariableDefaultProvider(String, String) - Constructor for class com.beust.jcommander.defaultprovider.EnvironmentVariableDefaultProvider: Creates a default provider reading the specified environment variable using the specified prefixes pattern.
equals(Object) - Method in class com.beust.jcommander.JCommander.ProgramName
equals(Object) - Method in class com.beust.jcommander.Parameterized
equals(Object) - Method in class com.beust.jcommander.StringKey
expandAtSign(Boolean) - Method in class com.beust.jcommander.JCommander.Builder: Disables expanding @file.

F

FileConverter - Class in com.beust.jcommander.converters: Convert a string into a file.
FileConverter() - Constructor for class com.beust.jcommander.converters.FileConverter
findCommandByAlias(String) - Method in class com.beust.jcommander.JCommander
findFieldGenericType() - Method in class com.beust.jcommander.Parameterized
findInMap(Map<? extends FuzzyMap.IKey, V>, FuzzyMap.IKey, boolean, boolean) - Static method in class com.beust.jcommander.FuzzyMap
FloatConverter - Class in com.beust.jcommander.converters: Convert a string to a float.
FloatConverter(String) - Constructor for class com.beust.jcommander.converters.FloatConverter
forceNonOverwritable() - Element in annotation interface com.beust.jcommander.Parameter: If true, this parameter can not be overwritten through a file or another appearance of the parameter
FuzzyMap - Class in com.beust.jcommander: Helper class to perform fuzzy key look ups: looking up case insensitive or abbreviated keys.
FuzzyMap() - Constructor for class com.beust.jcommander.FuzzyMap

G

get(Object) - Method in class com.beust.jcommander.Parameterized
getAssignment() - Method in class com.beust.jcommander.WrappedParameter
getBundle() - Method in class com.beust.jcommander.JCommander
getCategory() - Method in class com.beust.jcommander.ParameterDescription
getColumnSize() - Method in class com.beust.jcommander.JCommander
getCommandDescription(String) - Method in class com.beust.jcommander.DefaultUsageFormatter: Returns the description of the command corresponding to the argument command name.
getCommandDescription(String) - Method in interface com.beust.jcommander.IUsageFormatter
getCommands() - Method in class com.beust.jcommander.JCommander
getConsole() - Method in class com.beust.jcommander.JCommander
getConverter(Class) - Method in class com.beust.jcommander.internal.DefaultConverterFactory
getConverter(Class<?>) - Method in interface com.beust.jcommander.IStringConverterFactory
getConverterInstance(Parameter, Class<?>, String) - Method in interface com.beust.jcommander.IStringConverterInstanceFactory: Obtain a converter instance for parsing parameter as type forType
getDefault() - Method in class com.beust.jcommander.ParameterDescription
getDefaultValueDescription() - Method in class com.beust.jcommander.ParameterDescription
getDefaultValueFor(String) - Method in class com.beust.jcommander.defaultprovider.EnvironmentVariableDefaultProvider
getDefaultValueFor(String) - Method in class com.beust.jcommander.defaultprovider.PropertyFileDefaultProvider
getDefaultValueFor(String) - Method in interface com.beust.jcommander.IDefaultProvider
getDelegateAnnotation() - Method in class com.beust.jcommander.Parameterized
getDescription() - Method in interface com.beust.jcommander.IMainParameter
getDescription() - Method in class com.beust.jcommander.ParameterDescription
getDescriptions() - Method in class com.beust.jcommander.JCommander
getDisplayName() - Method in class com.beust.jcommander.JCommander.ProgramName
getDynamicParameter() - Method in class com.beust.jcommander.WrappedParameter
getErrorString(String, String) - Method in class com.beust.jcommander.converters.BaseConverter
getFields() - Method in class com.beust.jcommander.JCommander
getGenericType() - Method in class com.beust.jcommander.Parameterized
getI18nString(ResourceBundle, String, String) - Static method in class com.beust.jcommander.DefaultUsageFormatter: Returns the internationalized version of the string if available, otherwise it returns def.
getJCommander() - Method in exception class com.beust.jcommander.ParameterException
getLongestName() - Method in class com.beust.jcommander.ParameterDescription
getMainParameter() - Method in class com.beust.jcommander.JCommander
getMainParameterDescription() - Method in class com.beust.jcommander.JCommander
getMainParameterValue() - Method in class com.beust.jcommander.JCommander
getName() - Method in class com.beust.jcommander.JCommander.ProgramName
getName() - Method in class com.beust.jcommander.Parameterized
getName() - Method in class com.beust.jcommander.StringKey
getNames() - Method in class com.beust.jcommander.ParameterDescription
getObject() - Method in class com.beust.jcommander.ParameterDescription
getObjects() - Method in class com.beust.jcommander.JCommander
getOptionName() - Method in class com.beust.jcommander.converters.BaseConverter
getOptions() - Method in class com.beust.jcommander.JCommander
getParameter() - Method in class com.beust.jcommander.ParameterDescription
getParameter() - Method in class com.beust.jcommander.Parameterized
getParameter() - Method in class com.beust.jcommander.WrappedParameter
getParameterAnnotation() - Method in class com.beust.jcommander.ParameterDescription
getParameterDescriptionComparator() - Method in class com.beust.jcommander.JCommander
getParameterized() - Method in class com.beust.jcommander.ParameterDescription
getParameters() - Method in class com.beust.jcommander.JCommander
getParsedAlias() - Method in class com.beust.jcommander.JCommander: The name of the command or the alias in the form it was passed to the command line.
getParsedCommand() - Method in class com.beust.jcommander.JCommander
getProgramDisplayName() - Method in class com.beust.jcommander.JCommander: Get the program display name (used only in the usage).
getProgramName() - Method in class com.beust.jcommander.JCommander: Get the program name (used only in the usage).
getRawCommands() - Method in class com.beust.jcommander.JCommander
getType() - Method in class com.beust.jcommander.Parameterized
getUnknownCommand() - Method in exception class com.beust.jcommander.MissingCommandException
getUnknownOptions() - Method in class com.beust.jcommander.JCommander
getUsageFormatter() - Method in class com.beust.jcommander.JCommander: Returns the usage formatter.
getWrappedParameter() - Method in class com.beust.jcommander.Parameterized

H

hashCode() - Method in class com.beust.jcommander.JCommander.ProgramName
hashCode() - Method in class com.beust.jcommander.Parameterized
hashCode() - Method in class com.beust.jcommander.StringKey
help() - Element in annotation interface com.beust.jcommander.Parameter: If true, this parameter is for help.
hidden() - Element in annotation interface com.beust.jcommander.DynamicParameter: If true, this parameter won't appear in the usage().
hidden() - Element in annotation interface com.beust.jcommander.Parameter: If true, this parameter won't appear in the usage().
hidden() - Element in annotation interface com.beust.jcommander.Parameters: If true, this command won't appear in the usage().
hidden() - Method in class com.beust.jcommander.WrappedParameter

I

IDefaultProvider - Interface in com.beust.jcommander: Allows the specification of default values.
IMainParameter - Interface in com.beust.jcommander
InetAddressConverter - Class in com.beust.jcommander.converters: Converts Strings to InetAddress'.
InetAddressConverter() - Constructor for class com.beust.jcommander.converters.InetAddressConverter
IntegerConverter - Class in com.beust.jcommander.converters: Convert a string to an integer.
IntegerConverter(String) - Constructor for class com.beust.jcommander.converters.IntegerConverter
IParameterizedParser - Interface in com.beust.jcommander: Thin interface allows the Parameterized parsing mechanism, which reflects an object to find the JCommander annotations, to be replaced at runtime for cases where the source code cannot be directly annotated with JCommander annotations, but may have other annotations such as JSON annotations that can be used to reflect as JCommander parameters.
IParameterSplitter - Interface in com.beust.jcommander.converters: Convert a string representing several parameters (e.g.
IParametersValidator - Interface in com.beust.jcommander
IParameterValidator - Interface in com.beust.jcommander: The class used to validate parameters.
IParameterValidator2 - Interface in com.beust.jcommander
isAssigned() - Method in class com.beust.jcommander.ParameterDescription
isDynamicParameter() - Method in class com.beust.jcommander.ParameterDescription
isDynamicParameter() - Method in class com.beust.jcommander.Parameterized
isDynamicParameter(Field) - Method in class com.beust.jcommander.Parameterized
isHelp() - Method in class com.beust.jcommander.ParameterDescription
isHelp() - Method in class com.beust.jcommander.WrappedParameter
isNonOverwritableForced() - Method in class com.beust.jcommander.ParameterDescription
isNonOverwritableForced() - Method in class com.beust.jcommander.WrappedParameter
ISO8601DateConverter - Class in com.beust.jcommander.converters: Converts a String to a Date.
ISO8601DateConverter(String) - Constructor for class com.beust.jcommander.converters.ISO8601DateConverter
isParameterOverwritingAllowed() - Method in class com.beust.jcommander.JCommander
isStringEmpty(String) - Static method in class com.beust.jcommander.Strings
IStringConverter<T> - Interface in com.beust.jcommander: An interface that converts strings to any arbitrary type.
IStringConverterFactory - Interface in com.beust.jcommander: A factory for IStringConverter.
IStringConverterInstanceFactory - Interface in com.beust.jcommander: A factory to create IStringConverter instances.
IUsageFormatter - Interface in com.beust.jcommander: A formatter for help messages.
IValueValidator<T> - Interface in com.beust.jcommander
IVariableArity - Interface in com.beust.jcommander: Must be implemented by argument classes that contain at least one \@Parameter with "variableArity = true".

J

JCommander - Class in com.beust.jcommander: The main class for JCommander.
JCommander() - Constructor for class com.beust.jcommander.JCommander: Creates a new un-configured JCommander object.
JCommander(Object) - Constructor for class com.beust.jcommander.JCommander
JCommander(Object, String...) - Constructor for class com.beust.jcommander.JCommander: Deprecated.
Construct a JCommander instance first and then call parse() on it.
JCommander(Object, ResourceBundle) - Constructor for class com.beust.jcommander.JCommander
JCommander(Object, ResourceBundle, String...) - Constructor for class com.beust.jcommander.JCommander
JCommander.Builder - Class in com.beust.jcommander
JCommander.ProgramName - Class in com.beust.jcommander: Encapsulation of either a main application or an individual command.
JDK6Console - Class in com.beust.jcommander.internal
JDK6Console(Object) - Constructor for class com.beust.jcommander.internal.JDK6Console
join(String, Object[]) - Static method in class com.beust.jcommander.Strings
join(String, List<String>) - Static method in class com.beust.jcommander.Strings

L

listConverter() - Element in annotation interface com.beust.jcommander.Parameter: The list string converter to use for this field.
Lists - Class in com.beust.jcommander.internal
Lists() - Constructor for class com.beust.jcommander.internal.Lists
LongConverter - Class in com.beust.jcommander.converters: Convert a string to a long.
LongConverter(String) - Constructor for class com.beust.jcommander.converters.LongConverter

M

Maps - Class in com.beust.jcommander.internal
Maps() - Constructor for class com.beust.jcommander.internal.Maps
MissingCommandException - Exception Class in com.beust.jcommander: Thrown when a command was expected.
MissingCommandException(String) - Constructor for exception class com.beust.jcommander.MissingCommandException
MissingCommandException(String, String) - Constructor for exception class com.beust.jcommander.MissingCommandException

N

names() - Element in annotation interface com.beust.jcommander.DynamicParameter: An array of allowed command line parameters (e.g.
names() - Element in annotation interface com.beust.jcommander.Parameter: An array of allowed command line parameters (e.g.
names() - Method in class com.beust.jcommander.WrappedParameter
newArrayList() - Static method in class com.beust.jcommander.internal.Lists
newArrayList(int) - Static method in class com.beust.jcommander.internal.Lists
newArrayList(Collection<K>) - Static method in class com.beust.jcommander.internal.Lists
newArrayList(K...) - Static method in class com.beust.jcommander.internal.Lists
newBuilder() - Static method in class com.beust.jcommander.JCommander
newHashMap() - Static method in class com.beust.jcommander.internal.Maps
newHashMap(T...) - Static method in class com.beust.jcommander.internal.Maps
newHashSet() - Static method in class com.beust.jcommander.internal.Sets
newLinkedHashMap() - Static method in class com.beust.jcommander.internal.Maps
newLinkedHashSet() - Static method in class com.beust.jcommander.internal.Sets
newLinkedList() - Static method in class com.beust.jcommander.internal.Lists
newLinkedList(Collection<K>) - Static method in class com.beust.jcommander.internal.Lists
NoConverter - Class in com.beust.jcommander.converters: Default value for a converter when none is specified.
NoConverter() - Constructor for class com.beust.jcommander.converters.NoConverter
NoValidator - Class in com.beust.jcommander.validators: This is the default value of the validateWith attribute.
NoValidator() - Constructor for class com.beust.jcommander.validators.NoValidator
NoValueValidator<T> - Class in com.beust.jcommander.validators: This is the default value of the validateValueWith attribute.
NoValueValidator() - Constructor for class com.beust.jcommander.validators.NoValueValidator
Nullable - Annotation Interface in com.beust.jcommander.internal

O

order() - Element in annotation interface com.beust.jcommander.DynamicParameter: If specified, this number will be used to order the description of this parameter when usage() is invoked.
order() - Element in annotation interface com.beust.jcommander.Parameter: If specified, this number will be used to order the description of this parameter when usage() is invoked.
order() - Element in annotation interface com.beust.jcommander.SubParameter
order() - Method in class com.beust.jcommander.WrappedParameter

P

Parameter - Annotation Interface in com.beust.jcommander
ParameterDescription - Class in com.beust.jcommander
ParameterDescription(Object, DynamicParameter, Parameterized, ResourceBundle, JCommander) - Constructor for class com.beust.jcommander.ParameterDescription
ParameterDescription(Object, Parameter, Parameterized, ResourceBundle, JCommander) - Constructor for class com.beust.jcommander.ParameterDescription
ParameterException - Exception Class in com.beust.jcommander: The main exception that JCommand will throw when something goes wrong while parsing parameters.
ParameterException(String) - Constructor for exception class com.beust.jcommander.ParameterException
ParameterException(String, Throwable) - Constructor for exception class com.beust.jcommander.ParameterException
ParameterException(Throwable) - Constructor for exception class com.beust.jcommander.ParameterException
Parameterized - Class in com.beust.jcommander: Encapsulate a field or a method annotated with @Parameter or @DynamicParameter
Parameterized(WrappedParameter, ParametersDelegate, Field, Method) - Constructor for class com.beust.jcommander.Parameterized
parameterizedParser - Variable in class com.beust.jcommander.JCommander
Parameters - Annotation Interface in com.beust.jcommander: An annotation used to specify settings for parameter parsing.
ParametersDelegate - Annotation Interface in com.beust.jcommander: When applied to a field all of its child fields annotated with Parameter will be included during arguments parsing.
parametersValidators() - Element in annotation interface com.beust.jcommander.Parameters: Validate the value for all parameters.
parse(String...) - Method in class com.beust.jcommander.JCommander: Parse and validate the command line parameters.
parseArg(Object) - Method in interface com.beust.jcommander.IParameterizedParser: Parses the given object for any command line related annotations and returns the list of JCommander Parameterized definitions.
parseArg(Object) - Static method in class com.beust.jcommander.Parameterized
parseArg(Object) - Method in class com.beust.jcommander.parser.DefaultParameterizedParser: Wraps the default parser.
parseWithoutValidation(String...) - Method in class com.beust.jcommander.JCommander: Parse the command line parameters without validating them.
password() - Element in annotation interface com.beust.jcommander.Parameter: If true, this parameter is a password and it will be prompted on the console (if available).
password() - Method in class com.beust.jcommander.WrappedParameter
PathConverter - Class in com.beust.jcommander.converters: Convert a string into a path.
PathConverter(String) - Constructor for class com.beust.jcommander.converters.PathConverter
PositiveInteger - Class in com.beust.jcommander.validators: A validator that makes sure the value of the parameter is a positive integer.
PositiveInteger() - Constructor for class com.beust.jcommander.validators.PositiveInteger
print(String) - Method in interface com.beust.jcommander.internal.Console
print(String) - Method in class com.beust.jcommander.internal.DefaultConsole
print(String) - Method in class com.beust.jcommander.internal.JDK6Console
println(String) - Method in interface com.beust.jcommander.internal.Console
println(String) - Method in class com.beust.jcommander.internal.DefaultConsole
println(String) - Method in class com.beust.jcommander.internal.JDK6Console
processVariableArity(String, String[]) - Method in interface com.beust.jcommander.IVariableArity
programName(String) - Method in class com.beust.jcommander.JCommander.Builder: Set the program name (used only in the usage).
PropertyFileDefaultProvider - Class in com.beust.jcommander.defaultprovider: A default provider that reads its default values from a property file.
PropertyFileDefaultProvider() - Constructor for class com.beust.jcommander.defaultprovider.PropertyFileDefaultProvider
PropertyFileDefaultProvider(String) - Constructor for class com.beust.jcommander.defaultprovider.PropertyFileDefaultProvider

R

readPassword(boolean) - Method in interface com.beust.jcommander.internal.Console
readPassword(boolean) - Method in class com.beust.jcommander.internal.DefaultConsole
readPassword(boolean) - Method in class com.beust.jcommander.internal.JDK6Console
required() - Element in annotation interface com.beust.jcommander.DynamicParameter: Whether this option is required.
required() - Element in annotation interface com.beust.jcommander.Parameter: Whether this option is required.
required() - Method in class com.beust.jcommander.WrappedParameter
resourceBundle() - Element in annotation interface com.beust.jcommander.Parameters: The name of the resource bundle to use for this class.
resourceBundle(ResourceBundle) - Method in class com.beust.jcommander.JCommander.Builder: Sets the ResourceBundle to use for looking up descriptions.
ResourceBundle - Annotation Interface in com.beust.jcommander: Deprecated.
use @Parameters

S

s(int) - Static method in class com.beust.jcommander.DefaultUsageFormatter: Returns count-many spaces.
separators() - Element in annotation interface com.beust.jcommander.Parameters: The character(s) that separate options.
set(Object, Object) - Method in class com.beust.jcommander.Parameterized
setAcceptUnknownOptions(boolean) - Method in class com.beust.jcommander.JCommander
setAllowAbbreviatedOptions(boolean) - Method in class com.beust.jcommander.JCommander
setAllowParameterOverwriting(boolean) - Method in class com.beust.jcommander.JCommander
setAssigned(boolean) - Method in class com.beust.jcommander.ParameterDescription
setAtFileCharset(Charset) - Method in class com.beust.jcommander.JCommander: Sets the charset used to expand @files.
setCaseSensitiveOptions(boolean) - Method in class com.beust.jcommander.JCommander
setColumnSize(int) - Method in class com.beust.jcommander.JCommander
setConsole(Console) - Method in class com.beust.jcommander.JCommander
setDefaultProvider(IDefaultProvider) - Method in class com.beust.jcommander.JCommander: Define the default provider for this instance.
setDescriptionsBundle(ResourceBundle) - Method in class com.beust.jcommander.JCommander: Sets the ResourceBundle to use for looking up descriptions.
setExpandAtSign(boolean) - Method in class com.beust.jcommander.JCommander: Disables expanding @file.
setJCommander(JCommander) - Method in exception class com.beust.jcommander.ParameterException
setParameterDescriptionComparator(Comparator<? super ParameterDescription>) - Method in class com.beust.jcommander.JCommander
setParameterizedParser(IParameterizedParser) - Method in class com.beust.jcommander.JCommander
setProgramName(String) - Method in class com.beust.jcommander.JCommander: Set the program name (used only in the usage).
setProgramName(String, String...) - Method in class com.beust.jcommander.JCommander: Set the program name
Sets - Class in com.beust.jcommander.internal
Sets() - Constructor for class com.beust.jcommander.internal.Sets
setUsageFormatter(IUsageFormatter) - Method in class com.beust.jcommander.JCommander: Sets the usage formatter.
setVerbose(int) - Method in class com.beust.jcommander.JCommander
split(String) - Method in class com.beust.jcommander.converters.CommaParameterSplitter
split(String) - Method in interface com.beust.jcommander.converters.IParameterSplitter
splitter() - Element in annotation interface com.beust.jcommander.Parameter: What splitter to use (applicable only on fields of type List).
startsWith(String, String, boolean) - Static method in class com.beust.jcommander.Strings
StringConverter - Class in com.beust.jcommander.converters: Default converter for strings.
StringConverter() - Constructor for class com.beust.jcommander.converters.StringConverter
StringKey - Class in com.beust.jcommander
StringKey(String) - Constructor for class com.beust.jcommander.StringKey
Strings - Class in com.beust.jcommander
Strings() - Constructor for class com.beust.jcommander.Strings
SubParameter - Annotation Interface in com.beust.jcommander

T

toString() - Method in class com.beust.jcommander.JCommander.ProgramName
toString() - Method in class com.beust.jcommander.ParameterDescription
toString() - Method in class com.beust.jcommander.StringKey

U

UnixStyleUsageFormatter - Class in com.beust.jcommander: A unix-style usage formatter.
UnixStyleUsageFormatter(JCommander) - Constructor for class com.beust.jcommander.UnixStyleUsageFormatter
URIConverter - Class in com.beust.jcommander.converters: Convert a string into a URI.
URIConverter(String) - Constructor for class com.beust.jcommander.converters.URIConverter
URLConverter - Class in com.beust.jcommander.converters: Convert a string into a URI.
URLConverter(String) - Constructor for class com.beust.jcommander.converters.URLConverter
usage() - Method in class com.beust.jcommander.JCommander: Prints the usage on JCommander.getConsole() using the underlying JCommander.usageFormatter.
usage() - Method in exception class com.beust.jcommander.ParameterException
usage(String) - Method in class com.beust.jcommander.DefaultUsageFormatter: Prints the usage to JCommander.getConsole() on the underlying commander instance.
usage(String) - Method in interface com.beust.jcommander.IUsageFormatter: Display the usage for this command.
usage(String) - Method in class com.beust.jcommander.JCommander: Display the usage for this command.
usage(StringBuilder) - Method in class com.beust.jcommander.DefaultUsageFormatter: Store the usage in the argument string builder.
usage(StringBuilder) - Method in interface com.beust.jcommander.IUsageFormatter: Store the help in the passed string builder.
usage(StringBuilder) - Method in class com.beust.jcommander.JCommander: Store the help in the passed string builder.
usage(StringBuilder, String) - Method in class com.beust.jcommander.DefaultUsageFormatter: Stores the usage in the argument string builder, with the argument indentation.
usage(StringBuilder, String) - Method in interface com.beust.jcommander.IUsageFormatter: Stores the help in the passed string builder, with the argument indentation.
usage(StringBuilder, String) - Method in class com.beust.jcommander.JCommander
usage(String, StringBuilder) - Method in class com.beust.jcommander.DefaultUsageFormatter: Store the usage for the argument command in the argument string builder.
usage(String, StringBuilder) - Method in interface com.beust.jcommander.IUsageFormatter: Store the help for the command in the passed string builder.
usage(String, StringBuilder) - Method in class com.beust.jcommander.JCommander: Store the help for the command in the passed string builder.
usage(String, StringBuilder, String) - Method in class com.beust.jcommander.DefaultUsageFormatter: Store the usage for the command in the argument string builder, indenting every line with the value of indent.
usage(String, StringBuilder, String) - Method in interface com.beust.jcommander.IUsageFormatter: Store the help for the command in the passed string builder, indenting every line with "indent".
usage(String, StringBuilder, String) - Method in class com.beust.jcommander.JCommander: Store the help for the command in the passed string builder, indenting every line with "indent".
usageFormatter(IUsageFormatter) - Method in class com.beust.jcommander.JCommander.Builder

V

validate(String, String) - Method in interface com.beust.jcommander.IParameterValidator: Validate the parameter.
validate(String, String) - Method in class com.beust.jcommander.validators.NoValidator
validate(String, String) - Method in class com.beust.jcommander.validators.PositiveInteger
validate(String, String, ParameterDescription) - Method in interface com.beust.jcommander.IParameterValidator2: Validate the parameter.
validate(String, T) - Method in interface com.beust.jcommander.IValueValidator: Validate the parameter.
validate(String, T) - Method in class com.beust.jcommander.validators.NoValueValidator
validate(Map<String, Object>) - Method in interface com.beust.jcommander.IParametersValidator: Validate all parameters.
validateParameter(Class<? extends IParameterValidator>, String, String) - Method in class com.beust.jcommander.ParameterDescription
validateValueParameter(Class<? extends IValueValidator>, String, Object) - Method in class com.beust.jcommander.ParameterDescription
validateValueWith() - Element in annotation interface com.beust.jcommander.DynamicParameter
validateValueWith() - Element in annotation interface com.beust.jcommander.Parameter: Validate the value for this parameter.
validateValueWith() - Method in class com.beust.jcommander.WrappedParameter
validateWith() - Element in annotation interface com.beust.jcommander.DynamicParameter: The validation classes to use.
validateWith() - Element in annotation interface com.beust.jcommander.Parameter: Validate the parameter found on the command line.
validateWith() - Method in class com.beust.jcommander.WrappedParameter
value() - Element in annotation interface com.beust.jcommander.ResourceBundle: Deprecated.

The name of the resource bundle to use for this class.
variableArity() - Element in annotation interface com.beust.jcommander.Parameter
variableArity() - Method in class com.beust.jcommander.WrappedParameter
verbose(int) - Method in class com.beust.jcommander.JCommander.Builder

W

wrapDescription(StringBuilder, int, int, String) - Method in class com.beust.jcommander.DefaultUsageFormatter: Wrap a potentially long line to the value obtained by calling JCommander.getColumnSize() on the underlying commander instance.
wrapDescription(StringBuilder, int, String) - Method in class com.beust.jcommander.DefaultUsageFormatter: Wrap a potentially long line to { @link #commander#getColumnSize()}.
WrappedParameter - Class in com.beust.jcommander: Encapsulates the operations common to @Parameter and @DynamicParameter
WrappedParameter(DynamicParameter) - Constructor for class com.beust.jcommander.WrappedParameter
WrappedParameter(Parameter) - Constructor for class com.beust.jcommander.WrappedParameter

A B C D E F G H I J L M N O P R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form