A B C F G I M O P S U V

A

accepts(String) - Method in interface org.kohsuke.args4j.CmdLineOption
Checks if this option parser recognizes the specified option name.
accepts(String) - Method in class org.kohsuke.args4j.opts.AliasOption
 
accepts(String) - Method in class org.kohsuke.args4j.opts.BooleanOption
 
accepts(String) - Method in class org.kohsuke.args4j.opts.FileOption
 
accepts(String) - Method in class org.kohsuke.args4j.opts.IntOption
 
accepts(String) - Method in class org.kohsuke.args4j.opts.MultiStringOption
 
accepts(String) - Method in class org.kohsuke.args4j.opts.StringOption
 
addOption(CmdLineOption) - Method in class org.kohsuke.args4j.CmdLineParser
Adds a new option to the parser.
addOptionClass(Object) - Method in class org.kohsuke.args4j.CmdLineParser
Adds all the CmdLineOption-derived fields on this object.
AliasOption - Class in org.kohsuke.args4j.opts
Option which is simply an alias to a set of other options.
AliasOption(String, String[]) - Constructor for class org.kohsuke.args4j.opts.AliasOption
 

B

BooleanOption - Class in org.kohsuke.args4j.opts
Boolean option.
BooleanOption(String) - Constructor for class org.kohsuke.args4j.opts.BooleanOption
 
BooleanOption(String, boolean) - Constructor for class org.kohsuke.args4j.opts.BooleanOption
 

C

CmdLineException - Exception in org.kohsuke.args4j
Signals a failure in the command line parameters processing.
CmdLineException() - Constructor for exception org.kohsuke.args4j.CmdLineException
 
CmdLineException(String) - Constructor for exception org.kohsuke.args4j.CmdLineException
 
CmdLineOption - Interface in org.kohsuke.args4j
A command line option.
CmdLineOption.Parameters - Interface in org.kohsuke.args4j
SPI for CmdLineOption.
CmdLineParser - Class in org.kohsuke.args4j
Command line argument parser.
CmdLineParser() - Constructor for class org.kohsuke.args4j.CmdLineParser
 
createConsoleStream() - Method in class org.kohsuke.args4j.opts.OutputStreamOption
Called when the option is '-' to create the OutputStream.
createNullStream() - Method in class org.kohsuke.args4j.opts.OutputStreamOption
Called when the option is not specified to create the default OutputStream
createOutputStream() - Method in class org.kohsuke.args4j.opts.OutputStreamOption
Opens the specified file for writing.
createWriter() - Method in class org.kohsuke.args4j.opts.OutputStreamOption
Opens the specified file for writing.

F

FileOption - Class in org.kohsuke.args4j.opts
Option that takes File as a parameter.
FileOption(String) - Constructor for class org.kohsuke.args4j.opts.FileOption
 
FileOption(String, File) - Constructor for class org.kohsuke.args4j.opts.FileOption
 

G

getArguments() - Method in class org.kohsuke.args4j.CmdLineParser
Returns the list of non-option arguments.
getIntParameter(int) - Method in interface org.kohsuke.args4j.CmdLineOption.Parameters
The convenience method of Integer.parseInt(getParameter(idx)) with proper error handling.
getOptionName() - Method in interface org.kohsuke.args4j.CmdLineOption.Parameters
Gets the recognized option name.
getOptionName() - Method in exception org.kohsuke.args4j.IllegalOptionParameterException
Returns the name of the option that caused a problem.
getOptionName() - Method in exception org.kohsuke.args4j.MissingOptionParameterException
Returns the name of the option that caused a problem.
getOptionName() - Method in exception org.kohsuke.args4j.UndefinedOptionException
Returns the name of the option that caused a problem.
getParameter(int) - Method in interface org.kohsuke.args4j.CmdLineOption.Parameters
Gets the additional parameter to this option.
getValue() - Method in exception org.kohsuke.args4j.IllegalOptionParameterException
Returns the parameter of the option that caused a problem.

I

IllegalOptionParameterException - Exception in org.kohsuke.args4j
Signals an error in a parameter of an option.
IllegalOptionParameterException(String, String) - Constructor for exception org.kohsuke.args4j.IllegalOptionParameterException
 
IntOption - Class in org.kohsuke.args4j.opts
Option that takes a int as a parameter.
IntOption(String) - Constructor for class org.kohsuke.args4j.opts.IntOption
 
IntOption(String, int) - Constructor for class org.kohsuke.args4j.opts.IntOption
 
isOff() - Method in class org.kohsuke.args4j.opts.BooleanOption
Returns true if this switch is off.
isOn() - Method in class org.kohsuke.args4j.opts.BooleanOption
Returns true if this switch is on.
isSet - Variable in class org.kohsuke.args4j.opts.IntOption
True if the option was explicitly set.

M

MissingOptionParameterException - Exception in org.kohsuke.args4j
Signals an error where an option is missing parameters.
MissingOptionParameterException(String) - Constructor for exception org.kohsuke.args4j.MissingOptionParameterException
 
MultiStringOption - Class in org.kohsuke.args4j.opts
Option that accompanies a strong value and can be specified multiple times.
MultiStringOption(String) - Constructor for class org.kohsuke.args4j.opts.MultiStringOption
 
MultiStringOption(String, List) - Constructor for class org.kohsuke.args4j.opts.MultiStringOption
Creates a new MultiStringOption that store values into the specified List.

O

org.kohsuke.args4j - package org.kohsuke.args4j
Command line parser core.
org.kohsuke.args4j.opts - package org.kohsuke.args4j.opts
Various CmdLineOption implementations.
OutputStreamOption - Class in org.kohsuke.args4j.opts
Option used as an OutputStream or Writer.
OutputStreamOption(String) - Constructor for class org.kohsuke.args4j.opts.OutputStreamOption
 
OutputStreamOption(String, String) - Constructor for class org.kohsuke.args4j.opts.OutputStreamOption
 

P

parse(String[]) - Method in class org.kohsuke.args4j.CmdLineParser
Parse the arguments.
parseArguments(CmdLineParser, CmdLineOption.Parameters) - Method in interface org.kohsuke.args4j.CmdLineOption
Called if the option that this parser recognizes is found.
parseArguments(CmdLineParser, CmdLineOption.Parameters) - Method in class org.kohsuke.args4j.opts.AliasOption
 
parseArguments(CmdLineParser, CmdLineOption.Parameters) - Method in class org.kohsuke.args4j.opts.BooleanOption
 
parseArguments(CmdLineParser, CmdLineOption.Parameters) - Method in class org.kohsuke.args4j.opts.FileOption
 
parseArguments(CmdLineParser, CmdLineOption.Parameters) - Method in class org.kohsuke.args4j.opts.IntOption
 
parseArguments(CmdLineParser, CmdLineOption.Parameters) - Method in class org.kohsuke.args4j.opts.MultiStringOption
 
parseArguments(CmdLineParser, CmdLineOption.Parameters) - Method in class org.kohsuke.args4j.opts.StringOption
 

S

StringOption - Class in org.kohsuke.args4j.opts
Option that takes a String as a parameter.
StringOption(String) - Constructor for class org.kohsuke.args4j.opts.StringOption
 
StringOption(String, String) - Constructor for class org.kohsuke.args4j.opts.StringOption
 

U

UndefinedOptionException - Exception in org.kohsuke.args4j
Signals that an option is not defined.
UndefinedOptionException(String) - Constructor for exception org.kohsuke.args4j.UndefinedOptionException
 

V

value - Variable in class org.kohsuke.args4j.opts.BooleanOption
Value of this option.
value - Variable in class org.kohsuke.args4j.opts.FileOption
Value of this option.
value - Variable in class org.kohsuke.args4j.opts.IntOption
Value of this option.
value - Variable in class org.kohsuke.args4j.opts.StringOption
Value of this option.
values - Variable in class org.kohsuke.args4j.opts.MultiStringOption
Read-only view of the data store.

A B C F G I M O P S U V

Copyright © 2003-2011 Kohsuke Kawaguchi. All Rights Reserved.