jcmdline
Class VersionCmdLineHandler

java.lang.Object
  extended by jcmdline.AbstractHandlerDecorator
      extended by jcmdline.VersionCmdLineHandler
All Implemented Interfaces:
CmdLineHandler

public class VersionCmdLineHandler
extends AbstractHandlerDecorator

A CmdLineHandler Decorator class that implements a -version option.

The implemented option is a BooleanParam whose tag is defined by "VersionCmdLineHandler.version.tag" in the strings.properties file (set to "version", in English).

Should the user specify this option on the command line, the command's version is printed to stdout, and System.exit(0) is called.

Information on using CmdLineHandlers can be found in the jcmdline User Guide.

Version:
jcmdline Rel. 2.0.0 $Id: VersionCmdLineHandler.java,v 1.2 2002/12/07 14:22:06 lglawrence Exp $
Author:
Lynne Lawrence
See Also:
CmdLineHandler, AbstractHandlerDecorator

Constructor Summary
VersionCmdLineHandler(java.lang.String version, CmdLineHandler handler)
          constructor
VersionCmdLineHandler(java.lang.String version, java.lang.String cmdName, java.lang.String cmdDesc, java.util.Collection<Parameter<?>> options, java.util.Collection<Parameter<?>> args)
          constructor - uses the PosixCmdLineParser to parse the command line
VersionCmdLineHandler(java.lang.String version, java.lang.String cmdName, java.lang.String cmdDesc, Parameter<?>[] options, Parameter<?>[] args)
          constructor - creates a new DefaultCmdLineHandler as its delegate
VersionCmdLineHandler(java.lang.String version, java.lang.String cmdName, java.lang.String cmdDesc, Parameter<?>[] options, Parameter<?>[] args, CmdLineParser parser)
          constructor - creates a new DefaultCmdLineHandler as its delegate
 
Method Summary
protected  boolean processParsedOptions(boolean parseOk)
          Called following the call to parse() of this class's contained CmdLineHandler.
 
Methods inherited from class jcmdline.AbstractHandlerDecorator
addArg, addOption, exitUsageError, getArg, getArgs, getCmdDesc, getCmdName, getCustomOptions, getDieOnParseError, getOption, getOptions, getParseError, getParser, getUsage, parse, setArgs, setCmdDesc, setCmdName, setCustomOptions, setDieOnParseError, setOptions, setParseError, setParser
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

VersionCmdLineHandler

public VersionCmdLineHandler(java.lang.String version,
                             CmdLineHandler handler)
constructor

Parameters:
version - the command's version
handler - the CmdLineHandler to which most functionality will be delegated
Throws:
java.lang.IllegalArgumentException - if version is null or empty.

VersionCmdLineHandler

public VersionCmdLineHandler(java.lang.String version,
                             java.lang.String cmdName,
                             java.lang.String cmdDesc,
                             java.util.Collection<Parameter<?>> options,
                             java.util.Collection<Parameter<?>> args)
constructor - uses the PosixCmdLineParser to parse the command line

Parameters:
version - the command's version
cmdName - the name of the command creating this DefaultCmdLineHandler
cmdDesc - a short description of the command's purpose
options - a collection of Parameter objects, describing the command's command-line options
args - a collection of Parameter objects, describing the command's command-line arguments (what is left on the command line after all options and their parameters have been processed)
Throws:
java.lang.IllegalArgumentException - if any of the parameters are not correctly specified.
See Also:
setCmdName(), setCmdDesc(), setOptions(), PosixCmdLineParser

VersionCmdLineHandler

public VersionCmdLineHandler(java.lang.String version,
                             java.lang.String cmdName,
                             java.lang.String cmdDesc,
                             Parameter<?>[] options,
                             Parameter<?>[] args)
constructor - creates a new DefaultCmdLineHandler as its delegate

Parameters:
version - the command's version
cmdName - the name of the command
cmdDesc - a short description of the command
options - a collection of Parameter objects, describing the command's command-line options
args - a collection of Parameter objects, describing the command's command-line arguments (what is left on the command line after all options and their parameters have been processed)
Throws:
java.lang.IllegalArgumentException - if any of the parameters are not correctly specified.
See Also:
DefaultCmdLineHandler

VersionCmdLineHandler

public VersionCmdLineHandler(java.lang.String version,
                             java.lang.String cmdName,
                             java.lang.String cmdDesc,
                             Parameter<?>[] options,
                             Parameter<?>[] args,
                             CmdLineParser parser)
constructor - creates a new DefaultCmdLineHandler as its delegate

Parameters:
version - the command's version
cmdName - the name of the command
cmdDesc - a short description of the command
options - a collection of Parameter objects, describing the command's command-line options
args - a collection of Parameter objects, describing the command's command-line arguments (what is left on the command line after all options and their parameters have been processed)
parser - a CmdLineParser to be used to parse the command line
Throws:
java.lang.IllegalArgumentException - if any of the parameters are not correctly specified.
See Also:
DefaultCmdLineHandler
Method Detail

processParsedOptions

protected boolean processParsedOptions(boolean parseOk)
Called following the call to parse() of this class's contained CmdLineHandler. This method only checks for its option if parseStatus is true.

Specified by:
processParsedOptions in class AbstractHandlerDecorator
Parameters:
parseOk - The result of the parse() call to this class's contained CmdLineHandler.
Returns:
This method will call System.exit(0), rather than returning, if its option is set. Otherwise, parseStatus is returned.