com.mcdermottroe.exemplar.ui.options
Class Argument

java.lang.Object
  com.mcdermottroe.exemplar.ui.options.Option<Argument>
      com.mcdermottroe.exemplar.ui.options.Argument

All Implemented Interfaces:

Copyable<Argument>, Comparable<Argument>

public class Argument
extends Option<Argument>

Option type for dealing with arguments. Arguments are options that take one, free form value.

Since:

0.2

Field Summary

Fields inherited from class com.mcdermottroe.exemplar.ui.options.Option

caseSensitive, description, mandatory, multiValue, name, value

Constructor Summary

Argument(String argName, String argDesc, boolean isMandatory, boolean isCaseSensitive, String aDefaultValue)
Constructor that just initializes the member variables.

Method Summary

Argument

getCopy() Creates a deep copy of the current object and returns it.

Methods inherited from class com.mcdermottroe.exemplar.ui.options.Option

compareTo, equals, getDescription, getName, getValue, hashCode, isCaseSensitive, isMandatory, isMultiValue, setValue, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

Argument

public Argument(String argName,
                String argDesc,
                boolean isMandatory,
                boolean isCaseSensitive,
                String aDefaultValue)

Constructor that just initializes the member variables.

Parameters:

argName - The name of the argument.

argDesc - A description of what the argument is for.

isMandatory - Set if this option must be set by the user.

isCaseSensitive - Set if the value passed is case sensitive.

aDefaultValue - A default value for this option.

Method Detail

getCopy

public Argument getCopy()

Creates a deep copy of the current object and returns it.

Returns:

A deep copy of the current object.