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

A

AcceptsArguments - Interface in net.windwards.options
Implement this interface to accept non-option arguments from the commandline.
addCommand(String, C) - Method in class net.windwards.options.RegistryCommandDispatcher
Register a new command with this registry.
alternatives - Variable in class net.windwards.options.OptionDescription
If now null, the values allowed for this option; currently used for enums
AmbiguousCommandException - Exception in net.windwards.options.err
Thrown by a RegistryCommandDispatcher in tolerant mode when more than one command matches a partial command name.
AmbiguousCommandException(String) - Constructor for exception net.windwards.options.err.AmbiguousCommandException
 
ArgumentsNotExpectedException - Exception in net.windwards.options.err
Thrown by an OptionParser during parsing if the receiver does not implement AcceptsArguments.
ArgumentsNotExpectedException(String) - Constructor for exception net.windwards.options.err.ArgumentsNotExpectedException
 

B

BadCommandLineException - Exception in net.windwards.options.err
Thrown by an OptionParser during parsing when encountering unexpected characters in an option.
BadCommandLineException(String) - Constructor for exception net.windwards.options.err.BadCommandLineException
 
BooleanValueParser - Class in net.windwards.options.valueparsers
Created by quest on 2013-06-05.
BooleanValueParser() - Constructor for class net.windwards.options.valueparsers.BooleanValueParser
 

C

ClassValueParser - Class in net.windwards.options.valueparsers
Created by quest on 2013-06-05.
ClassValueParser() - Constructor for class net.windwards.options.valueparsers.ClassValueParser
 
command - Variable in class net.windwards.options.CommandDispatcher
 
CommandDispatcher<C> - Class in net.windwards.options
Superclass for dispatchers that can be fed to CommandOptionParser.
CommandDispatcher() - Constructor for class net.windwards.options.CommandDispatcher
 
CommandOptionParser<OC extends CommandDispatcher> - Class in net.windwards.options
The CommandOptionParser supports the sort of aggregated commandline tools that provides an interface to multiple sub-commands.
CommandOptionParser(OC) - Constructor for class net.windwards.options.CommandOptionParser
 
commands - Variable in class net.windwards.options.RegistryCommandDispatcher
 

D

defaultValue - Variable in class net.windwards.options.OptionDescription
default value of this option at time of scanning
descriptions - Variable in class net.windwards.options.OptionParser
descriptions hold a mapping of option names to OptionDescription objects that contain metadata about the options found when scanning the options instance.
documentation - Variable in class net.windwards.options.OptionDescription
documentation string, as picked up from @Option
DuplicateOptionException - Exception in net.windwards.options.err
Thrown by an OptionParser during scanning when it encounters multiple options with the same name.
DuplicateOptionException(String) - Constructor for exception net.windwards.options.err.DuplicateOptionException
 

E

EnumValueParser - Class in net.windwards.options.valueparsers
Created by quest on 2013-06-06.
EnumValueParser() - Constructor for class net.windwards.options.valueparsers.EnumValueParser
 
equals(Object) - Method in class net.windwards.options.OptionDescription
 
extractDefaultValue(Object) - Method in class net.windwards.options.OptionDescription
 

F

field - Variable in class net.windwards.options.OptionDescription
The field object representing the referenced class member
FileValueParser - Class in net.windwards.options.valueparsers
Created by quest on 2013-06-05.
FileValueParser() - Constructor for class net.windwards.options.valueparsers.FileValueParser
 

G

getSelectedCommand() - Method in class net.windwards.options.CommandDispatcher
Once parsing is done, will return the instance of type C that was produced by handleCommand.
getTolerant() - Method in class net.windwards.options.RegistryCommandDispatcher
Return current tolerant status.
getType() - Method in class net.windwards.options.OptionDescription
 

H

handleArgument(String) - Method in interface net.windwards.options.AcceptsArguments
Method will be called for each non-option argument (e.g. a file) encountered on commandline.
handleArgument(String) - Method in class net.windwards.options.CommandDispatcher
 
handleCommand(String) - Method in class net.windwards.options.CommandDispatcher
Implement this method to lookup and/or create an instance of type C that represents the command that matches command.
handleCommand(String) - Method in class net.windwards.options.RegistryCommandDispatcher
 

I

interpretValue(String) - Method in class net.windwards.options.OptionDescription
 
InvalidOptionValue - Exception in net.windwards.options.err
Thrown by an OptionParser during parsing when it cannot assign the supplied value to the option.
InvalidOptionValue(String) - Constructor for exception net.windwards.options.err.InvalidOptionValue
 

L

loadProperties(Properties) - Method in class net.windwards.options.OptionParser
Loads a Properties instance into the options instance given to this OptionParser.
longOptionName - Variable in class net.windwards.options.OptionDescription
Full name of the option
longOptPattern - Variable in class net.windwards.options.OptionParser
 

M

MandatoryValueMissing - Exception in net.windwards.options.err
Thrown by an OptionParser during parsing if the user tried to give only an option where an option value is required.
MandatoryValueMissing(String) - Constructor for exception net.windwards.options.err.MandatoryValueMissing
 
matches(Map.Entry<String, C>, String) - Method in class net.windwards.options.RegistryCommandDispatcher
 

N

net.windwards.options - package net.windwards.options
 
net.windwards.options.err - package net.windwards.options.err
 
net.windwards.options.valueparsers - package net.windwards.options.valueparsers
 
NoSuchCommandException - Exception in net.windwards.options.err
Thrown by RegistryCommandDispatcher when it fails to find a command instance matching the supplied command name.
NoSuchCommandException(String) - Constructor for exception net.windwards.options.err.NoSuchCommandException
 
NoSuchOptionException - Exception in net.windwards.options.err
Thrown by OptionParser during parsing if it cannot find an option declaration that matches an option supplied on the command line.
NoSuchOptionException(String) - Constructor for exception net.windwards.options.err.NoSuchOptionException
 
NullValueParser - Class in net.windwards.options.valueparsers
Created by quest on 2013-06-06.
NullValueParser() - Constructor for class net.windwards.options.valueparsers.NullValueParser
 
NumberValueParser - Class in net.windwards.options.valueparsers
Created by quest on 2013-06-05.
NumberValueParser() - Constructor for class net.windwards.options.valueparsers.NumberValueParser
 

O

Option - Annotation Type in net.windwards.options
Option denotes a field that should be interpreted as a commandline option.
OptionDescription - Class in net.windwards.options
Information about a single options as detected during scanning.
OptionDescription(Field) - Constructor for class net.windwards.options.OptionDescription
 
OptionParseException - Exception in net.windwards.options.err
Base class for all exceptions that occur during parsing.
OptionParseException(String) - Constructor for exception net.windwards.options.err.OptionParseException
 
OptionParser<OC> - Class in net.windwards.options
OptionParser handles parsing of commandline options and arguments, roughly adhering to the GNU standard.
OptionParser(OC) - Constructor for class net.windwards.options.OptionParser
 
options - Variable in class net.windwards.options.OptionParser
Unless you hold your own reference to the options instance, you can access it from here.

P

parse(String[]) - Method in class net.windwards.options.CommandOptionParser
 
parse(String[]) - Method in class net.windwards.options.OptionParser
Parse a String[] of commandline arguments and populate the previously supplied options instance.
parse(OptionDescription, Class<?>, String) - Method in class net.windwards.options.valueparsers.BooleanValueParser
 
parse(OptionDescription, Class<?>, String) - Method in class net.windwards.options.valueparsers.ClassValueParser
 
parse(OptionDescription, Class<?>, String) - Method in class net.windwards.options.valueparsers.EnumValueParser
 
parse(OptionDescription, Class<?>, String) - Method in class net.windwards.options.valueparsers.FileValueParser
 
parse(OptionDescription, Class<?>, String) - Method in class net.windwards.options.valueparsers.NullValueParser
 
parse(OptionDescription, Class<?>, String) - Method in class net.windwards.options.valueparsers.NumberValueParser
 
parse(OptionDescription, Class<?>, String) - Method in class net.windwards.options.valueparsers.StringValueParser
 
parse(OptionDescription, Class<?>, String) - Method in class net.windwards.options.valueparsers.URLValueParser
 
parse(OptionDescription, Class<?>, String) - Method in interface net.windwards.options.valueparsers.ValueParser
 
parsers - Static variable in class net.windwards.options.OptionDescription
Map of known ValueParsers.
processLongOption(String) - Method in class net.windwards.options.OptionParser
 
processShortOptions(String, String) - Method in class net.windwards.options.OptionParser
 

R

RegistryCommandDispatcher<C> - Class in net.windwards.options
RegistryCommandDispatcher is a simple implementation of CommandDispatcher.handleCommand.
RegistryCommandDispatcher() - Constructor for class net.windwards.options.RegistryCommandDispatcher
Create a new RegistryCommandDispatcher.
RegistryCommandDispatcher(boolean) - Constructor for class net.windwards.options.RegistryCommandDispatcher
Create a new RegistryCommandDispatcher.

S

scanFields(Class<?>, Object) - Static method in class net.windwards.options.OptionParser
Scan a class for Options, to produce OptionDescriptions from a class with @Option annotations.
setOption(String, String) - Method in class net.windwards.options.OptionParser
Raw interface to set one option.
setOption(OptionDescription, String) - Method in class net.windwards.options.OptionParser
 
setTolerant(boolean) - Method in class net.windwards.options.RegistryCommandDispatcher
Control wether this dispatcher is tolerant, i.e. wether it will match commands on part of their name.
shortNames - Variable in class net.windwards.options.OptionParser
Mapping of short version of options to their respective OptionDescription objects.
shortOptionName - Variable in class net.windwards.options.OptionDescription
Short (one-letter) version of option, or null if none.
StringValueParser - Class in net.windwards.options.valueparsers
Created by quest on 2013-06-05.
StringValueParser() - Constructor for class net.windwards.options.valueparsers.StringValueParser
 

T

tolerant - Variable in class net.windwards.options.RegistryCommandDispatcher
 

U

UnknownCommandException - Exception in net.windwards.options.err
 
UnknownCommandException(String) - Constructor for exception net.windwards.options.err.UnknownCommandException
 
UnsupportedTypeException - Exception in net.windwards.options.err
Thrown by an OptionParser during scanning when an option has a type that is not known to the parser.
UnsupportedTypeException(String) - Constructor for exception net.windwards.options.err.UnsupportedTypeException
 
URLValueParser - Class in net.windwards.options.valueparsers
Created by quest on 2013-06-05.
URLValueParser() - Constructor for class net.windwards.options.valueparsers.URLValueParser
 
usage(Class<?>) - Static method in class net.windwards.options.OptionParser
Static version of the usage message.
usage() - Method in class net.windwards.options.OptionParser
Produce a human-readable message describing the available options.
usage(Map<String, OptionDescription>) - Static method in class net.windwards.options.OptionParser
 

V

valueParser - Variable in class net.windwards.options.OptionDescription
 
ValueParser - Interface in net.windwards.options.valueparsers
Created by quest on 2013-06-05.
A B C D E F G H I L M N O P R S T U V 

Copyright © 2013. All Rights Reserved.