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

A

addArgument(Setter, Argument) - Method in class org.kohsuke.args4j.CmdLineParser

Programmatically defines an argument (instead of reading it from annotations as normal).

addOption(Setter, Option) - Method in class org.kohsuke.args4j.CmdLineParser

Programmatically defines an option (instead of reading it from annotations as normal).

addToMap(String, Map) - Method in class org.kohsuke.args4j.spi.MapOptionHandler

Encapsulates how a single string argument gets converted into key and value.

addToMap(Map, String, String) - Method in class org.kohsuke.args4j.spi.MapOptionHandler

This is the opportunity to convert values to some typed objects.

addValue(Object) - Method in class org.kohsuke.args4j.spi.FieldSetter

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() - Method in class org.kohsuke.args4j.NamedOptionDef

aliases - Variable in class org.kohsuke.args4j.spi.AnnotationImpl

aliases() - Method in class org.kohsuke.args4j.spi.AnnotationImpl

aliases - Variable in class org.kohsuke.args4j.spi.ConfigElement

ALL - Static variable in interface org.kohsuke.args4j.OptionHandlerFilter

Print all defined options in the example.

AnnotationImpl - Class in org.kohsuke.args4j.spi

Base class for the @Option and @Argument implementation classes.

AnnotationImpl(Class<? extends Annotation>) - Constructor for class org.kohsuke.args4j.spi.AnnotationImpl

AnnotationImpl(Class<? extends Annotation>, ConfigElement) - Constructor for class org.kohsuke.args4j.spi.AnnotationImpl

AnnotationProcessorImpl - Class in org.kohsuke.args4j.apt

Annotation Processor to be invoked by javac.

AnnotationProcessorImpl() - Constructor for class org.kohsuke.args4j.apt.AnnotationProcessorImpl

annotationType() - Method in class org.kohsuke.args4j.spi.AnnotationImpl

AnnotationVisitorReorderer - Class in org.kohsuke.args4j.apt

Reorders the annotation according to their canonical name

AnnotationVisitorReorderer(AnnotationVisitor) - Constructor for class org.kohsuke.args4j.apt.AnnotationVisitorReorderer

Argument - Annotation Type in org.kohsuke.args4j

Argument of the command line.

ArgumentImpl - Class in org.kohsuke.args4j.spi

Implementation of @Argument so we can instantiate it.

ArgumentImpl(ConfigElement) - Constructor for class org.kohsuke.args4j.spi.ArgumentImpl

arguments - Variable in class org.kohsuke.args4j.Config

All @Arguments.

asAnnotatedElement() - Method in class org.kohsuke.args4j.spi.FieldSetter

asAnnotatedElement() - Method in class org.kohsuke.args4j.spi.MethodSetter

asAnnotatedElement() - Method in interface org.kohsuke.args4j.spi.Setter

Returns the AnnotatedElement by which you can access annotations written on this setter.

asFieldSetter() - Method in class org.kohsuke.args4j.spi.FieldSetter

asFieldSetter() - Method in class org.kohsuke.args4j.spi.MethodSetter

asFieldSetter() - Method in interface org.kohsuke.args4j.spi.Setter

If this setter encapsulates a field, return the direct access to that field as FieldSetter.

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

Character 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, Localizable, String...) - Constructor for exception org.kohsuke.args4j.CmdLineException

CmdLineException(CmdLineParser, String) - Constructor for exception org.kohsuke.args4j.CmdLineException

Deprecated.

Use CmdLineException.CmdLineException(org.kohsuke.args4j.CmdLineParser, Localizable, java.lang.String...)

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.

CmdLineParser(Object, ParserProperties) - 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.ConfigHandler - Class in org.kohsuke.args4j

SAX-Handler for reading the configuration file.

Config.ConfigHandler(Config) - Constructor for class org.kohsuke.args4j.Config.ConfigHandler

ConfigElement - Class in org.kohsuke.args4j.spi

The ConfigElement is an <option> or <argument> tag in the xml configuration file.

ConfigElement() - Constructor for class org.kohsuke.args4j.spi.ConfigElement

configureParser(Object, SubCommand) - Method in class org.kohsuke.args4j.spi.SubCommandHandler

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

createNewCollection(Class<? extends Map>) - Method in class org.kohsuke.args4j.spi.MapOptionHandler

Creates a new instance of the collection.

createOptionHandler(OptionDef, Setter) - Method in class org.kohsuke.args4j.CmdLineParser

Deprecated.

You should use OptionHandlerRegistry.createOptionHandler(org.kohsuke.args4j.CmdLineParser, org.kohsuke.args4j.OptionDef, org.kohsuke.args4j.spi.Setter) instead.

createOptionHandler(CmdLineParser, OptionDef, Setter) - Method in class org.kohsuke.args4j.OptionHandlerRegistry

Creates an OptionHandler that handles the given Option annotation and the Setter instance.

D

defaults() - Static method in class org.kohsuke.args4j.ParserProperties

Returns an instance of the default parser properties.

DelimitedOptionHandler<T> - Class in org.kohsuke.args4j.spi

Partial OptionHandler implementation that takes a single value to the option, which is then gets split into individual tokens using fixed delimiter.

DelimitedOptionHandler(CmdLineParser, OptionDef, Setter<? super T>, String, OneArgumentOptionHandler<? extends T>) - Constructor for class org.kohsuke.args4j.spi.DelimitedOptionHandler

delimiter - Variable in class org.kohsuke.args4j.spi.DelimitedOptionHandler

depends() - Method in class org.kohsuke.args4j.NamedOptionDef

depends - Variable in class org.kohsuke.args4j.spi.OptionImpl

depends() - Method in class org.kohsuke.args4j.spi.OptionImpl

done() - Method in class org.kohsuke.args4j.apt.AnnotationVisitorReorderer

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

Deprecated.

use OptionHandlerFilter

ExplicitBooleanOptionHandler - Class in org.kohsuke.args4j.spi

Boolean OptionHandler that (unlike the standard BooleanOptionHandler allows values to be set to false explicitly (using e.g.

ExplicitBooleanOptionHandler(CmdLineParser, OptionDef, Setter<? super Boolean>) - Constructor for class org.kohsuke.args4j.spi.ExplicitBooleanOptionHandler

F

fallback(String) - Method in class org.kohsuke.args4j.spi.SubCommandHandler

field - Variable in class org.kohsuke.args4j.spi.ConfigElement

FieldParser - Class in org.kohsuke.args4j

This metadata parser makes all field available to the CmdLineParser.

FieldParser() - Constructor for class org.kohsuke.args4j.FieldParser

FieldSetter - Class in org.kohsuke.args4j.spi

Setter that sets to a Field.

FieldSetter(Object, Field) - Constructor for class org.kohsuke.args4j.spi.FieldSetter

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

forbids() - Method in class org.kohsuke.args4j.NamedOptionDef

forbids - Variable in class org.kohsuke.args4j.spi.OptionImpl

forbids() - Method in class org.kohsuke.args4j.spi.OptionImpl

format(Object...) - Method in interface org.kohsuke.args4j.Localizable

Format the implicitly given message by this object with the default locale.

format(Object...) - Method in enum org.kohsuke.args4j.spi.Messages

formatWithLocale(Locale, Object...) - Method in interface org.kohsuke.args4j.Localizable

Format the implicitly given message by this object with the given locale.

formatWithLocale(Locale, Object...) - Method in enum org.kohsuke.args4j.spi.Messages

G

getArguments() - Method in class org.kohsuke.args4j.CmdLineParser

Lists up all the defined arguments in the order.

getAtSyntax() - Method in class org.kohsuke.args4j.ParserProperties

Gets whether @-prefix-parsing is enabled.

getDefaultMetaVariable() - Method in class org.kohsuke.args4j.spi.BooleanOptionHandler

getDefaultMetaVariable() - Method in class org.kohsuke.args4j.spi.DelimitedOptionHandler

getDefaultMetaVariable() - Method in class org.kohsuke.args4j.spi.EnumOptionHandler

getDefaultMetaVariable() - Method in class org.kohsuke.args4j.spi.ExplicitBooleanOptionHandler

getDefaultMetaVariable() - Method in class org.kohsuke.args4j.spi.FileOptionHandler

getDefaultMetaVariable() - Method in class org.kohsuke.args4j.spi.InetAddressOptionHandler

getDefaultMetaVariable() - Method in class org.kohsuke.args4j.spi.MacAddressOptionHandler

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

getDefaultMetaVariable() - Method in class org.kohsuke.args4j.spi.PatternOptionHandler

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

getDefaultMetaVariable() - Method in class org.kohsuke.args4j.spi.URIOptionHandler

getDefaultMetaVariable() - Method in class org.kohsuke.args4j.spi.URLOptionHandler

getDefaultMetaVariable() - Method in class org.kohsuke.args4j.spi.UuidOptionHandler

getLocalizedMessage() - Method in exception org.kohsuke.args4j.CmdLineException

getMetaVariable(ResourceBundle) - Method in class org.kohsuke.args4j.spi.EnumOptionHandler

getMetaVariable(ResourceBundle) - Method in class org.kohsuke.args4j.spi.OptionHandler

getMetaVariable(ResourceBundle) - Method in class org.kohsuke.args4j.spi.SubCommandHandler

getNameAndMeta(ResourceBundle) - Method in class org.kohsuke.args4j.spi.OptionHandler

Get string representing usage for this option, of the form "name metaval", e.g.

getNameAndMeta(ResourceBundle, ParserProperties) - Method in class org.kohsuke.args4j.spi.OptionHandler

Get string representing usage for this option, of the form "name metaval" or "name=metaval, e.g.

getOptions() - Method in class org.kohsuke.args4j.CmdLineParser

Lists up all the defined options.

getOptionValueDelimiter() - Method in class org.kohsuke.args4j.ParserProperties

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.

getProperties() - Method in class org.kohsuke.args4j.CmdLineParser

getRegistry() - Static method in class org.kohsuke.args4j.OptionHandlerRegistry

Gets the option handler registry singleton instance.

getSupportedAnnotationTypes() - Method in class org.kohsuke.args4j.apt.AnnotationProcessorImpl

getSupportedSourceVersion() - Method in class org.kohsuke.args4j.apt.AnnotationProcessorImpl

getType() - Method in class org.kohsuke.args4j.spi.FieldSetter

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.

getValue() - Method in class org.kohsuke.args4j.spi.FieldSetter

H

handler() - Method in class org.kohsuke.args4j.OptionDef

handler - Variable in class org.kohsuke.args4j.spi.AnnotationImpl

handler() - Method in class org.kohsuke.args4j.spi.AnnotationImpl

handler - Variable in class org.kohsuke.args4j.spi.ConfigElement

hasAnnotation(Class, Class<? extends Annotation>) - Static method in class org.kohsuke.args4j.Starter

help() - Method in class org.kohsuke.args4j.OptionDef

help - Variable in class org.kohsuke.args4j.spi.AnnotationImpl

help() - Method in class org.kohsuke.args4j.spi.AnnotationImpl

hidden() - Method in class org.kohsuke.args4j.OptionDef

Value from Option.hidden() or Argument.hidden()

hidden - Variable in class org.kohsuke.args4j.spi.AnnotationImpl

hidden() - Method in class org.kohsuke.args4j.spi.AnnotationImpl

hidden - Variable in class org.kohsuke.args4j.spi.ConfigElement

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

index - Variable in class org.kohsuke.args4j.spi.AnnotationImpl

index() - Method in class org.kohsuke.args4j.spi.AnnotationImpl

individualOptionHandler - Variable in class org.kohsuke.args4j.spi.DelimitedOptionHandler

InetAddressOptionHandler - Class in org.kohsuke.args4j.spi

InetAddress OptionHandler.

InetAddressOptionHandler(CmdLineParser, OptionDef, Setter<? super InetAddress>) - Constructor for class org.kohsuke.args4j.spi.InetAddressOptionHandler

init(ProcessingEnvironment) - Method in class org.kohsuke.args4j.apt.AnnotationProcessorImpl

instantiate(SubCommand) - Method in class org.kohsuke.args4j.spi.SubCommandHandler

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.spi.ConfigElement

Ensures that only a field XOR a method is set.

isMultiValued() - Method in class org.kohsuke.args4j.OptionDef

isMultiValued() - Method in class org.kohsuke.args4j.spi.FieldSetter

isMultiValued() - Method in class org.kohsuke.args4j.spi.MethodSetter

isMultiValued() - Method in interface org.kohsuke.args4j.spi.Setter

Whether this setter is intrinsically 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

Localizable - Interface in org.kohsuke.args4j

A message that can be formatted with arguments and locale.

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

MacAddressOptionHandler - Class in org.kohsuke.args4j.spi

OptionHandler that parses MAC address to byte[] of length 6.

MacAddressOptionHandler(CmdLineParser, OptionDef, Setter<? super byte[]>) - Constructor for class org.kohsuke.args4j.spi.MacAddressOptionHandler

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

Parses options into a Map.

MapOptionHandler(CmdLineParser, OptionDef, Setter<? super Map<?, ?>>) - Constructor for class org.kohsuke.args4j.spi.MapOptionHandler

Messages - Enum in org.kohsuke.args4j.spi

metaVar() - Method in class org.kohsuke.args4j.OptionDef

metaVar - Variable in class org.kohsuke.args4j.spi.AnnotationImpl

metaVar() - Method in class org.kohsuke.args4j.spi.AnnotationImpl

metavar - Variable in class org.kohsuke.args4j.spi.ConfigElement

method - Variable in class org.kohsuke.args4j.spi.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

MultiFileOptionHandler - Class in org.kohsuke.args4j.spi

Takes a classpath like option ("-cp a.jar;b.jar;c") and maps them to a collection of File.

MultiFileOptionHandler(CmdLineParser, OptionDef, Setter<? super File>) - Constructor for class org.kohsuke.args4j.spi.MultiFileOptionHandler

MultiPathOptionHandler - Class in org.kohsuke.args4j.spi

Takes a classpath like option ("-cp a.jar;b.jar;c") and maps them to a collection of Path.

MultiPathOptionHandler(CmdLineParser, OptionDef, Setter<? super Path>) - Constructor for class org.kohsuke.args4j.spi.MultiPathOptionHandler

multiValued - Variable in class org.kohsuke.args4j.spi.AnnotationImpl

multiValued() - Method in class org.kohsuke.args4j.spi.AnnotationImpl

multiValued - Variable in class org.kohsuke.args4j.spi.ConfigElement

N

name() - Method in class org.kohsuke.args4j.NamedOptionDef

name - Variable in class org.kohsuke.args4j.spi.ConfigElement

name - Variable in class org.kohsuke.args4j.spi.OptionImpl

name() - Method in class org.kohsuke.args4j.spi.OptionImpl

NamedOptionDef - Class in org.kohsuke.args4j

Immutable run-time copy of Option annotation.

NamedOptionDef(Option, boolean) - Constructor for class org.kohsuke.args4j.NamedOptionDef

Deprecated.

multi-valuedness as option definition does not make sense. It's driven by the setter.

NamedOptionDef(Option) - 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

onOption(String, String) - Method in class org.kohsuke.args4j.apt.AnnotationVisitorReorderer

onOption(OptionWithUsage) - Method in class org.kohsuke.args4j.apt.AnnotationVisitorReorderer

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, boolean, 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

OptionHandlerFilter - Interface in org.kohsuke.args4j

Selects OptionHandler.

OptionHandlerRegistry - Class in org.kohsuke.args4j

Manages the registration of option handlers.

OptionImpl - Class in org.kohsuke.args4j.spi

Implementation of @Option so we can instantiate it.

OptionImpl(ConfigElement) - Constructor for class org.kohsuke.args4j.spi.OptionImpl

options - Variable in class org.kohsuke.args4j.Config

All @Options.

OptionWithUsage - Class in org.kohsuke.args4j.apt

org.kohsuke.args4j - package org.kohsuke.args4j

Core classes of the Args4J command line parser.

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(CmdLineParser, Object) - Method in class org.kohsuke.args4j.FieldParser

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

parse(String) - Method in class org.kohsuke.args4j.spi.FloatOptionHandler

parse(String) - Method in class org.kohsuke.args4j.spi.InetAddressOptionHandler

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

parse(String) - Method in class org.kohsuke.args4j.spi.ShortOptionHandler

parse(String) - Method in class org.kohsuke.args4j.spi.UuidOptionHandler

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

parseArguments(Parameters) - Method in class org.kohsuke.args4j.spi.EnumOptionHandler

parseArguments(Parameters) - Method in class org.kohsuke.args4j.spi.ExplicitBooleanOptionHandler

parseArguments(Parameters) - Method in class org.kohsuke.args4j.spi.MacAddressOptionHandler

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

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

Tries 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.SubCommandHandler

parseArguments(Parameters) - Method in class org.kohsuke.args4j.spi.URIOptionHandler

parseArguments(Parameters) - Method in class org.kohsuke.args4j.spi.URLOptionHandler

ParserProperties - Class in org.kohsuke.args4j

Set of properties that controls CmdLineParser behaviours.

PathOptionHandler - Class in org.kohsuke.args4j.spi

Takes a single argument to the option and maps that to Path.

PathOptionHandler(CmdLineParser, OptionDef, Setter<? super Path>) - Constructor for class org.kohsuke.args4j.spi.PathOptionHandler

PatternOptionHandler - Class in org.kohsuke.args4j.spi

A regex option handler.

PatternOptionHandler(CmdLineParser, OptionDef, Setter<Pattern>) - Constructor for class org.kohsuke.args4j.spi.PatternOptionHandler

printExample(OptionHandlerFilter) - Method in class org.kohsuke.args4j.CmdLineParser

Formats a command line example into a string.

printExample(ExampleMode) - Method in class org.kohsuke.args4j.CmdLineParser

Deprecated.

Use CmdLineParser.printExample(OptionHandlerFilter)

printExample(OptionHandlerFilter, ResourceBundle) - 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

Deprecated.

Use CmdLineParser.printExample(OptionHandlerFilter,ResourceBundle)

printOption(PrintWriter, OptionHandler, int, ResourceBundle, OptionHandlerFilter) - Method in class org.kohsuke.args4j.CmdLineParser

Prints usage information for a given option.

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 all the non-hidden options and their usages to the screen.

printUsage(Writer, ResourceBundle, OptionHandlerFilter) - Method in class org.kohsuke.args4j.CmdLineParser

Prints the list of all the non-hidden options and their usages to the screen.

process(Set<? extends TypeElement>, RoundEnvironment) - Method in class org.kohsuke.args4j.apt.AnnotationProcessorImpl

PUBLIC - Static variable in interface org.kohsuke.args4j.OptionHandlerFilter

Print all non-hidden options.

R

registerHandler(Class, Class<? extends OptionHandler>) - Static method in class org.kohsuke.args4j.CmdLineParser

Deprecated.

You should use OptionHandlerRegistry.registerHandler(java.lang.Class, java.lang.Class) instead.

registerHandler(Class, Class<? extends OptionHandler>) - Method in class org.kohsuke.args4j.OptionHandlerRegistry

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() - Method in class org.kohsuke.args4j.OptionDef

REQUIRED - Static variable in interface org.kohsuke.args4j.OptionHandlerFilter

Print all required options.

required - Variable in class org.kohsuke.args4j.spi.AnnotationImpl

required() - Method in class org.kohsuke.args4j.spi.AnnotationImpl

required - Variable in class org.kohsuke.args4j.spi.ConfigElement

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

select(OptionHandler) - Method in interface org.kohsuke.args4j.OptionHandlerFilter

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.

setUsageWidth(int) - Method in class org.kohsuke.args4j.CmdLineParser

Deprecated.

Use ParserProperties.withUsageWidth(int) instead.

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

Signals the parser that parsing the options has finished.

StringArrayOptionHandler - Class in org.kohsuke.args4j.spi

An OptionHandler for greedily mapping a list of tokens into a collection of Strings (such as String[], List<String>, etc.).

StringArrayOptionHandler(CmdLineParser, OptionDef, Setter<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

SubCommand - Annotation Type in org.kohsuke.args4j.spi

Specifies a single sub-command.

subCommand(SubCommand, Parameters) - Method in class org.kohsuke.args4j.spi.SubCommandHandler

SubCommandHandler - Class in org.kohsuke.args4j.spi

OptionHandler used with Argument for parsing typical "sub-command" pattern.

SubCommandHandler(CmdLineParser, OptionDef, Setter<Object>) - Constructor for class org.kohsuke.args4j.spi.SubCommandHandler

SubCommands - Annotation Type in org.kohsuke.args4j.spi

Collection of SubCommands that define possible sub-commands.

sysPathSeperator - Static variable in class org.kohsuke.args4j.spi.MultiFileOptionHandler

sysPathSeperator - Static variable in class org.kohsuke.args4j.spi.MultiPathOptionHandler

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() - Method in class org.kohsuke.args4j.OptionDef

usage - Variable in class org.kohsuke.args4j.spi.AnnotationImpl

usage() - Method in class org.kohsuke.args4j.spi.AnnotationImpl

usage - Variable in class org.kohsuke.args4j.spi.ConfigElement

UuidOptionHandler - Class in org.kohsuke.args4j.spi

UUID OptionHandler.

UuidOptionHandler(CmdLineParser, OptionDef, Setter<? super UUID>) - Constructor for class org.kohsuke.args4j.spi.UuidOptionHandler

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

Deprecated.

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.kohsuke.args4j.spi.Messages

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

Deprecated.

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.kohsuke.args4j.spi.Messages

Returns an array containing the constants of this enum type, in the order they are declared.

W

withAtSyntax(boolean) - Method in class org.kohsuke.args4j.ParserProperties

Toggles the parsing of @-prefixes in values.

withOptionSorter(Comparator<OptionHandler>) - Method in class org.kohsuke.args4j.ParserProperties

Controls how options are sorted in the usage screen.

withOptionValueDelimiter(String) - Method in class org.kohsuke.args4j.ParserProperties

Sets the string used to separate option name and its value (such as --foo=bar vs --foo bar) Default to whitespace.

withUsageWidth(int) - Method in class org.kohsuke.args4j.ParserProperties

Sets the width of a usage line.

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 W X