me.jaimegarza.syntax.env

Class CommandLineOption

java.lang.Object

me.jaimegarza.syntax.env.CommandLineOption

public class CommandLineOption
extends Object

Describes a definition of a command line argument

Author:

jgarza

Constructor Summary

Constructors

Constructor and Description
CommandLineOption(String shortOption, String longOption, boolean hasArg, boolean required, String description, String name) Construct one option

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getDescription()
String	getLongOption()
String	getName()
String	getShortOption()
boolean	isHasArg()
boolean	isRequired()
void	printUsage()
void	setDescription(String description)
void	setHasArg(boolean hasArg)
void	setLongOption(String longOption)
void	setName(String name)
void	setRequired(boolean required)
void	setShortOption(String shortOption)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

CommandLineOption

public CommandLineOption(String shortOption,
                         String longOption,
                         boolean hasArg,
                         boolean required,
                         String description,
                         String name)

Construct one option

Parameters:

shortOption - is the character for single dashes

longOption - is the full text for double dashes

hasArg - does it require an argument, or is it a flag?

required - is it required?

description - is the descriptive text to be used in the usage

name - is the display name of the option

Method Detail

getName

public String getName()

Returns:

the name

setName

public void setName(String name)

Parameters:

name - the name to set

getDescription

public String getDescription()

Returns:

the description

setDescription

public void setDescription(String description)

Parameters:

description - the description to set

getLongOption

public String getLongOption()

Returns:

the longOption

setLongOption

public void setLongOption(String longOption)

Parameters:

longOption - the longOption to set

getShortOption

public String getShortOption()

Returns:

the shortOption

setShortOption

public void setShortOption(String shortOption)

Parameters:

shortOption - the shortOption to set

isHasArg

public boolean isHasArg()

Returns:

the hasArg

setHasArg

public void setHasArg(boolean hasArg)

Parameters:

hasArg - the hasArg to set

isRequired

public boolean isRequired()

Returns:

the required

setRequired

public void setRequired(boolean required)

Parameters:

required - the required to set

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

See Also:

Object.equals(java.lang.Object)

printUsage

public void printUsage()

toString

public String toString()

Overrides:

toString in class Object