Class CommandLine

java.lang.Object

org.datanucleus.util.CommandLine

public class CommandLine
extends Object

Command line option parser. Used by command line applications such as Enhancer and SchemaTool to process command line arguments.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	CommandLine.NoArgOption	No argument option class.
protected static class	CommandLine.Option	CommandLine option base class
protected static class	CommandLine.WithArgOption	Use argment option class.

Field Summary

Fields

Modifier and Type	Field	Description
protected String[]	defaultArg	Default arguments
protected boolean	displaysDash	displays dash
protected List<CommandLine.Option>	optionList	Appended options
protected Map<String, CommandLine.Option>	options	Appended options
protected Map<String, CommandLine.Option>	valueOptions	Appended options

Constructor Summary

Constructors

Constructor	Description
CommandLine()	Default constructor
CommandLine(boolean displaysDash)	Default constructor

Method Summary

Modifier and Type	Method	Description
void	addOption(String shortName, String longName, String argName, String desc)	Add new Option.
String[]	getDefaultArgs()	Return default arguments.
String	getOptionArg(String name)	Return option argument.
boolean	hasOption(String name)	Check option selected
void	parse(String[] args)	Parse command line argments.
String	toString()	Return string like useage.

Methods inherited from class Object

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

Field Details

options

protected Map<String, CommandLine.Option> options

Appended options

valueOptions

protected Map<String, CommandLine.Option> valueOptions

Appended options

optionList

protected List<CommandLine.Option> optionList

Appended options

defaultArg

protected String[] defaultArg

Default arguments

displaysDash

protected boolean displaysDash

displays dash

Constructor Details

CommandLine

public CommandLine()

Default constructor

CommandLine

public CommandLine(boolean displaysDash)

Default constructor

Parameters:

displaysDash - whether to display a dash in the short name

Method Details

addOption

public void addOption(String shortName,
 String longName,
 String argName,
 String desc)

Add new Option.
If argName is null, set this option no-arg option.

Parameters:

shortName - Short name option eg "d"

longName - Long name option eg "directory"

argName - Argment name. No argment option if this param is null.

desc - Desription this option.

parse

public void parse(String[] args)

Parse command line argments.

Parameters:

args - Command line argments

hasOption

public boolean hasOption(String name)

Check option selected

Parameters:

name - Option name (both short name and long name ok)

Returns:

Return true, if option selected.

getOptionArg

public String getOptionArg(String name)

Return option argument.

Parameters:

name - Option name (both short name and long name ok)

Returns:

option Argument

Throws:

IllegalArgumentException - If unmanaged name recieved.

toString

public String toString()

Return string like useage.

Overrides:

toString in class Object

Returns:

Useage string

getDefaultArgs

public String[] getDefaultArgs()

Return default arguments.

Returns:

Default arguments