org.apache.jdo.impl.enhancer
Class OptionSet

java.lang.Object
  extended by org.apache.jdo.impl.enhancer.util.Assertion
      extended by org.apache.jdo.impl.enhancer.util.Support
          extended by org.apache.jdo.impl.enhancer.OptionSet
Direct Known Subclasses:
GenericOptions

public class OptionSet
extends Support

Represents a set of options a program may support.

Author:
Martin Zaun

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

OK

public static final int OK
See Also:
Constant Field Values

USAGE_ERROR

public static final int USAGE_ERROR
See Also:
Constant Field Values

prefix

public static final java.lang.String prefix
See Also:
Constant Field Values

lprefix

public static final java.lang.String lprefix
See Also:
Constant Field Values

options

protected final java.util.List options
The list of registered options.


names

protected final java.util.Map names
Maps the option's long form against option instances.


abbrevs

protected final java.util.Map abbrevs
Maps the option's short form against option instances.


arguments

protected final java.util.List arguments
The collected arguments.


usageHeader

public java.lang.String usageHeader
Usage printout.


optionsHeader

public java.lang.String optionsHeader
Usage printout.


argumentsHeader

public java.lang.String argumentsHeader
Usage printout.


returnHeader

public java.lang.String returnHeader
Usage printout.


indent

public java.lang.String indent
Usage printout.


out

protected final java.io.PrintWriter out
The stream to write messages to.


err

protected final java.io.PrintWriter err
The stream to write error messages to.

Constructor Detail

OptionSet

public OptionSet(java.io.PrintWriter out,
                 java.io.PrintWriter err)
Creates an instance.


OptionSet

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)
Creates an instance.

Method Detail

register

public void register(OptionSet.Option option)
Registers an option with the set.


createHelpOption

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


createFlagOption

public OptionSet.FlagOption createFlagOption(java.lang.String name,
                                             java.lang.String abbrev,
                                             java.lang.String descr)
Creates and registers an option representing a boolean flag.


createFlagOption

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


createIntOption

public OptionSet.IntOption createIntOption(java.lang.String name,
                                           java.lang.String abbrev,
                                           java.lang.String descr)
Creates and registers an option representing a int value.


createIntOption

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


createStringOption

public OptionSet.StringOption createStringOption(java.lang.String name,
                                                 java.lang.String abbrev,
                                                 java.lang.String descr)
Creates and registers an option representing a String value.


createStringOption

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


parse

public int parse(java.lang.String[] argv)
Parses options and arguments.


check

public int check()
Checks options and arguments.


process

public int process(java.lang.String[] args)
Parse and check options and arguments.


printUsageError

public void printUsageError(java.lang.String msg)
Print a usage error message to System.err.


printUsage

public void printUsage()
Print a usage message to System.err.


printUsageHeader

public void printUsageHeader()
Print a usage message to System.err.


printOptionHeader

public void printOptionHeader()
Print a usage message to System.err.


printOptionUsage

public void printOptionUsage()
Print a usage message to System.err.


printArgumentHeader

public void printArgumentHeader()
Print a usage message to System.err.


printArgumentUsage

public void printArgumentUsage()
Print a usage message to System.err.


printReturnHeader

public void printReturnHeader()
Print a usage message to System.err.


printReturnUsage

public void printReturnUsage()
Print a usage message to System.err.


printAll

public void printAll()
Print options and arguments.


printOptions

public void printOptions()
Print options.


printArguments

public void printArguments()
Print arguments.


main

public static void main(java.lang.String[] args)
Tests the class.


printlnErr

protected void printlnErr(java.lang.String msg,
                          java.lang.Throwable ex,
                          boolean verbose)
Prints out an error message.


printlnErr

protected void printlnErr(java.lang.String msg,
                          java.lang.Throwable ex)
Prints out an error message.


printlnErr

protected void printlnErr(java.lang.String msg)
Prints out an error message.


printlnErr

protected void printlnErr()
Prints out an error message.


print

protected void print(java.lang.String msg)
Prints out a message.


println

protected void println(java.lang.String msg)
Prints out a message.


println

protected void println()
Prints out a message.


flush

protected void flush()
Flushes streams.



Copyright © 2005-2012 Apache Software Foundation. All Rights Reserved.