org.jcon.util

Class CommandLineArgument

java.lang.Object

org.jcon.util.CommandLineArgument

All Implemented Interfaces:

java.io.Serializable

public class CommandLineArgument
extends java.lang.Object
implements java.io.Serializable

An argument in a CommandLineSyntax.

Arguments here refer to those items given on a command line that don't apply to prefixed-by-dash options. For example, for the standard unix copy command:

     cp file1 file2
 

file1 and file2 are the arguments.

Author:

Paul Reavis

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CommandLineArgument() Constructs a blank CommandLineArgument.
CommandLineArgument(java.lang.String name, java.lang.String description) Constructs an argument which is required.
CommandLineArgument(java.lang.String name, java.lang.String description, java.lang.String defaultValue) Constructs an argument which is not required, and has a default value (which might of course be null, but hey).

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getDefaultValue()
java.lang.String	getDescription()
java.lang.String	getName()
boolean	isRequired()
void	setDefaultValue(java.lang.String newDefaultValue)
void	setDescription(java.lang.String newDescription)
void	setName(java.lang.String newName)
void	setRequired(boolean newRequired)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

CommandLineArgument

public CommandLineArgument()

Constructs a blank CommandLineArgument.

CommandLineArgument

public CommandLineArgument(java.lang.String name,
                   java.lang.String description)

Constructs an argument which is required.

CommandLineArgument

public CommandLineArgument(java.lang.String name,
                   java.lang.String description,
                   java.lang.String defaultValue)

Constructs an argument which is not required, and has a default value (which might of course be null, but hey).

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getName

public java.lang.String getName()

setName

public void setName(java.lang.String newName)

getDescription

public java.lang.String getDescription()

setDescription

public void setDescription(java.lang.String newDescription)

isRequired

public boolean isRequired()

setRequired

public void setRequired(boolean newRequired)

getDefaultValue

public java.lang.String getDefaultValue()

setDefaultValue

public void setDefaultValue(java.lang.String newDefaultValue)