A C D E G H I L M O P R S T U W

A

AmbiguousOptionNameException - Exception in uk.co.hcsoftware.yago
 
AmbiguousOptionNameException(String, List<Option>) - Constructor for exception uk.co.hcsoftware.yago.AmbiguousOptionNameException
 
ArgReader<V> - Interface in uk.co.hcsoftware.yago
 
args - Variable in class uk.co.hcsoftware.yago.Parser
 
Argument<V> - Class in uk.co.hcsoftware.yago
 
Argument(boolean, ArgReader<V>, String, String) - Constructor for class uk.co.hcsoftware.yago.Argument
 

C

checkOptions(List<Option>) - Method in class uk.co.hcsoftware.yago.parsers.GnuParser
 
checkRequiredElementsPresent() - Method in class uk.co.hcsoftware.yago.Parser
 
checkShortOptionsUnique(List<Option>) - Method in class uk.co.hcsoftware.yago.parsers.GnuParser
 
CollapsedOptionsWithArgumentException - Exception in uk.co.hcsoftware.yago
 
CollapsedOptionsWithArgumentException(Option, String) - Constructor for exception uk.co.hcsoftware.yago.CollapsedOptionsWithArgumentException
 
ConfigException - Exception in uk.co.hcsoftware.yago
indicates you have configured something wrong, e.g.
ConfigException(String) - Constructor for exception uk.co.hcsoftware.yago.ConfigException
 
createAtLeastOneOptionGroup(Option...) - Method in class uk.co.hcsoftware.yago.Parser
>=1 of these must be present
createBundleOptionGroup(Option...) - Method in class uk.co.hcsoftware.yago.Parser
if any of these is present they all must be
createDateReader(List<String>) - Static method in class uk.co.hcsoftware.yago.util.DefaultArgReaders
parsers will be called in order of formats, the first to successfully parse the date will return it
createDateReader(String...) - Static method in class uk.co.hcsoftware.yago.util.DefaultArgReaders
 
createExclusiveOptionGroup(Option...) - Method in class uk.co.hcsoftware.yago.Parser
no more than one of these can be present
createFileReader(boolean) - Static method in class uk.co.hcsoftware.yago.util.DefaultArgReaders
 
createIntReader() - Static method in class uk.co.hcsoftware.yago.util.DefaultArgReaders
 
createStringReader() - Static method in class uk.co.hcsoftware.yago.util.DefaultArgReaders
 
Custom - Class in uk.co.hcsoftware.yago.demo
 
Custom(String[]) - Constructor for class uk.co.hcsoftware.yago.demo.Custom
 

D

DefaultArgReaders - Class in uk.co.hcsoftware.yago.util
 
DefaultArgReaders() - Constructor for class uk.co.hcsoftware.yago.util.DefaultArgReaders
 
DefaultedOption<V> - Class in uk.co.hcsoftware.yago
Extension to Yago option, that allows setting of a default option value, which will be returned as the arg value if it has not been set explicitly on command line.
DefaultedOption(String, V, ArgReader<V>, String) - Constructor for class uk.co.hcsoftware.yago.DefaultedOption
Corresponds to similar Option constructor, but here with a default value replacing the required parameter (if a default value set, then parameter implicitly not required on command line).
DefaultedOption(String, V, char, String, ArgReader<V>, String) - Constructor for class uk.co.hcsoftware.yago.DefaultedOption
Corresponds to similar Option constructor, but here with a default value replacing the required parameter (if a default value set, then parameter implicitly not required on command line).
DefaultedOption(String, V, String) - Constructor for class uk.co.hcsoftware.yago.DefaultedOption
Corresponds to similar Option constructor, but here with a default value replacing the required parameter (if a default value set, then parameter implicitly not required on command line).

E

extraArgs - Variable in class uk.co.hcsoftware.yago.Parser
 

G

getAllArguments() - Method in class uk.co.hcsoftware.yago.Parser
List : extraArgs are all String defined args can be any type
getArgName() - Method in class uk.co.hcsoftware.yago.Option
 
getArgsSummaryString() - Method in class uk.co.hcsoftware.yago.Parser
 
getArgument() - Method in exception uk.co.hcsoftware.yago.MissingArgException
 
getArgValue() - Method in class uk.co.hcsoftware.yago.Argument
 
getArgValue() - Method in class uk.co.hcsoftware.yago.DefaultedOption
If a default value has been set, but no argument value parsed from command line, then returns
getArgValue() - Method in exception uk.co.hcsoftware.yago.InvalidArgException
 
getArgValue() - Method in class uk.co.hcsoftware.yago.Option
 
getDefaultArgValue() - Method in class uk.co.hcsoftware.yago.DefaultedOption
 
getDescription() - Method in class uk.co.hcsoftware.yago.Argument
 
getDescription() - Method in class uk.co.hcsoftware.yago.Option
 
getExtraArgs() - Method in class uk.co.hcsoftware.yago.Parser
 
getFoundArguments() - Method in class uk.co.hcsoftware.yago.Parser
 
getFriendlyMessage() - Method in exception uk.co.hcsoftware.yago.AmbiguousOptionNameException
 
getFriendlyMessage() - Method in exception uk.co.hcsoftware.yago.CollapsedOptionsWithArgumentException
 
getFriendlyMessage() - Method in exception uk.co.hcsoftware.yago.InvalidArgException
 
getFriendlyMessage() - Method in exception uk.co.hcsoftware.yago.InvalidOptArgException
 
getFriendlyMessage() - Method in exception uk.co.hcsoftware.yago.MissingArgException
 
getFriendlyMessage() - Method in exception uk.co.hcsoftware.yago.MissingOptArgException
 
getFriendlyMessage() - Method in exception uk.co.hcsoftware.yago.MissingOptException
 
getFriendlyMessage() - Method in exception uk.co.hcsoftware.yago.ParseException
 
getFriendlyMessage() - Method in exception uk.co.hcsoftware.yago.parsers.IncompleteGroupException
 
getFriendlyMessage() - Method in exception uk.co.hcsoftware.yago.parsers.InvalidGroupException
 
getFriendlyMessage() - Method in exception uk.co.hcsoftware.yago.parsers.InvalidOptSyntaxException
 
getFriendlyMessage() - Method in exception uk.co.hcsoftware.yago.UnrecognizedOptionException
 
getInputValue() - Method in exception uk.co.hcsoftware.yago.CollapsedOptionsWithArgumentException
 
getLeftJustifiedText(int, int, int, String) - Method in class uk.co.hcsoftware.yago.Parser
 
getLongId() - Method in class uk.co.hcsoftware.yago.Option
 
getName() - Method in class uk.co.hcsoftware.yago.Argument
 
getName() - Method in class uk.co.hcsoftware.yago.Option
 
getOption() - Method in exception uk.co.hcsoftware.yago.CollapsedOptionsWithArgumentException
 
getOption() - Method in exception uk.co.hcsoftware.yago.MissingOptArgException
 
getOption() - Method in exception uk.co.hcsoftware.yago.MissingOptException
 
getOptionsString(int, int) - Method in class uk.co.hcsoftware.yago.Parser
 
getOptSummary(Option) - Method in class uk.co.hcsoftware.yago.Parser
 
getSetOptions() - Method in class uk.co.hcsoftware.yago.Parser
 
getShortId() - Method in class uk.co.hcsoftware.yago.Option
 
getTotalArgCount() - Method in class uk.co.hcsoftware.yago.Parser
 
getUsage(String, String) - Method in class uk.co.hcsoftware.yago.Parser
 
getUsage(String, String) - Method in class uk.co.hcsoftware.yago.parsers.GnuParser
 
GnuParser - Class in uk.co.hcsoftware.yago.parsers
parser with similar behaviour to GNU getopt: http://www.urbanophile.com/arenn/hacking/getopt/gnu.getopt.Getopt.html
GnuParser(Option...) - Constructor for class uk.co.hcsoftware.yago.parsers.GnuParser
 
GnuParser(Option[], Argument[]) - Constructor for class uk.co.hcsoftware.yago.parsers.GnuParser
 
GnuParser(List<Option>, List<Argument>) - Constructor for class uk.co.hcsoftware.yago.parsers.GnuParser
 

H

hasArgument() - Method in class uk.co.hcsoftware.yago.Argument
 
hasLongId() - Method in class uk.co.hcsoftware.yago.Option
 
hasShortId() - Method in class uk.co.hcsoftware.yago.Option
 
HelloWorld - Class in uk.co.hcsoftware.yago.demo
 
HelloWorld() - Constructor for class uk.co.hcsoftware.yago.demo.HelloWorld
 

I

IncompleteGroupException - Exception in uk.co.hcsoftware.yago.parsers
 
IncompleteGroupException(List<Option>) - Constructor for exception uk.co.hcsoftware.yago.parsers.IncompleteGroupException
 
InvalidArgException - Exception in uk.co.hcsoftware.yago
 
InvalidArgException(String, String) - Constructor for exception uk.co.hcsoftware.yago.InvalidArgException
 
InvalidArgException(String, Throwable, String) - Constructor for exception uk.co.hcsoftware.yago.InvalidArgException
 
InvalidGroupException - Exception in uk.co.hcsoftware.yago.parsers
 
InvalidGroupException(String, List<Option>) - Constructor for exception uk.co.hcsoftware.yago.parsers.InvalidGroupException
 
InvalidOptArgException - Exception in uk.co.hcsoftware.yago
 
InvalidOptArgException(Option, InvalidArgException) - Constructor for exception uk.co.hcsoftware.yago.InvalidOptArgException
 
InvalidOptSyntaxException - Exception in uk.co.hcsoftware.yago.parsers
 
InvalidOptSyntaxException(String) - Constructor for exception uk.co.hcsoftware.yago.parsers.InvalidOptSyntaxException
 
isRequired() - Method in class uk.co.hcsoftware.yago.Argument
 
isRequired() - Method in class uk.co.hcsoftware.yago.Option
 
isSet() - Method in class uk.co.hcsoftware.yago.Option
 

L

log - Static variable in exception uk.co.hcsoftware.yago.AmbiguousOptionNameException
 
log - Static variable in class uk.co.hcsoftware.yago.Argument
 
log - Static variable in exception uk.co.hcsoftware.yago.CollapsedOptionsWithArgumentException
 
log - Static variable in exception uk.co.hcsoftware.yago.MissingArgException
 
log - Static variable in class uk.co.hcsoftware.yago.Option
 
log - Static variable in class uk.co.hcsoftware.yago.Parser
 
log - Static variable in class uk.co.hcsoftware.yago.parsers.GnuParser
 
log - Static variable in exception uk.co.hcsoftware.yago.parsers.IncompleteGroupException
 
log - Static variable in exception uk.co.hcsoftware.yago.parsers.InvalidGroupException
 
log - Static variable in exception uk.co.hcsoftware.yago.parsers.InvalidOptSyntaxException
 
log - Static variable in exception uk.co.hcsoftware.yago.UnrecognizedOptionException
 
log - Static variable in class uk.co.hcsoftware.yago.util.DefaultArgReaders
 
LsExample - Class in uk.co.hcsoftware.yago.demo
 
LsExample() - Constructor for class uk.co.hcsoftware.yago.demo.LsExample
 

M

main(String[]) - Static method in class uk.co.hcsoftware.yago.demo.Custom
 
main(String[]) - Static method in class uk.co.hcsoftware.yago.demo.HelloWorld
 
main(String[]) - Static method in class uk.co.hcsoftware.yago.demo.LsExample
 
MissingArgException - Exception in uk.co.hcsoftware.yago
Title: MissingArgException Copyright: Copyright (c) 23-Sep-2005 Company: Barclays Capital
MissingArgException(int, Argument) - Constructor for exception uk.co.hcsoftware.yago.MissingArgException
 
MissingOptArgException - Exception in uk.co.hcsoftware.yago
 
MissingOptArgException(Option) - Constructor for exception uk.co.hcsoftware.yago.MissingOptArgException
 
MissingOptException - Exception in uk.co.hcsoftware.yago
Title: MissingOptException Copyright: Copyright (c) 23-Sep-2005 Company: Barclays Capital
MissingOptException(Option) - Constructor for exception uk.co.hcsoftware.yago.MissingOptException
 

O

Option<V> - Class in uk.co.hcsoftware.yago
 
Option(String, boolean, String) - Constructor for class uk.co.hcsoftware.yago.Option
 
Option(String, boolean, ArgReader<V>, String) - Constructor for class uk.co.hcsoftware.yago.Option
 
Option(String, boolean, char, String, ArgReader<V>, String) - Constructor for class uk.co.hcsoftware.yago.Option
 
options - Variable in class uk.co.hcsoftware.yago.Parser
 

P

pad(StringBuilder, int) - Method in class uk.co.hcsoftware.yago.Parser
 
parse(String[]) - Method in class uk.co.hcsoftware.yago.Parser
 
parseArgs(String[]) - Method in class uk.co.hcsoftware.yago.Parser
 
parseArgs(String[]) - Method in class uk.co.hcsoftware.yago.parsers.GnuParser
 
ParseException - Exception in uk.co.hcsoftware.yago
 
ParseException() - Constructor for exception uk.co.hcsoftware.yago.ParseException
 
ParseException(String) - Constructor for exception uk.co.hcsoftware.yago.ParseException
 
ParseException(String, Throwable) - Constructor for exception uk.co.hcsoftware.yago.ParseException
 
ParseException(Throwable) - Constructor for exception uk.co.hcsoftware.yago.ParseException
 
parseOrDie(String, String[]) - Method in class uk.co.hcsoftware.yago.Parser
Deprecated. for back-compatibility, use parseOrDie(String,String,String[]) instead
parseOrDie(String, String[], String) - Method in class uk.co.hcsoftware.yago.Parser
Deprecated. for back-compatibility, use parseOrDie(String,String,String[]) instead
parseOrDie(String, String, String[]) - Method in class uk.co.hcsoftware.yago.Parser
 
Parser - Class in uk.co.hcsoftware.yago
argument parser.
Parser(Option...) - Constructor for class uk.co.hcsoftware.yago.Parser
 
Parser(Option[], Argument[]) - Constructor for class uk.co.hcsoftware.yago.Parser
 
Parser(List<Option>, List<Argument>) - Constructor for class uk.co.hcsoftware.yago.Parser
 

R

read(String, int) - Method in class uk.co.hcsoftware.yago.Argument
 
readArg(String) - Method in interface uk.co.hcsoftware.yago.ArgReader
 
readArg(String) - Method in class uk.co.hcsoftware.yago.Option
 
readArg(int, String) - Method in class uk.co.hcsoftware.yago.Parser
 

S

setArgName(String) - Method in class uk.co.hcsoftware.yago.Option
 
setArgValue(V) - Method in class uk.co.hcsoftware.yago.Option
 
setDescription(String) - Method in class uk.co.hcsoftware.yago.Option
 
setFound(boolean) - Method in class uk.co.hcsoftware.yago.Option
 
setPosixlyCorrect(boolean) - Method in class uk.co.hcsoftware.yago.parsers.GnuParser
as far as I can tell without having done much research the GNU style and POSIX style of option handling are very similar; so not worth having a separate POSIX parser..

T

takesArgument() - Method in class uk.co.hcsoftware.yago.Option
 
toString() - Method in class uk.co.hcsoftware.yago.Option
 

U

uk.co.hcsoftware.yago - package uk.co.hcsoftware.yago
 
uk.co.hcsoftware.yago.demo - package uk.co.hcsoftware.yago.demo
 
uk.co.hcsoftware.yago.parsers - package uk.co.hcsoftware.yago.parsers
 
uk.co.hcsoftware.yago.util - package uk.co.hcsoftware.yago.util
 
UnrecognizedOptionException - Exception in uk.co.hcsoftware.yago
 
UnrecognizedOptionException(String) - Constructor for exception uk.co.hcsoftware.yago.UnrecognizedOptionException
 
UnrecognizedOptionException(String, String) - Constructor for exception uk.co.hcsoftware.yago.UnrecognizedOptionException
 

W

wasFound() - Method in class uk.co.hcsoftware.yago.Argument
 

A C D E G H I L M O P R S T U W

Copyright © 2005 HC Software Ltd. All Rights Reserved.