org.enhydra.xml.xmlc.commands.options
Class FlagOption

java.lang.Object
  |
  +--org.enhydra.xml.xmlc.commands.options.Option
        |
        +--org.enhydra.xml.xmlc.commands.options.FlagOption

public abstract class FlagOption
extends Option

A flag option that takes no arguments.


Field Summary
 
Fields inherited from class org.enhydra.xml.xmlc.commands.options.Option
help, multipleAllowed, name, numArgs
 
Constructor Summary
FlagOption(java.lang.String name, java.lang.String help)
          Construct a new object.
 
Method Summary
protected  void parse(java.lang.String[] args, ErrorReporter errorReporter, java.lang.Object clientData)
          Parse an instance of the option.
protected abstract  void set(java.lang.Object clientData)
          Method called to set the value.
 
Methods inherited from class org.enhydra.xml.xmlc.commands.options.Option
equals, getHelp, getMultipleAllowed, getName, getNumArgs, hashCode
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

FlagOption

public FlagOption(java.lang.String name,
                  java.lang.String help)
Construct a new object.

Parameters:
name - The name of the option.
help - Help string for the option.
Method Detail

set

protected abstract void set(java.lang.Object clientData)
                     throws XMLCException
Method called to set the value.

XMLCException

parse

protected void parse(java.lang.String[] args,
                     ErrorReporter errorReporter,
                     java.lang.Object clientData)
              throws XMLCException
Parse an instance of the option.

Specified by:
parse in class Option
Parameters:
args - The option's arguments. Will always have the number of arguments defined for an option.
errorReporter - Used to report warnings, such as deprecated options. Errors should be thrown.
clientData - Object that is passed to the parser. Normally contains the object to store the configuration in.
XMLCException


Copyright © 1999-2002 enhydra.org (Mark Diekhans, David Li, Richard Kunze). All Rights reserved.