org.apache.jdo.impl.enhancer
Class OptionSet.Option

java.lang.Object
  extended byorg.apache.jdo.impl.enhancer.OptionSet.Option
Direct Known Subclasses:
OptionSet.FlagOption, OptionSet.HelpOption, OptionSet.IntOption, OptionSet.StringOption
Enclosing class:
OptionSet

public abstract static class OptionSet.Option
extends java.lang.Object

The base class of all option types.


Field Summary
 java.lang.String abbrev
          The short form name of this option.
 java.lang.String descr
          A description of this option.
 java.lang.String name
          The long form name of this option.
protected  OptionSet set
          The set the option is registered with.
 
Constructor Summary
OptionSet.Option(java.lang.String name, java.lang.String abbrev, java.lang.String descr)
          Creates an instance.
 
Method Summary
abstract  java.lang.String asNameValue()
          Returns a String representation of this option's value for printing.
 java.lang.String asUsageHelp()
          Returns a usage description of this option.
abstract  int parse(java.util.Iterator i)
          Parse this option for arguments it may require.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

set

protected OptionSet set
The set the option is registered with.


name

public final java.lang.String name
The long form name of this option.


abbrev

public final java.lang.String abbrev
The short form name of this option.


descr

public final java.lang.String descr
A description of this option.

Constructor Detail

OptionSet.Option

public OptionSet.Option(java.lang.String name,
                        java.lang.String abbrev,
                        java.lang.String descr)
Creates an instance.

Method Detail

parse

public abstract int parse(java.util.Iterator i)
Parse this option for arguments it may require.


asNameValue

public abstract java.lang.String asNameValue()
Returns a String representation of this option's value for printing.


asUsageHelp

public java.lang.String asUsageHelp()
Returns a usage description of this option.



Copyright © 2005 Apache Software Foundation. All Rights Reserved.