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

A

addArgument(Setter, Argument) - Method in class org.kohsuke.args4j.CmdLineParser
Programmatically defines an argument (instead of reading it from annotations like you normally do.)
addOption(Setter, Option) - Method in class org.kohsuke.args4j.CmdLineParser
Programmatically defines an option (instead of reading it from annotations like you normally do.)
addValue(Object) - Method in class org.kohsuke.args4j.MapSetter
 
addValue(Object) - Method in class org.kohsuke.args4j.spi.MethodSetter
 
addValue(T) - Method in interface org.kohsuke.args4j.spi.Setter
Adds/sets a value to the property of the option bean.
aliases - Variable in class org.kohsuke.args4j.Config.ConfigElement
 
aliases() - Method in class org.kohsuke.args4j.NamedOptionDef
 
AnnotationProcessorFactoryImpl - Class in org.kohsuke.args4j.apt
AnnotationProcessorFactory to be invoked by APT.
AnnotationProcessorFactoryImpl() - Constructor for class org.kohsuke.args4j.apt.AnnotationProcessorFactoryImpl
 
Argument - Annotation Type in org.kohsuke.args4j
Argument of the command line.
arguments - Variable in class org.kohsuke.args4j.Config
All @Arguments.

B

BooleanOptionHandler - Class in org.kohsuke.args4j.spi
Boolean OptionHandler.
BooleanOptionHandler(CmdLineParser, OptionDef, Setter<? super Boolean>) - Constructor for class org.kohsuke.args4j.spi.BooleanOptionHandler
 
ByteOptionHandler - Class in org.kohsuke.args4j.spi
Byte OptionHandler OneArgumentOptionHandler
ByteOptionHandler(CmdLineParser, OptionDef, Setter<? super Byte>) - Constructor for class org.kohsuke.args4j.spi.ByteOptionHandler
 

C

CharOptionHandler - Class in org.kohsuke.args4j.spi
Char OptionHandler OneArgumentOptionHandler
CharOptionHandler(CmdLineParser, OptionDef, Setter<? super Character>) - Constructor for class org.kohsuke.args4j.spi.CharOptionHandler
 
ClassParser - Class in org.kohsuke.args4j
Parser for analyzing Args4J annotations in the class hierarchy.
ClassParser() - Constructor for class org.kohsuke.args4j.ClassParser
 
CmdLineException - Exception in org.kohsuke.args4j
Signals an error in the user input.
CmdLineException(String) - Constructor for exception org.kohsuke.args4j.CmdLineException
Deprecated. Use CmdLineException.CmdLineException(CmdLineParser, String)
CmdLineException(String, Throwable) - Constructor for exception org.kohsuke.args4j.CmdLineException
Deprecated. Use CmdLineException.CmdLineException(CmdLineParser, String, Throwable)
CmdLineException(Throwable) - Constructor for exception org.kohsuke.args4j.CmdLineException
Deprecated. Use CmdLineException.CmdLineException(CmdLineParser, Throwable)
CmdLineException(CmdLineParser, String) - Constructor for exception org.kohsuke.args4j.CmdLineException
 
CmdLineException(CmdLineParser, String, Throwable) - Constructor for exception org.kohsuke.args4j.CmdLineException
 
CmdLineException(CmdLineParser, Throwable) - Constructor for exception org.kohsuke.args4j.CmdLineException
 
CmdLineParser - Class in org.kohsuke.args4j
Command line argument owner.
CmdLineParser(Object) - Constructor for class org.kohsuke.args4j.CmdLineParser
Creates a new command line owner that parses arguments/options and set them into the given object.
Config - Class in org.kohsuke.args4j
Metadataconfiguration.
Config() - Constructor for class org.kohsuke.args4j.Config
 
Config.ConfigElement - Class in org.kohsuke.args4j
The ConfigElement is an <option> or <argument> tag in the xml configuration file.
Config.ConfigElement() - Constructor for class org.kohsuke.args4j.Config.ConfigElement
 
Config.ConfigHandler - Class in org.kohsuke.args4j
SAX-Handler for reading the configuration file.
Config.ConfigHandler(Config) - Constructor for class org.kohsuke.args4j.Config.ConfigHandler
 
create(CmdLineParser, AccessibleObject, Object) - Static method in class org.kohsuke.args4j.spi.Setters
 
create(Field, Object) - Static method in class org.kohsuke.args4j.spi.Setters
 
createOptionHandler(OptionDef, Setter) - Method in class org.kohsuke.args4j.CmdLineParser
Creates an OptionHandler that handles the given Option annotation and the Setter instance.

D

DoubleOptionHandler - Class in org.kohsuke.args4j.spi
Double OptionHandler.
DoubleOptionHandler(CmdLineParser, OptionDef, Setter<? super Double>) - Constructor for class org.kohsuke.args4j.spi.DoubleOptionHandler
 

E

EnumOptionHandler<T extends java.lang.Enum<T>> - Class in org.kohsuke.args4j.spi
Enum OptionHandler.
EnumOptionHandler(CmdLineParser, OptionDef, Setter<? super T>, Class<T>) - Constructor for class org.kohsuke.args4j.spi.EnumOptionHandler
 
ExampleMode - Enum in org.kohsuke.args4j
Used with CmdLineParser.printExample(ExampleMode).

F

field - Variable in class org.kohsuke.args4j.Config.ConfigElement
 
FileOptionHandler - Class in org.kohsuke.args4j.spi
File OptionHandler.
FileOptionHandler(CmdLineParser, OptionDef, Setter<? super File>) - Constructor for class org.kohsuke.args4j.spi.FileOptionHandler
 
findClass(String) - Method in class org.kohsuke.args4j.apt.IsolatingClassLoader
 
findClass(String) - Method in class org.kohsuke.args4j.apt.ReloadingClassLoader
 
FloatOptionHandler - Class in org.kohsuke.args4j.spi
Float OptionHandler OneArgumentOptionHandler
FloatOptionHandler(CmdLineParser, OptionDef, Setter<? super Float>) - Constructor for class org.kohsuke.args4j.spi.FloatOptionHandler
 

G

getArguments() - Method in class org.kohsuke.args4j.CmdLineParser
 
getDefaultMetaVariable() - Method in class org.kohsuke.args4j.spi.BooleanOptionHandler
 
getDefaultMetaVariable() - Method in class org.kohsuke.args4j.spi.EnumOptionHandler
 
getDefaultMetaVariable() - Method in class org.kohsuke.args4j.spi.FileOptionHandler
 
getDefaultMetaVariable() - Method in class org.kohsuke.args4j.spi.MapOptionHandler
 
getDefaultMetaVariable() - Method in class org.kohsuke.args4j.spi.OneArgumentOptionHandler
 
getDefaultMetaVariable() - Method in class org.kohsuke.args4j.spi.OptionHandler
Gets the default meta variable name used to print the usage screen.
getDefaultMetaVariable() - Method in class org.kohsuke.args4j.spi.RestOfArgumentsHandler
 
getDefaultMetaVariable() - Method in class org.kohsuke.args4j.spi.StopOptionHandler
 
getDefaultMetaVariable() - Method in class org.kohsuke.args4j.spi.StringArrayOptionHandler
Returns "STRING[]".
getDefaultMetaVariable() - Method in class org.kohsuke.args4j.spi.StringOptionHandler
 
getDefaultMetaVariable() - Method in class org.kohsuke.args4j.spi.URIOptionHandler
 
getDefaultMetaVariable() - Method in class org.kohsuke.args4j.spi.URLOptionHandler
 
getMetaVariable(ResourceBundle) - Method in class org.kohsuke.args4j.spi.OptionHandler
 
getNameAndMeta(ResourceBundle) - Method in class org.kohsuke.args4j.spi.OptionHandler
 
getParameter(int) - Method in interface org.kohsuke.args4j.spi.Parameters
Gets the additional parameter to this option.
getParser() - Method in exception org.kohsuke.args4j.CmdLineException
Obtains the CmdLineParser that triggered an exception.
getProcessorFor(Set<AnnotationTypeDeclaration>, AnnotationProcessorEnvironment) - Method in class org.kohsuke.args4j.apt.AnnotationProcessorFactoryImpl
 
getType() - Method in class org.kohsuke.args4j.MapSetter
 
getType() - Method in class org.kohsuke.args4j.spi.MethodSetter
 
getType() - Method in interface org.kohsuke.args4j.spi.Setter
Gets the type of the underlying method/field.

H

handler - Variable in class org.kohsuke.args4j.Config.ConfigElement
 
handler() - Method in class org.kohsuke.args4j.OptionDef
 
hasAnnotation(Class, Class<? extends Annotation>) - Static method in class org.kohsuke.args4j.Starter
 

I

IllegalAnnotationError - Error in org.kohsuke.args4j
Signals an incorrect use of args4j annotations.
IllegalAnnotationError(String) - Constructor for error org.kohsuke.args4j.IllegalAnnotationError
 
IllegalAnnotationError(String, Throwable) - Constructor for error org.kohsuke.args4j.IllegalAnnotationError
 
IllegalAnnotationError(Throwable) - Constructor for error org.kohsuke.args4j.IllegalAnnotationError
 
IntOptionHandler - Class in org.kohsuke.args4j.spi
Integer OptionHandler.
IntOptionHandler(CmdLineParser, OptionDef, Setter<? super Integer>) - Constructor for class org.kohsuke.args4j.spi.IntOptionHandler
 
isArgument() - Method in class org.kohsuke.args4j.NamedOptionDef
 
isArgument() - Method in class org.kohsuke.args4j.OptionDef
 
isInvalid() - Method in class org.kohsuke.args4j.Config.ConfigElement
Ensures that only a field XOR a method is set.
isMultiValued() - Method in class org.kohsuke.args4j.MapSetter
 
isMultiValued() - Method in class org.kohsuke.args4j.OptionDef
 
isMultiValued() - Method in class org.kohsuke.args4j.spi.MethodSetter
 
isMultiValued() - Method in interface org.kohsuke.args4j.spi.Setter
Whether this setter is instrinsically multi-valued.
IsolatingClassLoader - Class in org.kohsuke.args4j.apt
 
IsolatingClassLoader(ClassLoader) - Constructor for class org.kohsuke.args4j.apt.IsolatingClassLoader
 
isOption(String) - Method in class org.kohsuke.args4j.CmdLineParser
Returns true if the given token is an option (as opposed to an argument.)

L

loadClass(String) - Method in class org.kohsuke.args4j.apt.IsolatingClassLoader
 
loadClass(String, boolean) - Method in class org.kohsuke.args4j.apt.IsolatingClassLoader
 
loadToolsJar() - Method in class org.kohsuke.args4j.apt.Main
 
LongOptionHandler - Class in org.kohsuke.args4j.spi
Long OptionHandler OneArgumentOptionHandler
LongOptionHandler(CmdLineParser, OptionDef, Setter<? super Long>) - Constructor for class org.kohsuke.args4j.spi.LongOptionHandler
 

M

Main - Class in org.kohsuke.args4j.apt
Entry point that invokes APT.
Main() - Constructor for class org.kohsuke.args4j.apt.Main
 
main(String[]) - Static method in class org.kohsuke.args4j.apt.Main
 
main(String[]) - Static method in class org.kohsuke.args4j.Starter
 
MapOptionHandler - Class in org.kohsuke.args4j.spi
 
MapOptionHandler(CmdLineParser, OptionDef, Setter<? super Map<?, ?>>) - Constructor for class org.kohsuke.args4j.spi.MapOptionHandler
 
MapSetter - Class in org.kohsuke.args4j
 
MapSetter(Object, Field) - Constructor for class org.kohsuke.args4j.MapSetter
 
metavar - Variable in class org.kohsuke.args4j.Config.ConfigElement
 
metaVar() - Method in class org.kohsuke.args4j.OptionDef
 
method - Variable in class org.kohsuke.args4j.Config.ConfigElement
 
MethodSetter - Class in org.kohsuke.args4j.spi
Setter that sets to a Method.
MethodSetter(CmdLineParser, Object, Method) - Constructor for class org.kohsuke.args4j.spi.MethodSetter
 
Mode - Enum in org.kohsuke.args4j.apt
 
multiValued - Variable in class org.kohsuke.args4j.Config.ConfigElement
 

N

name - Variable in class org.kohsuke.args4j.Config.ConfigElement
 
name() - Method in class org.kohsuke.args4j.NamedOptionDef
 
NamedOptionDef - Class in org.kohsuke.args4j
Run-time copy of the Option or Argument annotation.
NamedOptionDef(Option, boolean) - Constructor for class org.kohsuke.args4j.NamedOptionDef
 

O

OneArgumentOptionHandler<T> - Class in org.kohsuke.args4j.spi
OptionHandler which handles an option with exactly one argument, like "-foo bar".
OneArgumentOptionHandler(CmdLineParser, OptionDef, Setter<? super T>) - Constructor for class org.kohsuke.args4j.spi.OneArgumentOptionHandler
 
Option - Annotation Type in org.kohsuke.args4j
Marks a field/setter that receives a command line switch value.
option - Variable in class org.kohsuke.args4j.spi.OptionHandler
The annotation.
OptionDef - Class in org.kohsuke.args4j
Run-time copy of the Option or Argument annotation.
OptionDef(Argument, boolean) - Constructor for class org.kohsuke.args4j.OptionDef
 
OptionDef(String, String, boolean, Class<? extends OptionHandler>, boolean) - Constructor for class org.kohsuke.args4j.OptionDef
 
OptionHandler<T> - Class in org.kohsuke.args4j.spi
Code that parses operands of an option into Java.
OptionHandler(CmdLineParser, OptionDef, Setter<? super T>) - Constructor for class org.kohsuke.args4j.spi.OptionHandler
 
options - Variable in class org.kohsuke.args4j.Config
All @Options.
org.kohsuke.args4j - package org.kohsuke.args4j
Command line parser core.
org.kohsuke.args4j.apt - package org.kohsuke.args4j.apt
 
org.kohsuke.args4j.spi - package org.kohsuke.args4j.spi
Classes for extending the behavior of args4j.
owner - Variable in class org.kohsuke.args4j.spi.OptionHandler
The owner to which this handler belongs to.

P

PARAMETER_NAME - Static variable in class org.kohsuke.args4j.Starter
The name of the JavaVM property which stores the class name of the business class.
Parameters - Interface in org.kohsuke.args4j.spi
List of arguments.
parse(Object, CmdLineParser) - Method in class org.kohsuke.args4j.ClassParser
 
parse(InputSource) - Static method in class org.kohsuke.args4j.Config
Parses a XML file and returns a Config object holding the information.
parse(String) - Method in class org.kohsuke.args4j.spi.ByteOptionHandler
 
parse(String) - Method in class org.kohsuke.args4j.spi.CharOptionHandler
 
parse(String) - Method in class org.kohsuke.args4j.spi.DoubleOptionHandler
 
parse(String) - Method in class org.kohsuke.args4j.spi.FloatOptionHandler
 
parse(String) - Method in class org.kohsuke.args4j.spi.IntOptionHandler
 
parse(String) - Method in class org.kohsuke.args4j.spi.LongOptionHandler
 
parse(String) - Method in class org.kohsuke.args4j.spi.OneArgumentOptionHandler
Parses a string to a real value of Type <T>.
parse(String) - Method in class org.kohsuke.args4j.spi.ShortOptionHandler
 
parse(URL, CmdLineParser, Object) - Method in class org.kohsuke.args4j.XmlParser
 
parse(InputSource, CmdLineParser, Object) - Method in class org.kohsuke.args4j.XmlParser
 
parseArgument(Collection<String>) - Method in class org.kohsuke.args4j.CmdLineParser
Same as CmdLineParser.parseArgument(String[])
parseArgument(String...) - Method in class org.kohsuke.args4j.CmdLineParser
Parses the command line arguments and set them to the option bean given in the constructor.
parseArguments(Parameters) - Method in class org.kohsuke.args4j.spi.BooleanOptionHandler
 
parseArguments(Parameters) - Method in class org.kohsuke.args4j.spi.EnumOptionHandler
 
parseArguments(Parameters) - Method in class org.kohsuke.args4j.spi.FileOptionHandler
 
parseArguments(Parameters) - Method in class org.kohsuke.args4j.spi.MapOptionHandler
 
parseArguments(Parameters) - Method in class org.kohsuke.args4j.spi.OneArgumentOptionHandler
 
parseArguments(Parameters) - Method in class org.kohsuke.args4j.spi.OptionHandler
Called if the option that this owner recognizes is found.
parseArguments(Parameters) - Method in class org.kohsuke.args4j.spi.RestOfArgumentsHandler
 
parseArguments(Parameters) - Method in class org.kohsuke.args4j.spi.StopOptionHandler
 
parseArguments(Parameters) - Method in class org.kohsuke.args4j.spi.StringArrayOptionHandler
Tryies to parse String[] argument from Parameters.
parseArguments(Parameters) - Method in class org.kohsuke.args4j.spi.StringOptionHandler
 
parseArguments(Parameters) - Method in class org.kohsuke.args4j.spi.URIOptionHandler
 
parseArguments(Parameters) - Method in class org.kohsuke.args4j.spi.URLOptionHandler
 
printExample(ExampleMode) - Method in class org.kohsuke.args4j.CmdLineParser
Formats a command line example into a string.
printExample(ExampleMode, ResourceBundle) - Method in class org.kohsuke.args4j.CmdLineParser
Formats a command line example into a string.
printSingleLineUsage(OutputStream) - Method in class org.kohsuke.args4j.CmdLineParser
Prints a single-line usage to the screen.
printSingleLineUsage(Writer, ResourceBundle) - Method in class org.kohsuke.args4j.CmdLineParser
Prints a single-line usage to the screen.
printUsage(OutputStream) - Method in class org.kohsuke.args4j.CmdLineParser
Prints the list of options and their usages to the screen.
printUsage(Writer, ResourceBundle) - Method in class org.kohsuke.args4j.CmdLineParser
Prints the list of options and their usages to the screen.

R

registerHandler(Class, Class<? extends OptionHandler>) - Static method in class org.kohsuke.args4j.CmdLineParser
Registers a user-defined OptionHandler class with args4j.
ReloadingClassLoader - Class in org.kohsuke.args4j.apt
Used to isolate a child class loader from the parent classloader.
ReloadingClassLoader(ClassLoader) - Constructor for class org.kohsuke.args4j.apt.ReloadingClassLoader
 
required - Variable in class org.kohsuke.args4j.Config.ConfigElement
 
required() - Method in class org.kohsuke.args4j.OptionDef
 
RestOfArgumentsHandler - Class in org.kohsuke.args4j.spi
Eagerly grabs all the arguments.
RestOfArgumentsHandler(CmdLineParser, OptionDef, Setter<String>) - Constructor for class org.kohsuke.args4j.spi.RestOfArgumentsHandler
 
run(String[]) - Method in class org.kohsuke.args4j.apt.Main
 

S

setter - Variable in class org.kohsuke.args4j.spi.OptionHandler
Object to be used for setting value.
Setter<T> - Interface in org.kohsuke.args4j.spi
Abstraction of the value setter.
Setters - Class in org.kohsuke.args4j.spi
Factory of Setters.
Setters() - Constructor for class org.kohsuke.args4j.spi.Setters
 
setUsageWidth(int) - Method in class org.kohsuke.args4j.CmdLineParser
 
ShortOptionHandler - Class in org.kohsuke.args4j.spi
Short OptionHandler OneArgumentOptionHandler
ShortOptionHandler(CmdLineParser, OptionDef, Setter<? super Short>) - Constructor for class org.kohsuke.args4j.spi.ShortOptionHandler
 
size() - Method in interface org.kohsuke.args4j.spi.Parameters
Number of remaining tokens.
startElement(String, String, String, Attributes) - Method in class org.kohsuke.args4j.Config.ConfigHandler
 
Starter - Class in org.kohsuke.args4j
Starter class which uses reflection to instantiate the business class, parse the command line parameters, sets the fields of the business class and doing the help message handling.
Starter() - Constructor for class org.kohsuke.args4j.Starter
 
StopOptionHandler - Class in org.kohsuke.args4j.spi
OptionHandler for the option terminator "--".
StopOptionHandler(CmdLineParser, OptionDef, Setter<? super String>) - Constructor for class org.kohsuke.args4j.spi.StopOptionHandler
 
stopOptionParsing() - Method in class org.kohsuke.args4j.CmdLineParser
 
StringArrayOptionHandler - Class in org.kohsuke.args4j.spi
An OptionHandler for handling String[] types.
StringArrayOptionHandler(CmdLineParser, OptionDef, Setter<? super String[]>) - Constructor for class org.kohsuke.args4j.spi.StringArrayOptionHandler
 
StringOptionHandler - Class in org.kohsuke.args4j.spi
String OptionHandler.
StringOptionHandler(CmdLineParser, OptionDef, Setter<? super String>) - Constructor for class org.kohsuke.args4j.spi.StringOptionHandler
 
supportedAnnotationTypes() - Method in class org.kohsuke.args4j.apt.AnnotationProcessorFactoryImpl
 
supportedOptions() - Method in class org.kohsuke.args4j.apt.AnnotationProcessorFactoryImpl
 

T

toString() - Method in class org.kohsuke.args4j.NamedOptionDef
 
toString() - Method in class org.kohsuke.args4j.OptionDef
 

U

URIOptionHandler - Class in org.kohsuke.args4j.spi
URI OptionHandler.
URIOptionHandler(CmdLineParser, OptionDef, Setter<? super URI>) - Constructor for class org.kohsuke.args4j.spi.URIOptionHandler
 
URLOptionHandler - Class in org.kohsuke.args4j.spi
URL OptionHandler.
URLOptionHandler(CmdLineParser, OptionDef, Setter<? super URL>) - Constructor for class org.kohsuke.args4j.spi.URLOptionHandler
 
usage - Variable in class org.kohsuke.args4j.Config.ConfigElement
 
usage() - Method in class org.kohsuke.args4j.OptionDef
 

V

valueOf(String) - Static method in enum org.kohsuke.args4j.apt.Mode
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.kohsuke.args4j.ExampleMode
Returns the enum constant of this type with the specified name.
values() - Static method in enum org.kohsuke.args4j.apt.Mode
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.kohsuke.args4j.ExampleMode
Returns an array containing the constants of this enum type, in the order they are declared.

X

XmlParser - Class in org.kohsuke.args4j
Parses an XML-file specifying the 'annotations'.
XmlParser() - Constructor for class org.kohsuke.args4j.XmlParser
 

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

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