A B C D E F G H I J L M N P R S T U V W

A

acceptUnknownOptions(boolean) - Method in class com.beust.jcommander.JCommander.Builder

addCommand(String, Object) - Method in class com.beust.jcommander.JCommander

Add a command object.

addCommand(Object) - Method in class com.beust.jcommander.JCommander

addCommand(String, Object, String...) - Method in class com.beust.jcommander.JCommander

Add a command object and its aliases.

addCommand(Object) - Method in class com.beust.jcommander.JCommander.Builder

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(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.

addValue(Parameterized, Object, Object) - Method in class com.beust.jcommander.WrappedParameter

addValue(Parameterized, Object, Object, Field) - Method in class com.beust.jcommander.WrappedParameter

allowAbbreviatedOptions(boolean) - Method in class com.beust.jcommander.JCommander.Builder

allowParameterOverwriting(boolean) - Method in class com.beust.jcommander.JCommander.Builder

args(String[]) - Method in class com.beust.jcommander.JCommander.Builder

arity() - Method in class com.beust.jcommander.WrappedParameter

atFileCharset(Charset) - Method in class com.beust.jcommander.JCommander.Builder

B

BaseConverter<T> - Class in com.beust.jcommander.converters

Base class for converters that stores 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

C

CharArrayConverter - Class in com.beust.jcommander.converters

Converts a String to a char[].

CharArrayConverter() - Constructor for class com.beust.jcommander.converters.CharArrayConverter

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.validators - package com.beust.jcommander.validators

CommaParameterSplitter - Class in com.beust.jcommander.converters

CommaParameterSplitter() - Constructor for class com.beust.jcommander.converters.CommaParameterSplitter

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.CharArrayConverter

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

convertValue(Parameterized, Class, String, String) - Method in class com.beust.jcommander.JCommander

D

DEBUG_PROPERTY - Static variable in class com.beust.jcommander.JCommander

DEFAULT_FILE_NAME - Static variable in class com.beust.jcommander.defaultprovider.PropertyFileDefaultProvider

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.

defaultProvider(IDefaultProvider) - Method in class com.beust.jcommander.JCommander.Builder

Define the default provider for this instance.

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 Type in com.beust.jcommander

E

echoInput() - Method in class com.beust.jcommander.WrappedParameter

EnumConverter<T extends Enum<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.

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

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

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

getColumnSize() - Method in class com.beust.jcommander.JCommander

getCommandDescription(String) - Method in class com.beust.jcommander.JCommander

getCommands() - Method in class com.beust.jcommander.JCommander

getConsole() - Static method in class com.beust.jcommander.JCommander

getConverter(Class<T>) - 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

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 class com.beust.jcommander.ParameterDescription

getDynamicParameter() - Method in class com.beust.jcommander.WrappedParameter

getErrorString(String, String) - Method in class com.beust.jcommander.converters.BaseConverter

getGenericType() - Method in class com.beust.jcommander.Parameterized

getJCommander() - Method in exception 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

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

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

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

getProgramName() - Method in class com.beust.jcommander.JCommander

Get the program name (used only in the usage).

getType() - Method in class com.beust.jcommander.Parameterized

getUnknownCommand() - Method in exception com.beust.jcommander.MissingCommandException

getUnknownOptions() - Method in class com.beust.jcommander.JCommander

getWrappedParameter() - Method in class com.beust.jcommander.Parameterized

H

hashCode() - Method in class com.beust.jcommander.Parameterized

hashCode() - Method in class com.beust.jcommander.StringKey

hidden() - Method in class com.beust.jcommander.WrappedParameter

I

IDefaultProvider - Interface in com.beust.jcommander

Allows the specification of default values.

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

IParameterSplitter - Interface in com.beust.jcommander.converters

Convert a string representing several parameters (e.g.

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(Field) - Method in class com.beust.jcommander.Parameterized

isDynamicParameter() - 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.

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, ResourceBundle) - Constructor for class com.beust.jcommander.JCommander

JCommander(Object, ResourceBundle, String...) - 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.Builder - Class in com.beust.jcommander

L

LongConverter - Class in com.beust.jcommander.converters

Convert a string to a long.

LongConverter(String) - Constructor for class com.beust.jcommander.converters.LongConverter

M

MissingCommandException - Exception in com.beust.jcommander

Thrown when a command was expected.

MissingCommandException(String) - Constructor for exception com.beust.jcommander.MissingCommandException

MissingCommandException(String, String) - Constructor for exception com.beust.jcommander.MissingCommandException

N

names() - Method in class com.beust.jcommander.WrappedParameter

newBuilder() - Static method in class com.beust.jcommander.JCommander

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

P

Parameter - Annotation Type 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 in com.beust.jcommander

The main exception that JCommand will throw when something goes wrong while parsing parameters.

ParameterException(Throwable) - Constructor for exception com.beust.jcommander.ParameterException

ParameterException(String) - Constructor for exception com.beust.jcommander.ParameterException

ParameterException(String, Throwable) - Constructor for exception 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

Parameters - Annotation Type in com.beust.jcommander

An annotation used to specify settings for parameter parsing.

ParametersDelegate - Annotation Type in com.beust.jcommander

When applied to a field all of its child fields annotated with Parameter will be included during arguments parsing.

parse(String...) - Method in class com.beust.jcommander.JCommander

Parse and validate the command line parameters.

parseArg(Object) - Static method in class com.beust.jcommander.Parameterized

parseWithoutValidation(String...) - Method in class com.beust.jcommander.JCommander

Parse the command line parameters without validating them.

password() - Method in class com.beust.jcommander.WrappedParameter

PathConverter - Class in com.beust.jcommander.converters

Convert a string into a path.

PathConverter() - 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

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

required() - Method in class com.beust.jcommander.WrappedParameter

resourceBundle(ResourceBundle) - Method in class com.beust.jcommander.JCommander.Builder

Sets the ResourceBundle to use for looking up descriptions.

ResourceBundle - Annotation Type in com.beust.jcommander

Deprecated.

use @Parameters

S

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

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 com.beust.jcommander.ParameterException

setParameterDescriptionComparator(Comparator<? super ParameterDescription>) - 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

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

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 Type in com.beust.jcommander

T

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

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

U

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(String) - Method in class com.beust.jcommander.JCommander

Display the usage for this command.

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.JCommander

Store the help for the command in the passed string builder, indenting every line with "indent".

usage() - Method in class com.beust.jcommander.JCommander

Display the help on System.out.

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.JCommander

usage() - Method in exception com.beust.jcommander.ParameterException

V

validate(String, String) - Method in interface com.beust.jcommander.IParameterValidator

Validate the parameter.

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, String) - Method in class com.beust.jcommander.validators.NoValidator

validate(String, T) - Method in class com.beust.jcommander.validators.NoValueValidator

validate(String, String) - Method in class com.beust.jcommander.validators.PositiveInteger

validateParameter(ParameterDescription, Class<? extends IParameterValidator>, String, String) - Static method in class com.beust.jcommander.ParameterDescription

validateValueParameter(Class<? extends IValueValidator>, String, Object) - Static method in class com.beust.jcommander.ParameterDescription

validateValueWith() - Method in class com.beust.jcommander.WrappedParameter

validateWith() - Method in class com.beust.jcommander.WrappedParameter

variableArity() - Method in class com.beust.jcommander.WrappedParameter

verbose(int) - Method in class com.beust.jcommander.JCommander.Builder

W

WrappedParameter - Class in com.beust.jcommander

Encapsulates the operations common to @Parameter and @DynamicParameter

WrappedParameter(Parameter) - Constructor for class com.beust.jcommander.WrappedParameter

WrappedParameter(DynamicParameter) - Constructor for class com.beust.jcommander.WrappedParameter

A B C D E F G H I J L M N P R S T U V W