com.vgrs.xcode.cmdline
Class CmdLine

java.lang.Object
  com.vgrs.xcode.cmdline.CmdLine

Direct Known Subclasses:

Base32CmdLine, BidiCmdLine, ConvertCmdLine, DCECmdLine, EncodingVariantsCmdLine, HexCmdLine, IdnaCmdLine, NativeCmdLine, NormalizeCmdLine, PunycodeCmdLine, RaceCmdLine, UnicodeCmdLine, UnicodeDataCmdLine

public abstract class CmdLine
extends java.lang.Object

This class is to be extended by all the command line classes in the com.vgrs.xcode.cmdline package to provide a uniform way to parse command line arguments.

Version:

1.0 Aug 10, 2010

Author:

jcolosi

Field Summary

protected static java.lang.String

SWITCH_FILE Command line argument to specify a file name.

Constructor Summary

CmdLine(java.lang.String[] args)

Method Summary

java.lang.String	getCommandName()
CommandLineArgs	getOptions()
abstract java.lang.String	getUsageOptions()
void	setCommandName(java.lang.String commandName)
void	setOptions(CommandLineArgs options)
void	showUsage() Print the usage of this command line class.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SWITCH_FILE

protected static final java.lang.String SWITCH_FILE

Command line argument to specify a file name.

See Also:

Constant Field Values

Constructor Detail

CmdLine

public CmdLine(java.lang.String[] args)

Parameters:

args - the command line arguments.

Method Detail

getCommandName

public java.lang.String getCommandName()

Returns:

Fully qualified class name of the command line class.

getOptions

public CommandLineArgs getOptions()

Returns:

CommandLineArgs containing the command line arguments parsed into easy to interrogate data structures.

getUsageOptions

public abstract java.lang.String getUsageOptions()

Returns:

the usage of this command line class.

setCommandName

public void setCommandName(java.lang.String commandName)

Parameters:

commandName - Fully qualified class name of the command line class.

setOptions

public void setOptions(CommandLineArgs options)

Parameters:

options - command line arguments for this class.

showUsage

public void showUsage()

Print the usage of this command line class.