|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.jdo.impl.enhancer.util.Assertion
org.apache.jdo.impl.enhancer.util.Support
org.apache.jdo.impl.enhancer.LogSupport
org.apache.jdo.impl.enhancer.OptionSet
Represents a set of options a program may support.
Nested Class Summary | |
static class |
OptionSet.FlagOption
An option representing a boolean flag. |
static class |
OptionSet.HelpOption
An option that always causes a USAGE_ERROR when parsed (used for '-h|--help' kind of options). |
static class |
OptionSet.IntOption
An option representing a int value. |
static class |
OptionSet.Option
The base class of all option types. |
static class |
OptionSet.StringOption
An option representing a String value. |
Field Summary | |
protected java.util.Map |
abbrevs
Maps the option's short form against option instances. |
protected java.util.List |
arguments
The collected arguments. |
java.lang.String |
argumentsHeader
Usage printout. |
protected java.io.PrintWriter |
err
The stream to write error messages to. |
java.lang.String |
indent
Usage printout. |
static java.lang.String |
lprefix
|
protected java.util.Map |
names
Maps the option's long form against option instances. |
static int |
OK
|
protected java.util.List |
options
The list of registered options. |
java.lang.String |
optionsHeader
Usage printout. |
protected java.io.PrintWriter |
out
The stream to write messages to. |
static java.lang.String |
prefix
|
java.lang.String |
returnHeader
Usage printout. |
static int |
USAGE_ERROR
|
java.lang.String |
usageHeader
Usage printout. |
Fields inherited from class org.apache.jdo.impl.enhancer.util.Support |
timer |
Constructor Summary | |
OptionSet(java.io.PrintWriter out,
java.io.PrintWriter err)
Creates an instance. |
|
OptionSet(java.io.PrintWriter out,
java.io.PrintWriter err,
java.lang.String usageHeader,
java.lang.String optionsHeader,
java.lang.String argumentsHeader,
java.lang.String returnHeader,
java.lang.String indent)
Creates an instance. |
Method Summary | |
int |
check()
Checks options and arguments. |
OptionSet.FlagOption |
createFlagOption(java.lang.String name,
java.lang.String abbrev,
java.lang.String descr)
Creates and registers an option representing a boolean flag. |
OptionSet.FlagOption |
createFlagOption(java.lang.String name,
java.lang.String abbrev,
java.lang.String descr,
boolean deflt)
Creates and registers an option representing a boolean flag. |
OptionSet.HelpOption |
createHelpOption(java.lang.String name,
java.lang.String abbrev,
java.lang.String descr)
Creates and registers an option representing a usage-help request. |
OptionSet.IntOption |
createIntOption(java.lang.String name,
java.lang.String abbrev,
java.lang.String descr)
Creates and registers an option representing a int
value. |
OptionSet.IntOption |
createIntOption(java.lang.String name,
java.lang.String abbrev,
java.lang.String descr,
int deflt)
Creates and registers an option representing a int
value. |
OptionSet.StringOption |
createStringOption(java.lang.String name,
java.lang.String abbrev,
java.lang.String descr)
Creates and registers an option representing a String
value. |
OptionSet.StringOption |
createStringOption(java.lang.String name,
java.lang.String abbrev,
java.lang.String descr,
java.lang.String deflt)
Creates and registers an option representing a String
value. |
protected void |
flush()
Flushes streams. |
static void |
main(java.lang.String[] args)
Tests the class. |
int |
parse(java.lang.String[] argv)
Parses options and arguments. |
protected void |
print(java.lang.String msg)
Prints out a message. |
void |
printAll()
Print options and arguments. |
void |
printArgumentHeader()
Print a usage message to System.err. |
void |
printArguments()
Print arguments. |
void |
printArgumentUsage()
Print a usage message to System.err. |
protected void |
println()
Prints out a message. |
protected void |
println(java.lang.String msg)
Prints out a message. |
protected void |
printlnErr()
Prints out an error message. |
protected void |
printlnErr(java.lang.String msg)
Prints out an error message. |
protected void |
printlnErr(java.lang.String msg,
java.lang.Throwable ex)
Prints out an error message. |
protected void |
printlnErr(java.lang.String msg,
java.lang.Throwable ex,
boolean verbose)
Prints out an error message. |
void |
printOptionHeader()
Print a usage message to System.err. |
void |
printOptions()
Print options. |
void |
printOptionUsage()
Print a usage message to System.err. |
void |
printReturnHeader()
Print a usage message to System.err. |
void |
printReturnUsage()
Print a usage message to System.err. |
void |
printUsage()
Print a usage message to System.err. |
void |
printUsageError(java.lang.String msg)
Print a usage error message to System.err. |
void |
printUsageHeader()
Print a usage message to System.err. |
int |
process(java.lang.String[] args)
Parse and check options and arguments. |
void |
register(OptionSet.Option option)
Registers an option with the set. |
Methods inherited from class org.apache.jdo.impl.enhancer.util.Support |
getI18N, getI18N, getI18N, getI18N, getI18N, getI18N |
Methods inherited from class org.apache.jdo.impl.enhancer.util.Assertion |
affirm, affirm, affirm, affirm |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final int OK
public static final int USAGE_ERROR
public static final java.lang.String prefix
public static final java.lang.String lprefix
protected final java.util.List options
protected final java.util.Map names
protected final java.util.Map abbrevs
protected final java.util.List arguments
public java.lang.String usageHeader
public java.lang.String optionsHeader
public java.lang.String argumentsHeader
public java.lang.String returnHeader
public java.lang.String indent
protected final java.io.PrintWriter out
protected final java.io.PrintWriter err
Constructor Detail |
public OptionSet(java.io.PrintWriter out, java.io.PrintWriter err)
public OptionSet(java.io.PrintWriter out, java.io.PrintWriter err, java.lang.String usageHeader, java.lang.String optionsHeader, java.lang.String argumentsHeader, java.lang.String returnHeader, java.lang.String indent)
Method Detail |
public void register(OptionSet.Option option)
public OptionSet.HelpOption createHelpOption(java.lang.String name, java.lang.String abbrev, java.lang.String descr)
public OptionSet.FlagOption createFlagOption(java.lang.String name, java.lang.String abbrev, java.lang.String descr)
public OptionSet.FlagOption createFlagOption(java.lang.String name, java.lang.String abbrev, java.lang.String descr, boolean deflt)
public OptionSet.IntOption createIntOption(java.lang.String name, java.lang.String abbrev, java.lang.String descr)
int
value.
public OptionSet.IntOption createIntOption(java.lang.String name, java.lang.String abbrev, java.lang.String descr, int deflt)
int
value.
public OptionSet.StringOption createStringOption(java.lang.String name, java.lang.String abbrev, java.lang.String descr)
String
value.
public OptionSet.StringOption createStringOption(java.lang.String name, java.lang.String abbrev, java.lang.String descr, java.lang.String deflt)
String
value.
public int parse(java.lang.String[] argv)
public int check()
public int process(java.lang.String[] args)
public void printUsageError(java.lang.String msg)
public void printUsage()
public void printUsageHeader()
public void printOptionHeader()
public void printOptionUsage()
public void printArgumentHeader()
public void printArgumentUsage()
public void printReturnHeader()
public void printReturnUsage()
public void printAll()
public void printOptions()
public void printArguments()
public static void main(java.lang.String[] args)
protected void printlnErr(java.lang.String msg, java.lang.Throwable ex, boolean verbose)
protected void printlnErr(java.lang.String msg, java.lang.Throwable ex)
protected void printlnErr(java.lang.String msg)
protected void printlnErr()
protected void print(java.lang.String msg)
protected void println(java.lang.String msg)
protected void println()
protected void flush()
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |