Index

A B C D F G H I L M N O P S T U V
All Classes and Interfaces|All Packages|Serialized Form

A

addOpts(OptCfg[]) - Method in class com.github.sttk.cliargs.Help

Adds OptCfg(s) for a help option block to this help instance.

addOpts(List<OptCfg>) - Method in class com.github.sttk.cliargs.Help

Adds OptCfg(s) for a help option block to this help instance.

addOptsWithIndent(OptCfg[], int) - Method in class com.github.sttk.cliargs.Help

Adds OptCfg(s) and an indent width for a help option block to this help instance.

addOptsWithIndent(List<OptCfg>, int) - Method in class com.github.sttk.cliargs.Help

Adds OptCfg(s) and an indent width for a help option block to this help instance.

addOptsWithIndentAndMargins(OptCfg[], int, int, int) - Method in class com.github.sttk.cliargs.Help

Adds OptCfg(s) and an indent width and margins for a help option block to this help instance.

addOptsWithIndentAndMargins(List<OptCfg>, int, int, int) - Method in class com.github.sttk.cliargs.Help

Adds OptCfg(s) and an indent width and margins for a help option block to this help instance.

addOptsWithMargins(OptCfg[], int, int) - Method in class com.github.sttk.cliargs.Help

Adds OptCfg(s) and an indent width and margins for a help option block to this help instance.

addOptsWithMargins(List<OptCfg>, int, int) - Method in class com.github.sttk.cliargs.Help

Adds OptCfg(s) and an indent width and margins for a help option block to this help instance.

addText(String) - Method in class com.github.sttk.cliargs.Help

Adds a text for a help text block to this help instance.

addTexts(String...) - Method in class com.github.sttk.cliargs.Help

Adds texts for a help text block to this help instance.

addTexts(List<String>) - Method in class com.github.sttk.cliargs.Help

Adds texts for a help text block to this help instance.

addTextsWithIndent(String[], int) - Method in class com.github.sttk.cliargs.Help

Adds texts and an indent width for a help text block to this help instance.

addTextsWithIndent(List<String>, int) - Method in class com.github.sttk.cliargs.Help

Adds texts and an indent width for a help text block to this help instance.

addTextsWithIndentAndMargins(String[], int, int, int) - Method in class com.github.sttk.cliargs.Help

Adds texts and an indent width and margins for a help text block to this help instance.

addTextsWithIndentAndMargins(List<String>, int, int, int) - Method in class com.github.sttk.cliargs.Help

Adds texts and an indent width and margins for a help text block to this help instance.

addTextsWithMargins(String[], int, int) - Method in class com.github.sttk.cliargs.Help

Adds texts and an indent width and margins for a help text block to this help instance.

addTextsWithMargins(List<String>, int, int) - Method in class com.github.sttk.cliargs.Help

Adds texts and an indent width and margins for a help text block to this help instance.

addTextWithIndent(String, int) - Method in class com.github.sttk.cliargs.Help

Adds a text and an indent width for a help text block to this help instance.

addTextWithIndentAndMargins(String, int, int, int) - Method in class com.github.sttk.cliargs.Help

Adds a text and an indent width and margins for a help text block to this help instance.

addTextWithMargins(String, int, int) - Method in class com.github.sttk.cliargs.Help

Adds a text and margins for a help text block to this help instance.

arg() - Element in annotation interface com.github.sttk.cliargs.annotations.Opt

Gets the display of the option argument in a help text.

argInHelp - Variable in class com.github.sttk.cliargs.OptCfg

Is the field to set a display string of the option argument(s) in a help text.

argInHelp(String) - Static method in interface com.github.sttk.cliargs.OptCfg.Param

Is the static method to set the argInHelp field like a named parameter.

args() - Method in class com.github.sttk.cliargs.Cmd

Returns the command arguments.

B

BadFieldType - Exception Class in com.github.sttk.cliargs.exceptions

Is the exception which indicates that a type of a field of an option store is neither a boolean, a number, a string, nor an array of numbers or strings.

BadFieldType(String, Class<?>) - Constructor for exception class com.github.sttk.cliargs.exceptions.BadFieldType

Constructs an instance of this class.

BigDecimalValidator - Class in com.github.sttk.cliargs.validators

Is the validator class which provides the method to validate an option argument string as a BigDecimal.

BigDecimalValidator() - Constructor for class com.github.sttk.cliargs.validators.BigDecimalValidator

The default constructor.

BigIntegerValidator - Class in com.github.sttk.cliargs.validators

Is the validator class which provides the method to validate an option argument string as a BigInteger.

BigIntegerValidator() - Constructor for class com.github.sttk.cliargs.validators.BigIntegerValidator

The default constructor.

C

cfg() - Element in annotation interface com.github.sttk.cliargs.annotations.Opt

Gets the option name, aliases and default values.

Cmd - Class in com.github.sttk.cliargs

Parses command line arguments and stores them.

Cmd(String, String...) - Constructor for class com.github.sttk.cliargs.Cmd

Constructs an instance of this class with command line arguments.

com.github.sttk.cliargs - module com.github.sttk.cliargs

Defines the APIs for operating command line arguments.

com.github.sttk.cliargs - package com.github.sttk.cliargs

Provides the classes to parse and print comand line arguments.

com.github.sttk.cliargs.annotations - package com.github.sttk.cliargs.annotations

Provides the annotation classes to generate the option configurations to fields of an option store.

com.github.sttk.cliargs.exceptions - package com.github.sttk.cliargs.exceptions

Provides the exception classes for parsing comand line arguments.

com.github.sttk.cliargs.validators - package com.github.sttk.cliargs.validators

Provides the classes to validate an option argument string in command line arguments.

ConfigHasDefaultsButHasNoArg - Exception Class in com.github.sttk.cliargs.exceptions

Is the exception which indicates that an option configuration contradicts that the default arguments is not empty though it does not take option arguments.

ConfigHasDefaultsButHasNoArg(String, String) - Constructor for exception class com.github.sttk.cliargs.exceptions.ConfigHasDefaultsButHasNoArg

Constructs an instance of this class.

ConfigIsArrayButHasNoArg - Exception Class in com.github.sttk.cliargs.exceptions

Is the exception which indicates that an option configuration contradicts that the option can take multiple arguments though it does not take option arguments.

ConfigIsArrayButHasNoArg(String, String) - Constructor for exception class com.github.sttk.cliargs.exceptions.ConfigIsArrayButHasNoArg

Constructs an instance of this class.

D

defaults - Variable in class com.github.sttk.cliargs.OptCfg

Is the Optional object of a string list to specify default value(s) for when the command option is not given in command line arguments.

defaults(String...) - Static method in interface com.github.sttk.cliargs.OptCfg.Param

Is the static method to set the defaults field like a named parameter.

defaults(List<String>) - Static method in interface com.github.sttk.cliargs.OptCfg.Param

Is the static method to set the defaults field like a named parameter.

desc - Variable in class com.github.sttk.cliargs.OptCfg

Is the string field to set the description of the option which is used in a help text.

desc() - Element in annotation interface com.github.sttk.cliargs.annotations.Opt

Gets the description of the option.

desc(String) - Static method in interface com.github.sttk.cliargs.OptCfg.Param

Is the static method to set the desc field like a named parameter.

details - Variable in exception class com.github.sttk.cliargs.exceptions.OptionArgIsInvalid

The details for the invalidation.

DoubleValidator - Class in com.github.sttk.cliargs.validators

Is the validator class which provides the method to validate an option argument string as a Double.

DoubleValidator() - Constructor for class com.github.sttk.cliargs.validators.DoubleValidator

The default constructor.

F

FailToSetOptionStoreField - Exception Class in com.github.sttk.cliargs.exceptions

Is the exception which indicates that it is failed to set option arguments (including those from default values) to a field of an option store.

FailToSetOptionStoreField(String, Class<?>, List<String>, Exception) - Constructor for exception class com.github.sttk.cliargs.exceptions.FailToSetOptionStoreField

Constructs an instance of this class.

field - Variable in exception class com.github.sttk.cliargs.exceptions.BadFieldType

The field name in the option store.

field - Variable in exception class com.github.sttk.cliargs.exceptions.FailToSetOptionStoreField

The field name in the option store.

FloatValidator - Class in com.github.sttk.cliargs.validators

Is the validator class which provides the method to validate an option argument string as a Double.

FloatValidator() - Constructor for class com.github.sttk.cliargs.validators.FloatValidator

The default constructor.

G

getMessage() - Method in exception class com.github.sttk.cliargs.exceptions.BadFieldType

Returns a string which represents the content of this exception.

getMessage() - Method in exception class com.github.sttk.cliargs.exceptions.ConfigHasDefaultsButHasNoArg

Returns a string which represents the content of this exception.

getMessage() - Method in exception class com.github.sttk.cliargs.exceptions.ConfigIsArrayButHasNoArg

Returns a string which represents the content of this exception.

getMessage() - Method in exception class com.github.sttk.cliargs.exceptions.FailToSetOptionStoreField

Returns a string which represents the content of this exception.

getMessage() - Method in exception class com.github.sttk.cliargs.exceptions.OptionArgIsInvalid

Returns a string which represents the content of this exception.

getMessage() - Method in exception class com.github.sttk.cliargs.exceptions.OptionContainsInvalidChar

Returns a string which represents the content of this exception.

getMessage() - Method in exception class com.github.sttk.cliargs.exceptions.OptionIsNotArray

Returns a string which represents the content of this exception.

getMessage() - Method in exception class com.github.sttk.cliargs.exceptions.OptionNameIsDuplicated

Returns a string which represents the content of this exception.

getMessage() - Method in exception class com.github.sttk.cliargs.exceptions.OptionNeedsArg

Returns a string which represents the content of this exception.

getMessage() - Method in exception class com.github.sttk.cliargs.exceptions.OptionTakesNoArg

Returns a string which represents the content of this exception.

getMessage() - Method in exception class com.github.sttk.cliargs.exceptions.StoreKeyIsDuplicated

Returns a string which represents the content of this exception.

getMessage() - Method in exception class com.github.sttk.cliargs.exceptions.UnconfiguredOption

Returns a string which represents the content of this exception.

H

hasArg - Variable in class com.github.sttk.cliargs.OptCfg

Is the flag which allow the option to take option arguments.

hasArg(boolean) - Static method in interface com.github.sttk.cliargs.OptCfg.Param

Is the static method to set the hasArg field like a named parameter.

hasOpt(String) - Method in class com.github.sttk.cliargs.Cmd

Checks whether an option with the specified name exists.

Help - Class in com.github.sttk.cliargs

Is the class to print a help text with an OptCfg array.

Help() - Constructor for class com.github.sttk.cliargs.Help

Constructs an instance of this class with 0 margins.

Help(int, int) - Constructor for class com.github.sttk.cliargs.Help

Constructs an instance of this class with left and right margins.

I

IntegerValidator - Class in com.github.sttk.cliargs.validators

Is the validator class which provides the method to validate an option argument string as a Integer.

IntegerValidator() - Constructor for class com.github.sttk.cliargs.validators.IntegerValidator

The default constructor.

InvalidOption - Exception Class in com.github.sttk.cliargs.exceptions

Is the abstract class of the exception that provides a method to retrieve an option name.

InvalidOption() - Constructor for exception class com.github.sttk.cliargs.exceptions.InvalidOption

Constructs an instance of this class.

InvalidOption(Throwable) - Constructor for exception class com.github.sttk.cliargs.exceptions.InvalidOption

Constructs an instance of this class.

isArray - Variable in class com.github.sttk.cliargs.OptCfg

Is the flag which allow the option to take multiple option arguments.

isArray(boolean) - Static method in interface com.github.sttk.cliargs.OptCfg.Param

Is the static method to set the isArray field like a named parameter.

iter() - Method in class com.github.sttk.cliargs.Help

Creates a HelpIter instance which is an iterator that outputs a help text line by line.

L

LongValidator - Class in com.github.sttk.cliargs.validators

Is the validator class which provides the method to validate an option argument string as a Long.

LongValidator() - Constructor for class com.github.sttk.cliargs.validators.LongValidator

The default constructor.

M

makeOptCfgsFor(Object) - Static method in class com.github.sttk.cliargs.OptCfg

Makes an OptCfg array from the fields opt the option store with the annotation Opt.

N

name - Variable in exception class com.github.sttk.cliargs.exceptions.ConfigHasDefaultsButHasNoArg

The first name of the option configuration.

name - Variable in exception class com.github.sttk.cliargs.exceptions.ConfigIsArrayButHasNoArg

The first name of the option configuration.

name - Variable in exception class com.github.sttk.cliargs.exceptions.OptionNameIsDuplicated

The duplicated name of the option configuration.

name - Variable in exception class com.github.sttk.cliargs.exceptions.StoreKeyIsDuplicated

The first name of the option configuration.

name() - Method in class com.github.sttk.cliargs.Cmd

Returns the command name.

names - Variable in class com.github.sttk.cliargs.OptCfg

Is the vector for specifying the option name and the aliases.

names(String...) - Static method in interface com.github.sttk.cliargs.OptCfg.Param

Is the static method to set the names field like a named parameter.

names(List<String>) - Static method in interface com.github.sttk.cliargs.OptCfg.Param

Is the static method to set the names field like a named parameter.

O

Opt - Annotation Interface in com.github.sttk.cliargs.annotations

Is the annotation that is attached to fields of an option store class.

optArg - Variable in exception class com.github.sttk.cliargs.exceptions.OptionArgIsInvalid

The option argument that was validated.

optArg(String) - Method in class com.github.sttk.cliargs.Cmd

Returns the option argument with the specified name.

optArgs - Variable in exception class com.github.sttk.cliargs.exceptions.FailToSetOptionStoreField

The option arguments that occurs this exception.

optArgs(String) - Method in class com.github.sttk.cliargs.Cmd

Returns the option arguments with the specified name.

OptCfg - Class in com.github.sttk.cliargs

Represents an option configuration for how to parse command line arguments.

OptCfg(OptCfg.Param...) - Constructor for class com.github.sttk.cliargs.OptCfg

Is the constructor that takes the variadic parameters of OptCfg.Param which can be specified like named parameters.

OptCfg(String, List<String>, boolean, boolean, List<String>, String, String, Validator) - Constructor for class com.github.sttk.cliargs.OptCfg

Is the constructor that takes the all field values as parameters.

OptCfg.Param - Interface in com.github.sttk.cliargs

Is the functional interface for the constructor parameters like named parameters.

optCfgs() - Method in class com.github.sttk.cliargs.Cmd

Returns the option configurations which was used to parse command line arguments.

option - Variable in exception class com.github.sttk.cliargs.exceptions.OptionArgIsInvalid

The option name that caused this exception.

option - Variable in exception class com.github.sttk.cliargs.exceptions.OptionContainsInvalidChar

The option name that caused this exception.

option - Variable in exception class com.github.sttk.cliargs.exceptions.OptionIsNotArray

The option name that caused this exception.

option - Variable in exception class com.github.sttk.cliargs.exceptions.OptionNeedsArg

The option name that caused this exception.

option - Variable in exception class com.github.sttk.cliargs.exceptions.OptionTakesNoArg

The option name that caused this exception.

option - Variable in exception class com.github.sttk.cliargs.exceptions.UnconfiguredOption

The option name that caused this exception.

option() - Method in exception class com.github.sttk.cliargs.exceptions.ConfigHasDefaultsButHasNoArg

Gets the option name that caused this exception.

option() - Method in exception class com.github.sttk.cliargs.exceptions.ConfigIsArrayButHasNoArg

Gets the option name that caused this exception.

option() - Method in exception class com.github.sttk.cliargs.exceptions.InvalidOption

Gets the option name that caused this exception.

option() - Method in exception class com.github.sttk.cliargs.exceptions.OptionArgIsInvalid

Gets the option name that caused this exception.

option() - Method in exception class com.github.sttk.cliargs.exceptions.OptionContainsInvalidChar

Gets the option name that caused this exception.

option() - Method in exception class com.github.sttk.cliargs.exceptions.OptionIsNotArray

Gets the option name that caused this exception.

option() - Method in exception class com.github.sttk.cliargs.exceptions.OptionNameIsDuplicated

Gets the option name that caused this exception.

option() - Method in exception class com.github.sttk.cliargs.exceptions.OptionNeedsArg

Gets the option name that caused this exception.

option() - Method in exception class com.github.sttk.cliargs.exceptions.OptionTakesNoArg

Gets the option name that caused this exception.

option() - Method in exception class com.github.sttk.cliargs.exceptions.StoreKeyIsDuplicated

Gets the option name that caused this exception.

option() - Method in exception class com.github.sttk.cliargs.exceptions.UnconfiguredOption

Gets the option name that caused this exception.

OptionArgIsInvalid - Exception Class in com.github.sttk.cliargs.exceptions

Is the exception which indicates that the option argument is invalidated by the validator in the option configuration.

OptionArgIsInvalid(String, String, String, String, Throwable) - Constructor for exception class com.github.sttk.cliargs.exceptions.OptionArgIsInvalid

Constructs an instance of this class.

OptionContainsInvalidChar - Exception Class in com.github.sttk.cliargs.exceptions

Is the exception which indicates that an invalid character is found in an option.

OptionContainsInvalidChar(String) - Constructor for exception class com.github.sttk.cliargs.exceptions.OptionContainsInvalidChar

Constructs an instance of this class.

OptionIsNotArray - Exception Class in com.github.sttk.cliargs.exceptions

Is the exception which indicates that the option is supposed to take one argument in the configuration, but multiple arguments are specified.

OptionIsNotArray(String, String) - Constructor for exception class com.github.sttk.cliargs.exceptions.OptionIsNotArray

Constructs an instance of this class.

OptionNameIsDuplicated - Exception Class in com.github.sttk.cliargs.exceptions

Is the exception which indicates that there are duplicated opton names among the option configurations.

OptionNameIsDuplicated(String, String) - Constructor for exception class com.github.sttk.cliargs.exceptions.OptionNameIsDuplicated

Constructs an instance of this class.

OptionNeedsArg - Exception Class in com.github.sttk.cliargs.exceptions

Is the exception which indicates that the option requires arguments in the configuration, but no argument is specified.

OptionNeedsArg(String, String) - Constructor for exception class com.github.sttk.cliargs.exceptions.OptionNeedsArg

Constructs an instance of this class.

OptionTakesNoArg - Exception Class in com.github.sttk.cliargs.exceptions

Is the exception which indicates that the option is not supposed to take an argument in configuration, but an argument is specified.

OptionTakesNoArg(String, String) - Constructor for exception class com.github.sttk.cliargs.exceptions.OptionTakesNoArg

Constructs an instance of this class.

P

parse() - Method in class com.github.sttk.cliargs.Cmd

Parses command line arguments without configurations.

parseFor(Object) - Method in class com.github.sttk.cliargs.Cmd

Parses command line arguments and set their option values to the fields of the option store which is passed as the argument of this method.

parseUntilSubCmd() - Method in class com.github.sttk.cliargs.Cmd

Parses command line arguments without configurations but stops parsing when encountering first command argument.

parseUntilSubCmdFor(Object) - Method in class com.github.sttk.cliargs.Cmd

Parses command line arguments until the first command argument and set their option values to the option store which is passed as an argument.

parseUntilSubCmdWith(OptCfg[]) - Method in class com.github.sttk.cliargs.Cmd

Parses command line arguments with option configurations but stops parsing when encountering first command argument.

parseWith(OptCfg[]) - Method in class com.github.sttk.cliargs.Cmd

Parses command line arguments with option configurations.

print() - Method in class com.github.sttk.cliargs.Help

Outputs a help text to the standard output.

S

setTo(Object) - Method in interface com.github.sttk.cliargs.OptCfg.Param

Sets a field value of OptCfg.Init object that has same fields with OptCfg object and is used to initialized it.

ShortValidator - Class in com.github.sttk.cliargs.validators

Is the validator class which provides the method to validate an option argument string as a Short.

ShortValidator() - Constructor for class com.github.sttk.cliargs.validators.ShortValidator

The default constructor.

storeKey - Variable in exception class com.github.sttk.cliargs.exceptions.ConfigHasDefaultsButHasNoArg

The store key of the option configuration that caused this exception.

storeKey - Variable in exception class com.github.sttk.cliargs.exceptions.ConfigIsArrayButHasNoArg

The store key of the option configuration that caused this exception.

storeKey - Variable in exception class com.github.sttk.cliargs.exceptions.OptionArgIsInvalid

The store key of the option configuration that caused this exception.

storeKey - Variable in exception class com.github.sttk.cliargs.exceptions.OptionIsNotArray

The store key of the specified option in the configuration.

storeKey - Variable in exception class com.github.sttk.cliargs.exceptions.OptionNameIsDuplicated

The store key of the option configuration that caused this exception.

storeKey - Variable in exception class com.github.sttk.cliargs.exceptions.OptionNeedsArg

The store key.

storeKey - Variable in exception class com.github.sttk.cliargs.exceptions.OptionTakesNoArg

The store key of the specified option in the cnfiguration.

storeKey - Variable in exception class com.github.sttk.cliargs.exceptions.StoreKeyIsDuplicated

The store key that caused this exceptiion.

storeKey - Variable in class com.github.sttk.cliargs.OptCfg

Is the key to store option value(s) in the option map in a `Cmd` instance.

storeKey(String) - Static method in interface com.github.sttk.cliargs.OptCfg.Param

Is the static method to set the storeKey field like a named parameter.

StoreKeyIsDuplicated - Exception Class in com.github.sttk.cliargs.exceptions

Is the exception which indicates that there are duplicated store keys among multiple configurations.

StoreKeyIsDuplicated(String, String) - Constructor for exception class com.github.sttk.cliargs.exceptions.StoreKeyIsDuplicated

Constructs an instance of this class.

T

toString() - Method in class com.github.sttk.cliargs.Cmd

Returns a String object representing the content of this object.

toString() - Method in class com.github.sttk.cliargs.OptCfg

Returns the content string of this instance.

type - Variable in exception class com.github.sttk.cliargs.exceptions.BadFieldType

The type of the field in the option store.

type - Variable in exception class com.github.sttk.cliargs.exceptions.FailToSetOptionStoreField

The class of the field in the option store.

U

UnconfiguredOption - Exception Class in com.github.sttk.cliargs.exceptions

Is the exception which indicates that there is no configuration about the input option.

UnconfiguredOption(String) - Constructor for exception class com.github.sttk.cliargs.exceptions.UnconfiguredOption

Constructs an instance of this class.

V

validate(String, String, String) - Method in class com.github.sttk.cliargs.validators.BigDecimalValidator

Validates an option argument string whether it is valid format of the specified type, etc.

validate(String, String, String) - Method in class com.github.sttk.cliargs.validators.BigIntegerValidator

Validates an option argument string whether it is valid format of the specified type, etc.

validate(String, String, String) - Method in class com.github.sttk.cliargs.validators.DoubleValidator

Validates an option argument string whether it is valid format of the specified type, etc.

validate(String, String, String) - Method in class com.github.sttk.cliargs.validators.FloatValidator

Validates an option argument string whether it is valid format of the specified type, etc.

validate(String, String, String) - Method in class com.github.sttk.cliargs.validators.IntegerValidator

Validates an option argument string whether it is valid format of the specified type, etc.

validate(String, String, String) - Method in class com.github.sttk.cliargs.validators.LongValidator

Validates an option argument string whether it is valid format of the specified type, etc.

validate(String, String, String) - Method in class com.github.sttk.cliargs.validators.ShortValidator

Validates an option argument string whether it is valid format of the specified type, etc.

validate(String, String, String) - Method in interface com.github.sttk.cliargs.validators.Validator

Validates an option argument string whether it is valid format of the specified type, etc.

validator - Variable in class com.github.sttk.cliargs.OptCfg

Is the functional interface to validate the option argument(s).

validator(Validator) - Static method in interface com.github.sttk.cliargs.OptCfg.Param

Is the static method to set the validator field like a named parameter.

Validator - Interface in com.github.sttk.cliargs.validators

Is the interface which provides the method declaration to validate an option argument.

A B C D F G H I L M N O P S T U V
All Classes and Interfaces|All Packages|Serialized Form