A B C D E F G H I L M N O P R S T U V W
All Classes All Packages
All Classes All Packages
All Classes All Packages
A
- acceptSystemIn() - Method in class net.sourceforge.argparse4j.ext.java7.PathArgumentType
-
If the argument is "-", accept it as standard input.
- acceptSystemIn() - Method in class net.sourceforge.argparse4j.impl.type.FileArgumentType
-
If the argument is "-", accept it as standard input.
- action(ArgumentAction) - Method in interface net.sourceforge.argparse4j.inf.Argument
-
Sets the action to be taken when this argument is encountered at the command line.
- action(ArgumentAction) - Method in class net.sourceforge.argparse4j.internal.ArgumentImpl
- addArgument(String...) - Method in interface net.sourceforge.argparse4j.inf.ArgumentContainer
-
Creates new
Argument
, adds it to this container and returns it. - addArgument(String...) - Method in class net.sourceforge.argparse4j.internal.ArgumentGroupImpl
- addArgument(String...) - Method in class net.sourceforge.argparse4j.internal.ArgumentParserImpl
- addArgument(String...) - Method in class net.sourceforge.argparse4j.internal.SubparserImpl
- addArgument(ArgumentGroupImpl, String...) - Method in class net.sourceforge.argparse4j.internal.ArgumentParserImpl
- addArgumentGroup(String) - Method in interface net.sourceforge.argparse4j.inf.ArgumentParser
-
Creates new
ArgumentGroup
object and adds to this parser and returns the object. - addArgumentGroup(String) - Method in class net.sourceforge.argparse4j.internal.ArgumentParserImpl
- addArgumentGroup(String) - Method in class net.sourceforge.argparse4j.internal.SubparserImpl
- addHelp(boolean) - Method in class net.sourceforge.argparse4j.ArgumentParserBuilder
-
If true,
-h/--help
are available. - addMutuallyExclusiveGroup() - Method in interface net.sourceforge.argparse4j.inf.ArgumentParser
-
Creates new mutually exclusive group,
MutuallyExclusiveGroup
object, without title and adds to this parser and returns the object. - addMutuallyExclusiveGroup() - Method in class net.sourceforge.argparse4j.internal.ArgumentParserImpl
- addMutuallyExclusiveGroup() - Method in class net.sourceforge.argparse4j.internal.SubparserImpl
- addMutuallyExclusiveGroup(String) - Method in interface net.sourceforge.argparse4j.inf.ArgumentParser
-
Creates new mutually exclusive group,
MutuallyExclusiveGroup
object, and adds to this parser and returns the object. - addMutuallyExclusiveGroup(String) - Method in class net.sourceforge.argparse4j.internal.ArgumentParserImpl
- addMutuallyExclusiveGroup(String) - Method in class net.sourceforge.argparse4j.internal.SubparserImpl
- addParser(String) - Method in interface net.sourceforge.argparse4j.inf.Subparsers
-
Adds and returns
Subparser
object with given sub-command name. - addParser(String) - Method in class net.sourceforge.argparse4j.internal.SubparsersImpl
- addParser(String, boolean) - Method in interface net.sourceforge.argparse4j.inf.Subparsers
-
Adds and returns
Subparser
object with given sub-command name and addHelp. - addParser(String, boolean) - Method in class net.sourceforge.argparse4j.internal.SubparsersImpl
- addParser(String, boolean, String) - Method in interface net.sourceforge.argparse4j.inf.Subparsers
-
Adds and returns
Subparser
object with given sub-command name, addHelp and prefixChars. - addParser(String, boolean, String) - Method in class net.sourceforge.argparse4j.internal.SubparsersImpl
- addSubparsers() - Method in interface net.sourceforge.argparse4j.inf.ArgumentParser
-
Returns
Subparsers
. - addSubparsers() - Method in class net.sourceforge.argparse4j.internal.ArgumentParserImpl
- addSubparsers() - Method in class net.sourceforge.argparse4j.internal.SubparserImpl
- adjustSpace(StringBuilder, int, int) - Static method in class net.sourceforge.argparse4j.helper.TextHelper
-
Given the maximum line width and current line width in sb, insert white spaces in sb to make it look more "natural".
- aliases(String...) - Method in interface net.sourceforge.argparse4j.inf.Subparser
-
Sets alias names for this Subparser.
- aliases(String...) - Method in class net.sourceforge.argparse4j.internal.SubparserImpl
- append() - Static method in class net.sourceforge.argparse4j.impl.Arguments
-
Returns append action.
- AppendArgumentAction - Class in net.sourceforge.argparse4j.impl.action
-
Argument action to store a list.
- AppendArgumentAction() - Constructor for class net.sourceforge.argparse4j.impl.action.AppendArgumentAction
- appendConst() - Static method in class net.sourceforge.argparse4j.impl.Arguments
-
Returns appendConst action.
- AppendConstArgumentAction - Class in net.sourceforge.argparse4j.impl.action
-
Argument action to store a list.
- AppendConstArgumentAction() - Constructor for class net.sourceforge.argparse4j.impl.action.AppendConstArgumentAction
- Arg - Annotation Type in net.sourceforge.argparse4j.annotation
-
Annotation specifies location where attribute should be stored.
- Argument - Interface in net.sourceforge.argparse4j.inf
-
This interface provides a way to specify parameters to argument to be processed in
ArgumentParser
object. - ArgumentAction - Interface in net.sourceforge.argparse4j.inf
-
This interface defines behavior of action when an argument is encountered at the command line.
- ArgumentChoice - Interface in net.sourceforge.argparse4j.inf
-
This interface defines simple data validation method.
- ArgumentContainer - Interface in net.sourceforge.argparse4j.inf
-
A container to which arguments can be added.
- ArgumentGroup - Interface in net.sourceforge.argparse4j.inf
-
This interface defines a method to conceptually group up
Argument
objects. - ArgumentGroupImpl - Class in net.sourceforge.argparse4j.internal
-
The application code must not use this class directly. This class implements both mutually exclusive group and just a conceptual group.
- ArgumentImpl - Class in net.sourceforge.argparse4j.internal
-
The application code must not use this class directly.
- ArgumentParser - Interface in net.sourceforge.argparse4j.inf
-
This interface defines behavior of ArgumentParser.
- ArgumentParserBuilder - Class in net.sourceforge.argparse4j
-
ArgumentParserBuilder is a class to build new ArgumentParser with a given custom configuration.
- ArgumentParserConfiguration - Interface in net.sourceforge.argparse4j.inf
-
ArgumentParserConfiguration is a configuration interface of ArgumentParser.
- ArgumentParserConfigurationImpl - Class in net.sourceforge.argparse4j.internal
- ArgumentParserConfigurationImpl(String, boolean, String, String, Locale, TextWidthCounter, int, boolean, boolean, boolean, boolean) - Constructor for class net.sourceforge.argparse4j.internal.ArgumentParserConfigurationImpl
- ArgumentParserException - Exception in net.sourceforge.argparse4j.inf
-
The exception thrown from
ArgumentParser.parseArgs(String[])
if error occurred while processing command line argument. - ArgumentParserException(String, Throwable, ArgumentParser) - Constructor for exception net.sourceforge.argparse4j.inf.ArgumentParserException
- ArgumentParserException(String, Throwable, ArgumentParser, Argument) - Constructor for exception net.sourceforge.argparse4j.inf.ArgumentParserException
- ArgumentParserException(String, ArgumentParser) - Constructor for exception net.sourceforge.argparse4j.inf.ArgumentParserException
- ArgumentParserException(String, ArgumentParser, Argument) - Constructor for exception net.sourceforge.argparse4j.inf.ArgumentParserException
- ArgumentParserException(Throwable, ArgumentParser) - Constructor for exception net.sourceforge.argparse4j.inf.ArgumentParserException
- ArgumentParserException(ArgumentParser) - Constructor for exception net.sourceforge.argparse4j.inf.ArgumentParserException
- ArgumentParserImpl - Class in net.sourceforge.argparse4j.internal
-
The application code must not use this class directly.
- ArgumentParserImpl(ArgumentParserConfigurationImpl) - Constructor for class net.sourceforge.argparse4j.internal.ArgumentParserImpl
- ArgumentParserImpl(ArgumentParserConfigurationImpl, String, ArgumentParserImpl) - Constructor for class net.sourceforge.argparse4j.internal.ArgumentParserImpl
- ArgumentParserImpl.Candidate - Class in net.sourceforge.argparse4j.internal
- ArgumentParsers - Class in net.sourceforge.argparse4j
-
Factory class to create new ArgumentParser.
- Arguments - Class in net.sourceforge.argparse4j.impl
-
This class provides useful shortcuts and constants.
- ArgumentType<T> - Interface in net.sourceforge.argparse4j.inf
-
This interface defines type conversion method.
- ASCIITextWidthCounter - Class in net.sourceforge.argparse4j.helper
-
This implementation assumes text contains only narrow characters,
- ASCIITextWidthCounter() - Constructor for class net.sourceforge.argparse4j.helper.ASCIITextWidthCounter
B
- BooleanArgumentType - Class in net.sourceforge.argparse4j.impl.type
-
BooleanArgumentType provides strict conversion from input string to Boolean value.
- BooleanArgumentType() - Constructor for class net.sourceforge.argparse4j.impl.type.BooleanArgumentType
-
Creates BooleanArgumentType with "true" as true value, and "false" as false value.
- BooleanArgumentType(String, String) - Constructor for class net.sourceforge.argparse4j.impl.type.BooleanArgumentType
-
Creates BooleanArgumentType with given values.
- booleanType() - Static method in class net.sourceforge.argparse4j.impl.Arguments
-
Returns
BooleanArgumentType
with "true" as true value, and "false" as false value. - booleanType(String, String) - Static method in class net.sourceforge.argparse4j.impl.Arguments
-
Returns
BooleanArgumentType
with given true/false values. - build() - Method in class net.sourceforge.argparse4j.ArgumentParserBuilder
C
- canExecute(File) - Method in class net.sourceforge.argparse4j.impl.type.FileVerification
- canRead(File) - Method in class net.sourceforge.argparse4j.impl.type.FileVerification
- canWrite(File) - Method in class net.sourceforge.argparse4j.impl.type.FileVerification
- CaseInsensitiveEnumArgumentType<T extends Enum<T>> - Class in net.sourceforge.argparse4j.impl.type
- CaseInsensitiveEnumArgumentType(Class<T>) - Constructor for class net.sourceforge.argparse4j.impl.type.CaseInsensitiveEnumArgumentType
-
Deprecated.Use one of the subclasses, which always convert case correctly.
- CaseInsensitiveEnumArgumentType(Class<T>, Locale) - Constructor for class net.sourceforge.argparse4j.impl.type.CaseInsensitiveEnumArgumentType
-
Create an instance.
- CaseInsensitiveEnumNameArgumentType<T extends Enum<T>> - Class in net.sourceforge.argparse4j.impl.type
-
ArgumentType subclass for enum type using case-insensitive matching of values.
- CaseInsensitiveEnumNameArgumentType(Class<T>) - Constructor for class net.sourceforge.argparse4j.impl.type.CaseInsensitiveEnumNameArgumentType
- CaseInsensitiveEnumStringArgumentType<T extends Enum<T>> - Class in net.sourceforge.argparse4j.impl.type
-
ArgumentType subclass for enum type using case-insensitive matching of values.
- CaseInsensitiveEnumStringArgumentType(Class<T>) - Constructor for class net.sourceforge.argparse4j.impl.type.CaseInsensitiveEnumStringArgumentType
- caseInsensitiveEnumStringType(Class<T>) - Static method in class net.sourceforge.argparse4j.impl.Arguments
-
Returns
CaseInsensitiveEnumStringArgumentType
with given enumtype
. - caseInsensitiveEnumType(Class<T>) - Static method in class net.sourceforge.argparse4j.impl.Arguments
-
Returns
CaseInsensitiveEnumNameArgumentType
with given enumtype
. - choices(E...) - Method in interface net.sourceforge.argparse4j.inf.Argument
-
Sets a collection of the allowable values for the argument.
- choices(E...) - Method in class net.sourceforge.argparse4j.internal.ArgumentImpl
- choices(Collection<E>) - Method in interface net.sourceforge.argparse4j.inf.Argument
-
Sets a collection of the allowable values for the argument.
- choices(Collection<E>) - Method in class net.sourceforge.argparse4j.internal.ArgumentImpl
- choices(ArgumentChoice) - Method in interface net.sourceforge.argparse4j.inf.Argument
-
Sets
ArgumentChoice
object which inspects value so that it fulfills its criteria. - choices(ArgumentChoice) - Method in class net.sourceforge.argparse4j.internal.ArgumentImpl
- CJKTextWidthCounter - Class in net.sourceforge.argparse4j.helper
-
CJK aware TextWidthCounter implementation.
- CJKTextWidthCounter() - Constructor for class net.sourceforge.argparse4j.helper.CJKTextWidthCounter
- cjkWidthHack(boolean) - Method in class net.sourceforge.argparse4j.ArgumentParserBuilder
-
Set
true
to enable CJK width hack. - CollectionArgumentChoice<E> - Class in net.sourceforge.argparse4j.impl.choice
-
Choice from given collection of values.
- CollectionArgumentChoice(E...) - Constructor for class net.sourceforge.argparse4j.impl.choice.CollectionArgumentChoice
-
Initializes this object from given values.
- CollectionArgumentChoice(Collection<E>) - Constructor for class net.sourceforge.argparse4j.impl.choice.CollectionArgumentChoice
-
Initializes this object from given values.
- compareTo(ArgumentParserImpl.Candidate) - Method in class net.sourceforge.argparse4j.internal.ArgumentParserImpl.Candidate
- concat(Collection<T>, int, String) - Static method in class net.sourceforge.argparse4j.helper.TextHelper
- concat(Collection<T>, int, String, String, String) - Static method in class net.sourceforge.argparse4j.helper.TextHelper
- concat(T[], int, String) - Static method in class net.sourceforge.argparse4j.helper.TextHelper
- concat(T[], int, String, String, String) - Static method in class net.sourceforge.argparse4j.helper.TextHelper
- ConstructorArgumentType<T> - Class in net.sourceforge.argparse4j.impl.type
-
Deprecated.Use
ReflectArgumentType
instead. - ConstructorArgumentType(Class<T>) - Constructor for class net.sourceforge.argparse4j.impl.type.ConstructorArgumentType
-
Deprecated.Creates
ConstructorArgumentType
object with giventype
. - consumeArgument() - Method in class net.sourceforge.argparse4j.impl.action.AppendArgumentAction
- consumeArgument() - Method in class net.sourceforge.argparse4j.impl.action.AppendConstArgumentAction
- consumeArgument() - Method in class net.sourceforge.argparse4j.impl.action.CountArgumentAction
- consumeArgument() - Method in class net.sourceforge.argparse4j.impl.action.HelpArgumentAction
- consumeArgument() - Method in class net.sourceforge.argparse4j.impl.action.StoreArgumentAction
- consumeArgument() - Method in class net.sourceforge.argparse4j.impl.action.StoreConstArgumentAction
- consumeArgument() - Method in class net.sourceforge.argparse4j.impl.action.StoreFalseArgumentAction
- consumeArgument() - Method in class net.sourceforge.argparse4j.impl.action.StoreTrueArgumentAction
- consumeArgument() - Method in class net.sourceforge.argparse4j.impl.action.VersionArgumentAction
- consumeArgument() - Method in interface net.sourceforge.argparse4j.inf.ArgumentAction
-
Returns
true
if this action consumes argument. - contains(Object) - Method in class net.sourceforge.argparse4j.impl.choice.CollectionArgumentChoice
- contains(Object) - Method in class net.sourceforge.argparse4j.impl.choice.RangeArgumentChoice
- contains(Object) - Method in interface net.sourceforge.argparse4j.inf.ArgumentChoice
-
Returns
true
iffval
is valid choice according to this object's constraint. - convert(ArgumentParser, Argument, String) - Method in class net.sourceforge.argparse4j.ext.java7.PathArgumentType
- convert(ArgumentParser, Argument, String) - Method in class net.sourceforge.argparse4j.impl.type.BooleanArgumentType
- convert(ArgumentParser, Argument, String) - Method in class net.sourceforge.argparse4j.impl.type.CaseInsensitiveEnumArgumentType
- convert(ArgumentParser, Argument, String) - Method in class net.sourceforge.argparse4j.impl.type.ConstructorArgumentType
-
Deprecated.
- convert(ArgumentParser, Argument, String) - Method in class net.sourceforge.argparse4j.impl.type.EnumArgumentType
-
Deprecated.
- convert(ArgumentParser, Argument, String) - Method in class net.sourceforge.argparse4j.impl.type.EnumStringArgumentType
- convert(ArgumentParser, Argument, String) - Method in class net.sourceforge.argparse4j.impl.type.FileArgumentType
- convert(ArgumentParser, Argument, String) - Method in class net.sourceforge.argparse4j.impl.type.ReflectArgumentType
- convert(ArgumentParser, Argument, String) - Method in class net.sourceforge.argparse4j.impl.type.StringArgumentType
- convert(ArgumentParser, Argument, String) - Method in interface net.sourceforge.argparse4j.inf.ArgumentType
-
Converts
value
to appropriate type. - convert(ArgumentParserImpl, String) - Method in class net.sourceforge.argparse4j.internal.ArgumentImpl
- count() - Static method in class net.sourceforge.argparse4j.impl.Arguments
-
Returns count action.
- CountArgumentAction - Class in net.sourceforge.argparse4j.impl.action
-
Argument action to count the occurrence of the option.
- CountArgumentAction() - Constructor for class net.sourceforge.argparse4j.impl.action.CountArgumentAction
D
- DEFAULT_FORMAT_WIDTH - Static variable in class net.sourceforge.argparse4j.ArgumentParsers
-
Default format width of text output.
- DEFAULT_PREFIX_CHARS - Static variable in class net.sourceforge.argparse4j.ArgumentParsers
-
Default prefix characters.
- defaultFormatWidth(int) - Method in class net.sourceforge.argparse4j.ArgumentParserBuilder
-
Set the default format width.
- defaultHelp(boolean) - Method in interface net.sourceforge.argparse4j.inf.ArgumentParser
-
If defaultHelp is
true
, the default values of arguments are printed in help message. - defaultHelp(boolean) - Method in interface net.sourceforge.argparse4j.inf.Subparser
- defaultHelp(boolean) - Method in class net.sourceforge.argparse4j.internal.ArgumentParserImpl
- defaultHelp(boolean) - Method in class net.sourceforge.argparse4j.internal.SubparserImpl
- DefaultSettings - Enum in net.sourceforge.argparse4j
-
Use one of these values with
ArgumentParsers.newFor(String, DefaultSettings)
to specify of which version the default settings must be used. - description(String) - Method in interface net.sourceforge.argparse4j.inf.ArgumentContainer
-
Sets the description for the arguments of this container.
- description(String) - Method in interface net.sourceforge.argparse4j.inf.ArgumentGroup
- description(String) - Method in interface net.sourceforge.argparse4j.inf.ArgumentParser
- description(String) - Method in interface net.sourceforge.argparse4j.inf.MutuallyExclusiveGroup
- description(String) - Method in interface net.sourceforge.argparse4j.inf.Subparser
- description(String) - Method in interface net.sourceforge.argparse4j.inf.Subparsers
-
Sets the text to display to briefly describe sub-commands in the help message.
- description(String) - Method in class net.sourceforge.argparse4j.internal.ArgumentGroupImpl
- description(String) - Method in class net.sourceforge.argparse4j.internal.ArgumentParserImpl
-
Set text to display before the argument help.
- description(String) - Method in class net.sourceforge.argparse4j.internal.SubparserImpl
- description(String) - Method in class net.sourceforge.argparse4j.internal.SubparsersImpl
- dest() - Method in annotation type net.sourceforge.argparse4j.annotation.Arg
-
The name of attribute to be assigned.
- dest(String) - Method in interface net.sourceforge.argparse4j.inf.Argument
-
The name of the attribute to be added.
- dest(String) - Method in interface net.sourceforge.argparse4j.inf.Subparsers
-
Sets the name of attribute which the selected command name is stored.
- dest(String) - Method in class net.sourceforge.argparse4j.internal.ArgumentImpl
- dest(String) - Method in class net.sourceforge.argparse4j.internal.SubparsersImpl
E
- EnumArgumentType<T extends Enum<T>> - Class in net.sourceforge.argparse4j.impl.type
-
Deprecated.Use
ReflectArgumentType
instead. - EnumArgumentType(Class<T>) - Constructor for class net.sourceforge.argparse4j.impl.type.EnumArgumentType
-
Deprecated.
- EnumStringArgumentType<T extends Enum<T>> - Class in net.sourceforge.argparse4j.impl.type
-
ArgumentType subclass for enum type.
- EnumStringArgumentType(Class<T>) - Constructor for class net.sourceforge.argparse4j.impl.type.EnumStringArgumentType
- enumStringType(Class<T>) - Static method in class net.sourceforge.argparse4j.impl.Arguments
-
Returns
EnumStringArgumentType
with given enumtype
. - enumType(Class<T>) - Static method in class net.sourceforge.argparse4j.impl.Arguments
-
Deprecated.
- epilog(String) - Method in interface net.sourceforge.argparse4j.inf.ArgumentParser
-
Sets the text to display after the argument help.
- epilog(String) - Method in interface net.sourceforge.argparse4j.inf.Subparser
- epilog(String) - Method in class net.sourceforge.argparse4j.internal.ArgumentParserImpl
- epilog(String) - Method in class net.sourceforge.argparse4j.internal.SubparserImpl
- equals(Object) - Method in class net.sourceforge.argparse4j.internal.ArgumentParserImpl.Candidate
- exists(File) - Method in class net.sourceforge.argparse4j.impl.type.FileVerification
F
- FeatureControl - Enum in net.sourceforge.argparse4j.inf
-
This enum defines constants to be used throughout the argparse4j package.
- FileArgumentType - Class in net.sourceforge.argparse4j.impl.type
-
ArgumentType subclass for File type, using fluent style API.
- FileArgumentType() - Constructor for class net.sourceforge.argparse4j.impl.type.FileArgumentType
- fileType() - Static method in class net.sourceforge.argparse4j.impl.Arguments
-
Returns new
FileArgumentType
object. - FileVerification - Class in net.sourceforge.argparse4j.impl.type
-
Verifies properties of files.
- FileVerification() - Constructor for class net.sourceforge.argparse4j.impl.type.FileVerification
- findPrefix(Collection<String>, String) - Static method in class net.sourceforge.argparse4j.helper.TextHelper
-
From src, find string whose prefix is prefix and store them in List and return it.
- forEnum(Class<T>) - Static method in class net.sourceforge.argparse4j.impl.type.CaseInsensitiveEnumNameArgumentType
-
Creates a
CaseInsensitiveEnumNameArgumentType
for the given enum type. - forEnum(Class<T>) - Static method in class net.sourceforge.argparse4j.impl.type.CaseInsensitiveEnumStringArgumentType
-
Creates a
CaseInsensitiveEnumStringArgumentType
for the given enum type. - forEnum(Class<T>) - Static method in class net.sourceforge.argparse4j.impl.type.EnumStringArgumentType
-
Creates an
EnumStringArgumentType
for the given enum type. - formatHelp() - Method in interface net.sourceforge.argparse4j.inf.ArgumentParser
-
Returns help message.
- formatHelp() - Method in class net.sourceforge.argparse4j.internal.ArgumentParserImpl
- formatHelp() - Method in class net.sourceforge.argparse4j.internal.SubparserImpl
- formatUsage() - Method in interface net.sourceforge.argparse4j.inf.ArgumentParser
-
Returns a brief description of how the program should be invoked on the command line.
- formatUsage() - Method in class net.sourceforge.argparse4j.internal.ArgumentParserImpl
- formatUsage() - Method in class net.sourceforge.argparse4j.internal.SubparserImpl
- formatVersion() - Method in interface net.sourceforge.argparse4j.inf.ArgumentParser
-
Returns version string.
- formatVersion() - Method in class net.sourceforge.argparse4j.internal.ArgumentParserImpl
- formatVersion() - Method in class net.sourceforge.argparse4j.internal.SubparserImpl
- fromFilePrefix(String) - Method in class net.sourceforge.argparse4j.ArgumentParserBuilder
-
The set of characters that prefix file path from which additional arguments should be read.
G
- get(String) - Method in class net.sourceforge.argparse4j.inf.Namespace
-
Returns attribute with given attribute name
dest
. - getAction() - Method in class net.sourceforge.argparse4j.internal.ArgumentImpl
- getArgs() - Method in class net.sourceforge.argparse4j.internal.ArgumentGroupImpl
- getArgument() - Method in exception net.sourceforge.argparse4j.internal.UnrecognizedArgumentException
- getAttrs() - Method in class net.sourceforge.argparse4j.inf.Namespace
-
Returns
Map
object holding attribute values. - getBoolean(String) - Method in class net.sourceforge.argparse4j.inf.Namespace
-
Returns attribute as
Boolean
with given attribute namedest
. - getByte(String) - Method in class net.sourceforge.argparse4j.inf.Namespace
-
Returns attribute as
Byte
with given attribute namedest
. - getCjkWidthHack() - Static method in class net.sourceforge.argparse4j.ArgumentParsers
-
Deprecated.This is not thread safe. Use
ArgumentParsers.newFor(String)
instead. - getCommand() - Method in class net.sourceforge.argparse4j.internal.ArgumentParserImpl
- getCommand() - Method in class net.sourceforge.argparse4j.internal.SubparserImpl
- getCommand() - Method in exception net.sourceforge.argparse4j.internal.UnrecognizedCommandException
- getConfig() - Method in interface net.sourceforge.argparse4j.inf.ArgumentParser
-
Get the configuration of this argument parser.
- getConfig() - Method in class net.sourceforge.argparse4j.internal.ArgumentParserImpl
- getConfig() - Method in class net.sourceforge.argparse4j.internal.SubparserImpl
- getConst() - Method in interface net.sourceforge.argparse4j.inf.Argument
-
Returns const value.
- getConst() - Method in class net.sourceforge.argparse4j.internal.ArgumentImpl
- getDefault() - Method in interface net.sourceforge.argparse4j.inf.Argument
-
Returns default value.
- getDefault() - Method in class net.sourceforge.argparse4j.internal.ArgumentImpl
- getDefault(String) - Method in interface net.sourceforge.argparse4j.inf.ArgumentParser
-
Returns default value of given
dest
. - getDefault(String) - Method in class net.sourceforge.argparse4j.internal.ArgumentParserImpl
-
Returns default value set by
ArgumentImpl.setDefault(Object)
orArgumentParserImpl.setDefault(String, Object)
. - getDefault(String) - Method in class net.sourceforge.argparse4j.internal.SubparserImpl
- getDefaultControl() - Method in interface net.sourceforge.argparse4j.inf.Argument
-
Returns default control.
- getDefaultControl() - Method in class net.sourceforge.argparse4j.internal.ArgumentImpl
- getDescription() - Method in class net.sourceforge.argparse4j.internal.SubparsersImpl
- getDest() - Method in interface net.sourceforge.argparse4j.inf.Argument
-
Returns dest value.
- getDest() - Method in class net.sourceforge.argparse4j.internal.ArgumentImpl
- getDouble(String) - Method in class net.sourceforge.argparse4j.inf.Namespace
-
Returns attribute as
Double
with given attribute namedest
. - getFloat(String) - Method in class net.sourceforge.argparse4j.inf.Namespace
-
Returns attribute as
Float
with given attribute namedest
. - getFormatWidth() - Static method in class net.sourceforge.argparse4j.ArgumentParsers
-
Deprecated.This is not thread safe. Use
ArgumentParsers.newFor(String)
instead. - getFromFilePrefixChars() - Method in class net.sourceforge.argparse4j.internal.ArgumentParserImpl
- getHelp() - Method in class net.sourceforge.argparse4j.internal.ArgumentImpl
- getHelpControl() - Method in interface net.sourceforge.argparse4j.inf.Argument
-
Returns help control.
- getHelpControl() - Method in class net.sourceforge.argparse4j.internal.ArgumentImpl
- getInt(String) - Method in class net.sourceforge.argparse4j.inf.Namespace
-
Returns attribute as
Integer
with given attribute namedest
. - getList(String) - Method in class net.sourceforge.argparse4j.inf.Namespace
-
Returns attribute as
List
with given attribute namedest
. - getLocale() - Method in interface net.sourceforge.argparse4j.inf.ArgumentParserConfiguration
-
Returns Locale for this configuration.
- getLocale() - Method in class net.sourceforge.argparse4j.internal.ArgumentParserConfigurationImpl
- getLong(String) - Method in class net.sourceforge.argparse4j.inf.Namespace
-
Returns attribute as
Long
with given attribute namedest
. - getMetavar() - Method in class net.sourceforge.argparse4j.internal.ArgumentImpl
- getName() - Method in class net.sourceforge.argparse4j.internal.ArgumentImpl
- getNoDestConversionForPositionalArgs() - Static method in class net.sourceforge.argparse4j.ArgumentParsers
-
Deprecated.This is not thread safe. Use
ArgumentParsers.newFor(String)
instead. - getParser() - Method in exception net.sourceforge.argparse4j.inf.ArgumentParserException
- getPrefixChars() - Method in class net.sourceforge.argparse4j.helper.PrefixPattern
-
Returns prefixChars with this object constructed.
- getPrefixChars() - Method in class net.sourceforge.argparse4j.internal.ArgumentParserImpl
- getPrefixPattern() - Method in class net.sourceforge.argparse4j.helper.PrefixPattern
-
Returns compiled regular expression pattern of prefixChars.
- getProg() - Method in class net.sourceforge.argparse4j.internal.ArgumentParserImpl
- getResourceBundle() - Method in interface net.sourceforge.argparse4j.inf.ArgumentParserConfiguration
-
Returns ResourceBundle for this configuration.
- getResourceBundle() - Method in class net.sourceforge.argparse4j.internal.ArgumentParserConfigurationImpl
- getShort(String) - Method in class net.sourceforge.argparse4j.inf.Namespace
-
Returns attribute as
Short
with given attribute namedest
. - getString(String) - Method in class net.sourceforge.argparse4j.inf.Namespace
-
Returns attribute as
String
with given attribute namedest
. - getStringRepresentations() - Method in class net.sourceforge.argparse4j.impl.type.CaseInsensitiveEnumArgumentType
-
Get the objects to be used to generate the String representations of all enum constants.
- getStringRepresentations() - Method in class net.sourceforge.argparse4j.impl.type.CaseInsensitiveEnumNameArgumentType
- getStringRepresentations() - Method in class net.sourceforge.argparse4j.impl.type.CaseInsensitiveEnumStringArgumentType
- getTerminalWidth() - Method in class net.sourceforge.argparse4j.internal.TerminalWidth
- getTerminalWidthDetection() - Static method in class net.sourceforge.argparse4j.ArgumentParsers
-
Deprecated.This is not thread safe. Use
ArgumentParsers.newFor(String)
instead. - getTitle() - Method in class net.sourceforge.argparse4j.internal.SubparsersImpl
H
- handleError(ArgumentParserException) - Method in interface net.sourceforge.argparse4j.inf.ArgumentParser
-
Prints usage and error message.
- handleError(ArgumentParserException) - Method in class net.sourceforge.argparse4j.internal.ArgumentParserImpl
- handleError(ArgumentParserException) - Method in class net.sourceforge.argparse4j.internal.SubparserImpl
- handleError(ArgumentParserException, PrintWriter) - Method in interface net.sourceforge.argparse4j.inf.ArgumentParser
-
Prints usage and error message to the given writer.
- handleError(ArgumentParserException, PrintWriter) - Method in class net.sourceforge.argparse4j.internal.ArgumentParserImpl
- handleError(ArgumentParserException, PrintWriter) - Method in class net.sourceforge.argparse4j.internal.SubparserImpl
- hashCode() - Method in class net.sourceforge.argparse4j.internal.ArgumentParserImpl.Candidate
- help() - Static method in class net.sourceforge.argparse4j.impl.Arguments
-
Returns help action.
- help(String) - Method in interface net.sourceforge.argparse4j.inf.Argument
-
Sets the brief description of what the argument does.
- help(String) - Method in interface net.sourceforge.argparse4j.inf.Subparser
-
Sets the text to display in help message.
- help(String) - Method in interface net.sourceforge.argparse4j.inf.Subparsers
-
Sets the text to display in the help message for sub-commands.
- help(String) - Method in class net.sourceforge.argparse4j.internal.ArgumentImpl
- help(String) - Method in class net.sourceforge.argparse4j.internal.SubparserImpl
- help(String) - Method in class net.sourceforge.argparse4j.internal.SubparsersImpl
- help(FeatureControl) - Method in interface net.sourceforge.argparse4j.inf.Argument
-
Sets special value to control help message handling.
- help(FeatureControl) - Method in interface net.sourceforge.argparse4j.inf.Subparser
-
Sets special value to control help message handling.
- help(FeatureControl) - Method in class net.sourceforge.argparse4j.internal.ArgumentImpl
- help(FeatureControl) - Method in class net.sourceforge.argparse4j.internal.SubparserImpl
- HelpArgumentAction - Class in net.sourceforge.argparse4j.impl.action
-
Argument action to print help message and exit program.
- HelpArgumentAction() - Constructor for class net.sourceforge.argparse4j.impl.action.HelpArgumentAction
- HelpScreenException - Exception in net.sourceforge.argparse4j.helper
-
HelpScreenException is a subclass of ArgumentParserException.
- HelpScreenException(ArgumentParser) - Constructor for exception net.sourceforge.argparse4j.helper.HelpScreenException
I
- ignoreError() - Method in annotation type net.sourceforge.argparse4j.annotation.Arg
-
Set
true
if you want to ignore the error in assignment. - includeArgumentNamesAsKeysInResult(boolean) - Method in class net.sourceforge.argparse4j.ArgumentParserBuilder
-
Include the name (see below) of the argument as a key in the parse result in addition to the key in
dest
of the argument. - inferMetavar() - Method in class net.sourceforge.argparse4j.impl.type.BooleanArgumentType
-
Infers metavar based on given strings.
- inferMetavar() - Method in class net.sourceforge.argparse4j.impl.type.CaseInsensitiveEnumArgumentType
-
Infers metavar based on given type.
- inferMetavar() - Method in class net.sourceforge.argparse4j.impl.type.EnumStringArgumentType
-
Infers metavar based on given type.
- inferMetavar() - Method in class net.sourceforge.argparse4j.impl.type.ReflectArgumentType
-
Infers metavar based on given type.
- inferMetavar() - Method in interface net.sourceforge.argparse4j.inf.MetavarInference
-
Returns inferred array of metavar strings.
- INITIAL_DEFAULT_SETTINGS - net.sourceforge.argparse4j.DefaultSettings
-
Use the default settings of versions before 0.9.0.
- isDirectory(File) - Method in class net.sourceforge.argparse4j.impl.type.FileVerification
- isFile(File) - Method in class net.sourceforge.argparse4j.impl.type.FileVerification
- isRequired() - Method in class net.sourceforge.argparse4j.internal.ArgumentGroupImpl
- isRequired() - Method in class net.sourceforge.argparse4j.internal.ArgumentImpl
- isSingleMetavar() - Static method in class net.sourceforge.argparse4j.ArgumentParsers
-
Deprecated.This is not thread safe. Use
ArgumentParsers.newFor(String)
instead.
L
- LINESEP - Static variable in class net.sourceforge.argparse4j.helper.TextHelper
- list2Array(Class<?>, Object) - Static method in class net.sourceforge.argparse4j.helper.ReflectHelper
-
Convert
src
to object of typetargetType
recursively - locale(Locale) - Method in class net.sourceforge.argparse4j.ArgumentParserBuilder
-
The locale to use for messages.
- LOCALE_ROOT - Static variable in class net.sourceforge.argparse4j.helper.TextHelper
-
Language neutral locale.
- localize(ResourceBundle, String) - Static method in class net.sourceforge.argparse4j.helper.MessageLocalization
- localize(ResourceBundle, String, String) - Static method in class net.sourceforge.argparse4j.helper.MessageLocalization
- localizeTypeNameIfPossible(ArgumentParser, Class<?>) - Static method in class net.sourceforge.argparse4j.helper.TypeNameLocalization
M
- main(String[]) - Static method in class net.sourceforge.argparse4j.internal.TerminalWidth
- match(String) - Method in class net.sourceforge.argparse4j.helper.PrefixPattern
-
Returns
true
if flag stringstr
matches prefixChars. - matchLongFlag(String) - Method in class net.sourceforge.argparse4j.helper.PrefixPattern
-
Returns
true
if flag stringstr
matches prefixChars and it is long flag. - matchShortFlag(String) - Method in class net.sourceforge.argparse4j.helper.PrefixPattern
-
Returns
true
if flag stringstr
matches prefixChars and it is short flag, that is, its matched prefix length must be 1. - MessageLocalization - Class in net.sourceforge.argparse4j.helper
-
MessageLocalization is a helper class to provide methods for localization.
- metavar(String) - Method in interface net.sourceforge.argparse4j.inf.Subparsers
-
Sets the text used to represent sub-commands in help messages.
- metavar(String) - Method in class net.sourceforge.argparse4j.internal.SubparsersImpl
- metavar(String...) - Method in interface net.sourceforge.argparse4j.inf.Argument
-
Set the name for the argument in usage messages.
- metavar(String...) - Method in class net.sourceforge.argparse4j.internal.ArgumentImpl
- MetavarInference - Interface in net.sourceforge.argparse4j.inf
-
This interface provides a way to infer metavar strings from a context which implements this interface.
- mustHelpTextIncludeMutualExclusivity(boolean) - Method in class net.sourceforge.argparse4j.ArgumentParserBuilder
-
Add a text to the help of mutually-exclusive groups explaining that at most 1 arguments of the group may be given.
- MutuallyExclusiveGroup - Interface in net.sourceforge.argparse4j.inf
N
- Namespace - Class in net.sourceforge.argparse4j.inf
-
This class holds attributes added by
ArgumentParser.parseArgs(String[])
. - Namespace(Map<String, Object>) - Constructor for class net.sourceforge.argparse4j.inf.Namespace
-
Construct this object using given
attrs
. - nargs(int) - Method in interface net.sourceforge.argparse4j.inf.Argument
-
Sets the number of command line arguments that should be consumed.
- nargs(int) - Method in class net.sourceforge.argparse4j.internal.ArgumentImpl
- nargs(String) - Method in interface net.sourceforge.argparse4j.inf.Argument
-
Sets the number of command line arguments that should be consumed.
- nargs(String) - Method in class net.sourceforge.argparse4j.internal.ArgumentImpl
- net.sourceforge.argparse4j - package net.sourceforge.argparse4j
- net.sourceforge.argparse4j.annotation - package net.sourceforge.argparse4j.annotation
- net.sourceforge.argparse4j.ext.java7 - package net.sourceforge.argparse4j.ext.java7
- net.sourceforge.argparse4j.helper - package net.sourceforge.argparse4j.helper
- net.sourceforge.argparse4j.impl - package net.sourceforge.argparse4j.impl
- net.sourceforge.argparse4j.impl.action - package net.sourceforge.argparse4j.impl.action
- net.sourceforge.argparse4j.impl.choice - package net.sourceforge.argparse4j.impl.choice
- net.sourceforge.argparse4j.impl.type - package net.sourceforge.argparse4j.impl.type
- net.sourceforge.argparse4j.inf - package net.sourceforge.argparse4j.inf
- net.sourceforge.argparse4j.internal - package net.sourceforge.argparse4j.internal
- newArgumentParser(String) - Static method in class net.sourceforge.argparse4j.ArgumentParsers
-
Deprecated.This is not thread safe. Use
ArgumentParsers.newFor(String)
instead. - newArgumentParser(String, boolean) - Static method in class net.sourceforge.argparse4j.ArgumentParsers
-
Deprecated.This is not thread safe. Use
ArgumentParsers.newFor(String)
instead. - newArgumentParser(String, boolean, String) - Static method in class net.sourceforge.argparse4j.ArgumentParsers
-
Deprecated.This is not thread safe. Use
ArgumentParsers.newFor(String)
instead. - newArgumentParser(String, boolean, String, String) - Static method in class net.sourceforge.argparse4j.ArgumentParsers
-
Deprecated.This is not thread safe. Use
ArgumentParsers.newFor(String)
instead. - newFor(String) - Static method in class net.sourceforge.argparse4j.ArgumentParsers
-
Creates
ArgumentParserBuilder
with given program name. - newFor(String, DefaultSettings) - Static method in class net.sourceforge.argparse4j.ArgumentParsers
-
Creates
ArgumentParserBuilder
with given program name and default settings. - noDestConversionForPositionalArgs(boolean) - Method in class net.sourceforge.argparse4j.ArgumentParserBuilder
-
Do not perform any conversion to produce "dest" value (See
Argument.getDest()
) from positional argument name. - nonNull(String) - Static method in class net.sourceforge.argparse4j.helper.TextHelper
O
- onAttach(Argument) - Method in class net.sourceforge.argparse4j.impl.action.AppendArgumentAction
- onAttach(Argument) - Method in class net.sourceforge.argparse4j.impl.action.AppendConstArgumentAction
- onAttach(Argument) - Method in class net.sourceforge.argparse4j.impl.action.CountArgumentAction
- onAttach(Argument) - Method in class net.sourceforge.argparse4j.impl.action.HelpArgumentAction
- onAttach(Argument) - Method in class net.sourceforge.argparse4j.impl.action.StoreArgumentAction
- onAttach(Argument) - Method in class net.sourceforge.argparse4j.impl.action.StoreConstArgumentAction
- onAttach(Argument) - Method in class net.sourceforge.argparse4j.impl.action.StoreFalseArgumentAction
- onAttach(Argument) - Method in class net.sourceforge.argparse4j.impl.action.StoreTrueArgumentAction
- onAttach(Argument) - Method in class net.sourceforge.argparse4j.impl.action.VersionArgumentAction
- onAttach(Argument) - Method in interface net.sourceforge.argparse4j.inf.ArgumentAction
-
Called when ArgumentAction is added to
Argument
usingArgument.action(ArgumentAction)
. - or() - Method in class net.sourceforge.argparse4j.ext.java7.PathArgumentType
-
Start a new verification group.
- or() - Method in class net.sourceforge.argparse4j.impl.type.FileArgumentType
-
Start a new verification group.
- or() - Method in class net.sourceforge.argparse4j.impl.type.FileVerification
P
- parseArgs(String[]) - Method in interface net.sourceforge.argparse4j.inf.ArgumentParser
-
Parses command line arguments.
- parseArgs(String[]) - Method in class net.sourceforge.argparse4j.internal.ArgumentParserImpl
- parseArgs(String[]) - Method in class net.sourceforge.argparse4j.internal.SubparserImpl
- parseArgs(String[], Object) - Method in interface net.sourceforge.argparse4j.inf.ArgumentParser
-
Parses command line arguments.
- parseArgs(String[], Object) - Method in class net.sourceforge.argparse4j.internal.ArgumentParserImpl
- parseArgs(String[], Object) - Method in class net.sourceforge.argparse4j.internal.SubparserImpl
- parseArgs(String[], Map<String, Object>) - Method in interface net.sourceforge.argparse4j.inf.ArgumentParser
-
Parses command line arguments.
- parseArgs(String[], Map<String, Object>) - Method in class net.sourceforge.argparse4j.internal.ArgumentParserImpl
- parseArgs(String[], Map<String, Object>) - Method in class net.sourceforge.argparse4j.internal.SubparserImpl
- parseArgs(String[], Map<String, Object>, Object) - Method in interface net.sourceforge.argparse4j.inf.ArgumentParser
-
Parses command line arguments.
- parseArgs(String[], Map<String, Object>, Object) - Method in class net.sourceforge.argparse4j.internal.ArgumentParserImpl
- parseArgs(String[], Map<String, Object>, Object) - Method in class net.sourceforge.argparse4j.internal.SubparserImpl
- parseArgsOrFail(String[]) - Method in interface net.sourceforge.argparse4j.inf.ArgumentParser
-
Parses command line arguments, handling any errors.
- parseArgsOrFail(String[]) - Method in class net.sourceforge.argparse4j.internal.ArgumentParserImpl
- parseArgsOrFail(String[]) - Method in class net.sourceforge.argparse4j.internal.SubparserImpl
- parseKnownArgs(String[], List<String>) - Method in interface net.sourceforge.argparse4j.inf.ArgumentParser
-
Just like
ArgumentParser.parseArgs(String[])
, but parses only known arguments without throwing exception for unrecognized arguments. - parseKnownArgs(String[], List<String>) - Method in class net.sourceforge.argparse4j.internal.ArgumentParserImpl
- parseKnownArgs(String[], List<String>) - Method in class net.sourceforge.argparse4j.internal.SubparserImpl
- parseKnownArgs(String[], List<String>, Object) - Method in interface net.sourceforge.argparse4j.inf.ArgumentParser
-
Just like
ArgumentParser.parseArgs(String[], Object)
, but parses only known arguments without throwing exception for unrecognized arguments. - parseKnownArgs(String[], List<String>, Object) - Method in class net.sourceforge.argparse4j.internal.ArgumentParserImpl
- parseKnownArgs(String[], List<String>, Object) - Method in class net.sourceforge.argparse4j.internal.SubparserImpl
- parseKnownArgs(String[], List<String>, Map<String, Object>) - Method in interface net.sourceforge.argparse4j.inf.ArgumentParser
-
Just like
ArgumentParser.parseArgs(String[], Map)
, but parses only known arguments without throwing exception for unrecognized arguments. - parseKnownArgs(String[], List<String>, Map<String, Object>) - Method in class net.sourceforge.argparse4j.internal.ArgumentParserImpl
- parseKnownArgs(String[], List<String>, Map<String, Object>) - Method in class net.sourceforge.argparse4j.internal.SubparserImpl
- parseKnownArgs(String[], List<String>, Map<String, Object>, Object) - Method in interface net.sourceforge.argparse4j.inf.ArgumentParser
-
Just like
ArgumentParser.parseArgs(String[], Map, Object)
, but parses only known arguments without throwing exception for unrecognized arguments. - parseKnownArgs(String[], List<String>, Map<String, Object>, Object) - Method in class net.sourceforge.argparse4j.internal.ArgumentParserImpl
- parseKnownArgs(String[], List<String>, Map<String, Object>, Object) - Method in class net.sourceforge.argparse4j.internal.SubparserImpl
- parseKnownArgsOrFail(String[], List<String>) - Method in interface net.sourceforge.argparse4j.inf.ArgumentParser
-
Just like
ArgumentParser.parseArgsOrFail(String[])
, but parses only known arguments without throwing exception for unrecognized arguments. - parseKnownArgsOrFail(String[], List<String>) - Method in class net.sourceforge.argparse4j.internal.ArgumentParserImpl
- parseKnownArgsOrFail(String[], List<String>) - Method in class net.sourceforge.argparse4j.internal.SubparserImpl
- PathArgumentType - Class in net.sourceforge.argparse4j.ext.java7
-
ArgumentType subclass for Path type, using fluent style API.
- PathArgumentType() - Constructor for class net.sourceforge.argparse4j.ext.java7.PathArgumentType
-
Create an instance using the default file system for resolving the path.
- PathArgumentType(FileSystem) - Constructor for class net.sourceforge.argparse4j.ext.java7.PathArgumentType
-
Create an instance using the given file system for resolving the path.
- prefixChars(String) - Method in class net.sourceforge.argparse4j.ArgumentParserBuilder
-
The set of characters that prefix named arguments.
- PrefixPattern - Class in net.sourceforge.argparse4j.helper
-
This object performs operations related to prefixChars of option flags.
- PrefixPattern(String) - Constructor for class net.sourceforge.argparse4j.helper.PrefixPattern
-
Creates this object using given
prefixChars
. - printHelp() - Method in interface net.sourceforge.argparse4j.inf.ArgumentParser
-
Prints help message in stdout.
- printHelp() - Method in class net.sourceforge.argparse4j.internal.ArgumentParserImpl
- printHelp() - Method in class net.sourceforge.argparse4j.internal.SubparserImpl
- printHelp(PrintWriter) - Method in interface net.sourceforge.argparse4j.inf.ArgumentParser
-
Prints help message in writer.
- printHelp(PrintWriter) - Method in class net.sourceforge.argparse4j.internal.ArgumentParserImpl
- printHelp(PrintWriter) - Method in class net.sourceforge.argparse4j.internal.SubparserImpl
- printHelp(PrintWriter, boolean, TextWidthCounter, int) - Method in class net.sourceforge.argparse4j.internal.ArgumentImpl
- printHelp(PrintWriter, int) - Method in class net.sourceforge.argparse4j.internal.ArgumentGroupImpl
- printHelp(PrintWriter, String, String, TextWidthCounter, int) - Static method in class net.sourceforge.argparse4j.helper.TextHelper
- printUsage() - Method in interface net.sourceforge.argparse4j.inf.ArgumentParser
-
Print a brief description of how the program should be invoked on the command line in stdout.
- printUsage() - Method in class net.sourceforge.argparse4j.internal.ArgumentParserImpl
- printUsage() - Method in class net.sourceforge.argparse4j.internal.SubparserImpl
- printUsage(PrintWriter) - Method in interface net.sourceforge.argparse4j.inf.ArgumentParser
-
Print a brief description of how the program should be invoked on the command line in writer.
- printUsage(PrintWriter) - Method in class net.sourceforge.argparse4j.internal.ArgumentParserImpl
- printUsage(PrintWriter) - Method in class net.sourceforge.argparse4j.internal.SubparserImpl
- printVersion() - Method in interface net.sourceforge.argparse4j.inf.ArgumentParser
-
Prints version string in stdout.
- printVersion() - Method in class net.sourceforge.argparse4j.internal.ArgumentParserImpl
- printVersion() - Method in class net.sourceforge.argparse4j.internal.SubparserImpl
- printVersion(PrintWriter) - Method in interface net.sourceforge.argparse4j.inf.ArgumentParser
-
Prints version string in writer.
- printVersion(PrintWriter) - Method in class net.sourceforge.argparse4j.internal.ArgumentParserImpl
- printVersion(PrintWriter) - Method in class net.sourceforge.argparse4j.internal.SubparserImpl
R
- range(T, T) - Static method in class net.sourceforge.argparse4j.impl.Arguments
-
Creates new range constrained choice.
- RangeArgumentChoice<T extends Comparable<T>> - Class in net.sourceforge.argparse4j.impl.choice
-
Choices from given range.
- RangeArgumentChoice(T, T) - Constructor for class net.sourceforge.argparse4j.impl.choice.RangeArgumentChoice
-
Creates object using range [
min
,max
], inclusive. - ReflectArgumentType<T> - Class in net.sourceforge.argparse4j.impl.type
-
This implementation converts String value into given type using type's
valueOf(java.lang.String)
static method or its constructor. - ReflectArgumentType(Class<T>) - Constructor for class net.sourceforge.argparse4j.impl.type.ReflectArgumentType
-
Creates
ReflectArgumentType
object with giventype
. - ReflectHelper - Class in net.sourceforge.argparse4j.helper
-
This class provides helper functions related to reflection.
- removePrefix(String) - Method in class net.sourceforge.argparse4j.helper.PrefixPattern
-
Removes prefixChars from given flag string.
- required(boolean) - Method in interface net.sourceforge.argparse4j.inf.Argument
-
If
true
is given, this named argument must be specified in command line otherwise error will be issued. - required(boolean) - Method in interface net.sourceforge.argparse4j.inf.MutuallyExclusiveGroup
-
If
true
is given, one of the arguments in this group must be specified otherwise error will be issued. - required(boolean) - Method in class net.sourceforge.argparse4j.internal.ArgumentGroupImpl
- required(boolean) - Method in class net.sourceforge.argparse4j.internal.ArgumentImpl
- run(ArgumentParser, Argument, Map<String, Object>, String, Object) - Method in class net.sourceforge.argparse4j.impl.action.AppendArgumentAction
- run(ArgumentParser, Argument, Map<String, Object>, String, Object) - Method in class net.sourceforge.argparse4j.impl.action.AppendConstArgumentAction
- run(ArgumentParser, Argument, Map<String, Object>, String, Object) - Method in class net.sourceforge.argparse4j.impl.action.CountArgumentAction
- run(ArgumentParser, Argument, Map<String, Object>, String, Object) - Method in class net.sourceforge.argparse4j.impl.action.HelpArgumentAction
- run(ArgumentParser, Argument, Map<String, Object>, String, Object) - Method in class net.sourceforge.argparse4j.impl.action.StoreArgumentAction
- run(ArgumentParser, Argument, Map<String, Object>, String, Object) - Method in class net.sourceforge.argparse4j.impl.action.StoreConstArgumentAction
- run(ArgumentParser, Argument, Map<String, Object>, String, Object) - Method in class net.sourceforge.argparse4j.impl.action.StoreFalseArgumentAction
- run(ArgumentParser, Argument, Map<String, Object>, String, Object) - Method in class net.sourceforge.argparse4j.impl.action.StoreTrueArgumentAction
- run(ArgumentParser, Argument, Map<String, Object>, String, Object) - Method in class net.sourceforge.argparse4j.impl.action.VersionArgumentAction
- run(ArgumentParser, Argument, Map<String, Object>, String, Object) - Method in interface net.sourceforge.argparse4j.inf.ArgumentAction
-
Deprecated.Does not provide the flexibility to let the parser and/or argument decide how the value is stored.
ArgumentAction.run(ArgumentParser, Argument, Map, String, Object, Consumer)
will be called instead. Existing actions should implement that method. - run(ArgumentParser, Argument, Map<String, Object>, String, Object, Consumer<Object>) - Method in class net.sourceforge.argparse4j.impl.action.AppendArgumentAction
- run(ArgumentParser, Argument, Map<String, Object>, String, Object, Consumer<Object>) - Method in class net.sourceforge.argparse4j.impl.action.AppendConstArgumentAction
- run(ArgumentParser, Argument, Map<String, Object>, String, Object, Consumer<Object>) - Method in class net.sourceforge.argparse4j.impl.action.CountArgumentAction
- run(ArgumentParser, Argument, Map<String, Object>, String, Object, Consumer<Object>) - Method in class net.sourceforge.argparse4j.impl.action.StoreArgumentAction
- run(ArgumentParser, Argument, Map<String, Object>, String, Object, Consumer<Object>) - Method in class net.sourceforge.argparse4j.impl.action.StoreConstArgumentAction
- run(ArgumentParser, Argument, Map<String, Object>, String, Object, Consumer<Object>) - Method in class net.sourceforge.argparse4j.impl.action.StoreFalseArgumentAction
- run(ArgumentParser, Argument, Map<String, Object>, String, Object, Consumer<Object>) - Method in class net.sourceforge.argparse4j.impl.action.StoreTrueArgumentAction
- run(ArgumentParser, Argument, Map<String, Object>, String, Object, Consumer<Object>) - Method in interface net.sourceforge.argparse4j.inf.ArgumentAction
-
Executes this action.
- run(ArgumentParserImpl, Map<String, Object>, String, Object, Consumer<Object>) - Method in class net.sourceforge.argparse4j.internal.ArgumentImpl
S
- setCJKWidthHack(boolean) - Static method in class net.sourceforge.argparse4j.ArgumentParsers
-
Deprecated.This is not thread safe. Use
ArgumentParsers.newFor(String)
instead. - setConst(E...) - Method in interface net.sourceforge.argparse4j.inf.Argument
-
Sets list of constant values that are not read from the command line but are required for the various actions.
- setConst(E...) - Method in class net.sourceforge.argparse4j.internal.ArgumentImpl
- setConst(Object) - Method in interface net.sourceforge.argparse4j.inf.Argument
-
Sets constant values that are not read from the command line but are required for the various actions.
- setConst(Object) - Method in class net.sourceforge.argparse4j.internal.ArgumentImpl
- setDefault(E...) - Method in interface net.sourceforge.argparse4j.inf.Argument
-
Sets list of values which should be used if the command line argument is not present.
- setDefault(E...) - Method in class net.sourceforge.argparse4j.internal.ArgumentImpl
- setDefault(Object) - Method in interface net.sourceforge.argparse4j.inf.Argument
-
Sets value which should be used if the command line argument is not present.
- setDefault(Object) - Method in class net.sourceforge.argparse4j.internal.ArgumentImpl
- setDefault(String, Object) - Method in interface net.sourceforge.argparse4j.inf.ArgumentParser
-
Sets parser-level default value of attribute
dest
. - setDefault(String, Object) - Method in interface net.sourceforge.argparse4j.inf.Subparser
- setDefault(String, Object) - Method in class net.sourceforge.argparse4j.internal.ArgumentParserImpl
- setDefault(String, Object) - Method in class net.sourceforge.argparse4j.internal.SubparserImpl
- setDefault(FeatureControl) - Method in interface net.sourceforge.argparse4j.inf.Argument
-
Sets special value to control default value handling.
- setDefault(FeatureControl) - Method in class net.sourceforge.argparse4j.internal.ArgumentImpl
- setDefaults(Map<String, Object>) - Method in interface net.sourceforge.argparse4j.inf.ArgumentParser
-
Sets parser-level default values from
attrs
. - setDefaults(Map<String, Object>) - Method in interface net.sourceforge.argparse4j.inf.Subparser
- setDefaults(Map<String, Object>) - Method in class net.sourceforge.argparse4j.internal.ArgumentParserImpl
- setDefaults(Map<String, Object>) - Method in class net.sourceforge.argparse4j.internal.SubparserImpl
- setNoDestConversionForPositionalArgs(boolean) - Static method in class net.sourceforge.argparse4j.ArgumentParsers
-
Deprecated.This is not thread safe. Use
ArgumentParsers.newFor(String)
instead. - setSingleMetavar(boolean) - Static method in class net.sourceforge.argparse4j.ArgumentParsers
-
Deprecated.This is not thread safe. Use
ArgumentParsers.newFor(String)
instead. - setTerminalWidthDetection(boolean) - Static method in class net.sourceforge.argparse4j.ArgumentParsers
-
Deprecated.This is not thread safe. Use
ArgumentParsers.newFor(String)
instead. - singleMetavar(boolean) - Method in class net.sourceforge.argparse4j.ArgumentParserBuilder
-
If singleMetavar is
true
, a metavar string in help message is only shown after the last flag instead of each flag. - store() - Static method in class net.sourceforge.argparse4j.impl.Arguments
-
Returns store action.
- StoreArgumentAction - Class in net.sourceforge.argparse4j.impl.action
-
Argument action to store argument value.
- StoreArgumentAction() - Constructor for class net.sourceforge.argparse4j.impl.action.StoreArgumentAction
- storeConst() - Static method in class net.sourceforge.argparse4j.impl.Arguments
-
Returns storeConst action.
- StoreConstArgumentAction - Class in net.sourceforge.argparse4j.impl.action
-
Argument action to store the value specified by the
Argument.setConst(Object)
. - StoreConstArgumentAction() - Constructor for class net.sourceforge.argparse4j.impl.action.StoreConstArgumentAction
- storeFalse() - Static method in class net.sourceforge.argparse4j.impl.Arguments
-
Returns storeFalse action.
- StoreFalseArgumentAction - Class in net.sourceforge.argparse4j.impl.action
-
Argument action to store value
false
. - StoreFalseArgumentAction() - Constructor for class net.sourceforge.argparse4j.impl.action.StoreFalseArgumentAction
- storeTrue() - Static method in class net.sourceforge.argparse4j.impl.Arguments
-
Returns storeTrue action.
- StoreTrueArgumentAction - Class in net.sourceforge.argparse4j.impl.action
-
Argument action to store value
true
. - StoreTrueArgumentAction() - Constructor for class net.sourceforge.argparse4j.impl.action.StoreTrueArgumentAction
- StringArgumentType - Class in net.sourceforge.argparse4j.impl.type
-
Specialized to String type, just echos back given string.
- StringArgumentType() - Constructor for class net.sourceforge.argparse4j.impl.type.StringArgumentType
- subject - Variable in class net.sourceforge.argparse4j.internal.ArgumentParserImpl.Candidate
- Subparser - Interface in net.sourceforge.argparse4j.inf
-
This interface defines Subparser used to add sub-command to
ArgumentParser
. - SubparserImpl - Class in net.sourceforge.argparse4j.internal
-
The application code must not use this class directly.
- Subparsers - Interface in net.sourceforge.argparse4j.inf
-
This interface defines Subparsers which used to add
Subparser
. - SubparsersImpl - Class in net.sourceforge.argparse4j.internal
-
The application code must not use this class directly.
- SUPPRESS - net.sourceforge.argparse4j.inf.FeatureControl
- SUPPRESS - Static variable in class net.sourceforge.argparse4j.impl.Arguments
-
The value of
FeatureControl.SUPPRESS
.
T
- TerminalWidth - Class in net.sourceforge.argparse4j.internal
-
Returns the column width of the command line terminal from which this program was started.
- TerminalWidth() - Constructor for class net.sourceforge.argparse4j.internal.TerminalWidth
- terminalWidthDetection(boolean) - Method in class net.sourceforge.argparse4j.ArgumentParserBuilder
-
Set
true
to enable terminal width detection. - TextHelper - Class in net.sourceforge.argparse4j.helper
-
This class provides various helper function related to text processing.
- textualFormat() - Method in class net.sourceforge.argparse4j.impl.choice.CollectionArgumentChoice
- textualFormat() - Method in class net.sourceforge.argparse4j.impl.choice.RangeArgumentChoice
- textualFormat() - Method in interface net.sourceforge.argparse4j.inf.ArgumentChoice
-
Return textual representation of this choice.
- textualName() - Method in interface net.sourceforge.argparse4j.inf.Argument
-
Returns textual representation of the argument name.
- textualName() - Method in class net.sourceforge.argparse4j.internal.ArgumentImpl
- TextWidthCounter - Interface in net.sourceforge.argparse4j.helper
-
This interface abstracts the way of counting text width.
- title(String) - Method in interface net.sourceforge.argparse4j.inf.Subparsers
-
Sets the text to display as a title of sub-commands in the help message.
- title(String) - Method in class net.sourceforge.argparse4j.internal.SubparsersImpl
- toString() - Method in class net.sourceforge.argparse4j.impl.choice.CollectionArgumentChoice
- toString() - Method in class net.sourceforge.argparse4j.impl.choice.RangeArgumentChoice
- toString() - Method in class net.sourceforge.argparse4j.inf.Namespace
- toStringRepresentation(T) - Method in class net.sourceforge.argparse4j.impl.type.CaseInsensitiveEnumArgumentType
-
Convert the given enum value to its string representation.
- toStringRepresentation(T) - Method in class net.sourceforge.argparse4j.impl.type.CaseInsensitiveEnumNameArgumentType
- toStringRepresentation(T) - Method in class net.sourceforge.argparse4j.impl.type.CaseInsensitiveEnumStringArgumentType
- type(Class<T>) - Method in interface net.sourceforge.argparse4j.inf.Argument
-
Sets the type which the command line argument should be converted to.
- type(Class<T>) - Method in class net.sourceforge.argparse4j.internal.ArgumentImpl
- type(ArgumentType<T>) - Method in interface net.sourceforge.argparse4j.inf.Argument
-
Sets
ArgumentType
object which converts command line argument to appropriate type. - type(ArgumentType<T>) - Method in class net.sourceforge.argparse4j.internal.ArgumentImpl
- type_ - Variable in class net.sourceforge.argparse4j.impl.type.CaseInsensitiveEnumArgumentType
- TypeNameLocalization - Class in net.sourceforge.argparse4j.helper
-
Localization of names for argument types.
U
- UnrecognizedArgumentException - Exception in net.sourceforge.argparse4j.internal
-
Exception thrown when unrecognized argument is encountered.
- UnrecognizedArgumentException(String, ArgumentParser, String) - Constructor for exception net.sourceforge.argparse4j.internal.UnrecognizedArgumentException
- UnrecognizedCommandException - Exception in net.sourceforge.argparse4j.internal
-
Exception thrown when unrecognized command is encountered.
- UnrecognizedCommandException(String, ArgumentParser, String) - Constructor for exception net.sourceforge.argparse4j.internal.UnrecognizedCommandException
- usage(String) - Method in interface net.sourceforge.argparse4j.inf.ArgumentParser
-
Sets the text to display as usage line.
- usage(String) - Method in class net.sourceforge.argparse4j.internal.ArgumentParserImpl
- usage(String) - Method in class net.sourceforge.argparse4j.internal.SubparserImpl
V
- valueOf(String) - Static method in enum net.sourceforge.argparse4j.DefaultSettings
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum net.sourceforge.argparse4j.inf.FeatureControl
-
Returns the enum constant of this type with the specified name.
- values() - Static method in enum net.sourceforge.argparse4j.DefaultSettings
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum net.sourceforge.argparse4j.inf.FeatureControl
-
Returns an array containing the constants of this enum type, in the order they are declared.
- verify(ArgumentParser, Argument, File) - Method in class net.sourceforge.argparse4j.impl.type.FileVerification
- verifyCanCreate - Variable in class net.sourceforge.argparse4j.impl.type.FileVerification
- verifyCanCreate() - Method in class net.sourceforge.argparse4j.ext.java7.PathArgumentType
-
Verifies that the specified path is writable.
- verifyCanCreate() - Method in class net.sourceforge.argparse4j.impl.type.FileArgumentType
-
Verifies that the specified path is writable.
- verifyCanExecute - Variable in class net.sourceforge.argparse4j.impl.type.FileVerification
- verifyCanExecute() - Method in class net.sourceforge.argparse4j.ext.java7.PathArgumentType
-
Verifies that the specified path is executable.
- verifyCanExecute() - Method in class net.sourceforge.argparse4j.impl.type.FileArgumentType
-
Verifies that the specified path is executable.
- verifyCanRead - Variable in class net.sourceforge.argparse4j.impl.type.FileVerification
- verifyCanRead() - Method in class net.sourceforge.argparse4j.ext.java7.PathArgumentType
-
Verifies that the specified path is readable.
- verifyCanRead() - Method in class net.sourceforge.argparse4j.impl.type.FileArgumentType
-
Verifies that the specified path is readable.
- verifyCanWrite - Variable in class net.sourceforge.argparse4j.impl.type.FileVerification
- verifyCanWrite() - Method in class net.sourceforge.argparse4j.ext.java7.PathArgumentType
-
Verifies that the specified path is writable.
- verifyCanWrite() - Method in class net.sourceforge.argparse4j.impl.type.FileArgumentType
-
Verifies that the specified path is writable.
- verifyCanWriteParent - Variable in class net.sourceforge.argparse4j.impl.type.FileVerification
- verifyCanWriteParent() - Method in class net.sourceforge.argparse4j.ext.java7.PathArgumentType
-
Verifies that the parent directory of the specified path is writable.
- verifyCanWriteParent() - Method in class net.sourceforge.argparse4j.impl.type.FileArgumentType
-
Verifies that the parent directory of the specified path is writable.
- verifyExists - Variable in class net.sourceforge.argparse4j.impl.type.FileVerification
- verifyExists() - Method in class net.sourceforge.argparse4j.ext.java7.PathArgumentType
-
Verifies that the specified path exists.
- verifyExists() - Method in class net.sourceforge.argparse4j.impl.type.FileArgumentType
-
Verifies that the specified path exists.
- verifyIsAbsolute - Variable in class net.sourceforge.argparse4j.impl.type.FileVerification
- verifyIsAbsolute() - Method in class net.sourceforge.argparse4j.ext.java7.PathArgumentType
-
Verifies that the specified path is an absolute path.
- verifyIsAbsolute() - Method in class net.sourceforge.argparse4j.impl.type.FileArgumentType
-
Verifies that the specified path is an absolute path.
- verifyIsDirectory - Variable in class net.sourceforge.argparse4j.impl.type.FileVerification
- verifyIsDirectory() - Method in class net.sourceforge.argparse4j.ext.java7.PathArgumentType
-
Verifies that the specified path is a directory.
- verifyIsDirectory() - Method in class net.sourceforge.argparse4j.impl.type.FileArgumentType
-
Verifies that the specified path is a directory.
- verifyIsFile - Variable in class net.sourceforge.argparse4j.impl.type.FileVerification
- verifyIsFile() - Method in class net.sourceforge.argparse4j.ext.java7.PathArgumentType
-
Verifies that the specified path is a regular file.
- verifyIsFile() - Method in class net.sourceforge.argparse4j.impl.type.FileArgumentType
-
Verifies that the specified path is a regular file.
- verifyNotExists - Variable in class net.sourceforge.argparse4j.impl.type.FileVerification
- verifyNotExists() - Method in class net.sourceforge.argparse4j.ext.java7.PathArgumentType
-
Verifies that the specified path does not exist.
- verifyNotExists() - Method in class net.sourceforge.argparse4j.impl.type.FileArgumentType
-
Verifies that the specified path does not exist.
- version() - Static method in class net.sourceforge.argparse4j.impl.Arguments
-
Returns version action.
- version(String) - Method in interface net.sourceforge.argparse4j.inf.ArgumentParser
-
Sets version string.
- version(String) - Method in interface net.sourceforge.argparse4j.inf.Subparser
- version(String) - Method in class net.sourceforge.argparse4j.internal.ArgumentParserImpl
- version(String) - Method in class net.sourceforge.argparse4j.internal.SubparserImpl
- VERSION_0_9_0_DEFAULT_SETTINGS - net.sourceforge.argparse4j.DefaultSettings
-
The default settings for version 0.9.0.
- VersionArgumentAction - Class in net.sourceforge.argparse4j.impl.action
-
Argument action to print version message and exit program.
- VersionArgumentAction() - Constructor for class net.sourceforge.argparse4j.impl.action.VersionArgumentAction
W
- width(String) - Method in class net.sourceforge.argparse4j.helper.ASCIITextWidthCounter
- width(String) - Method in class net.sourceforge.argparse4j.helper.CJKTextWidthCounter
- width(String) - Method in interface net.sourceforge.argparse4j.helper.TextWidthCounter
-
Counts given text consumes how many fixed character width.
- wrap(TextWidthCounter, String, int, int, String, String) - Static method in class net.sourceforge.argparse4j.helper.TextHelper
All Classes All Packages