Package gnu.dtools.ritopt

Class IntOption

java.lang.Object

gnu.dtools.ritopt.Option

gnu.dtools.ritopt.IntOption

All Implemented Interfaces:

OptionModifiable

public class IntOption
extends Option

This class is used for options with integer values.

 Copyright (C) Damian Ryan Eads, 2001. All Rights Reserved.

 ritopt is free software; you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by
 the Free Software Foundation; either version 2 of the License, or
 (at your option) any later version.

 ritopt is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 GNU General Public License for more details.

 You should have received a copy of the GNU General Public License
 along with ritopt; if not, write to the Free Software
 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 

Field Summary

Fields inherited from class gnu.dtools.ritopt.Option

DEFAULT_FILE_COMMENT_SIZE, DEFAULT_FILE_COMPLETE_OPTION_SIZE, DEFAULT_HELP_DEPRECATED_SIZE, DEFAULT_HELP_DESCRIPTION_SIZE, DEFAULT_HELP_OPTION_SIZE, DEFAULT_HELP_TYPENAME_SIZE, DEFAULT_MENU_DEPRECATED_SIZE, DEFAULT_MENU_DESCRIPTION_SIZE, DEFAULT_MENU_OPTION_SIZE, DEFAULT_MENU_TYPENAME_SIZE, invoked

Constructor Summary

Constructors

Constructor	Description
IntOption()	Constructs an integer option that is initially set to zero.
IntOption(int value)	Constructs an integer option initialized with the value passed.
IntOption(int value, char shortOption)	Constructs a character option initialized with the value and short option passed.
IntOption(int value, String longOption)	Constructs an integer option initialized with the value and long option passed.
IntOption(int value, String longOption, char shortOption)	Constructs an integer option initialized with the value, short and long option passed.
IntOption(IntOption op)	Constructs an integer option by copying the integer option passed.

Method Summary

Modifier and Type	Method	Description
Object	getObject()	Return the value as an object.
String	getStringValue()	Return this option as a string.
String	getTypeName()	Returns the type name of this option.
int	getValue()	Return this option as an integer.
void	modify(String value)	Modify this option based on a string representation.
void	setValue(int value)	Modify this option using an integer value.
void	setValue(String value)	Modify this option based on a string representation.
String	toString()	Returns a string representation of this object.

Methods inherited from class gnu.dtools.ritopt.Option

action, deprecate, getDescription, getFileCommentSize, getFileCompleteOptionSize, getHashKey, getHashKey, getHashKey, getHashKey, getHelp, getHelpDeprecated, getHelpDeprecatedSize, getHelpDescription, getHelpDescriptionSize, getHelpHeader, getHelpOptionSpecification, getHelpOptionSpecificationSize, getHelpTypeName, getHelpTypenameSize, getLongOption, getMenuDeprecatedSize, getMenuDescriptionSize, getMenuOptionSpecificationSize, getMenuTypenameSize, getName, getOptionFileLine, getShortOption, isDeprecated, isInvoked, setDeprecated, setDescription, setFileCommentSize, setFileCompleteOptionSize, setHelpDeprecatedSize, setHelpDescriptionSize, setHelpOptionSpecificationSize, setHelpTypenameSize, setInvoked, setKey, setKey, setLongOption, setMenuDeprecatedSize, setMenuDescriptionSize, setMenuOptionSpecificationSize, setMenuTypenameSize, setShortOption

Methods inherited from class java.lang.Object

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

Constructor Details

IntOption

public IntOption()

Constructs an integer option that is initially set to zero.

IntOption

public IntOption(IntOption op)

Constructs an integer option by copying the integer option passed.

Parameters:

op - The character option to copy.

IntOption

public IntOption(int value)

Constructs an integer option initialized with the value passed.

Parameters:

value - The initial value of this integer option.

IntOption

public IntOption(int value,
 String longOption)

Constructs an integer option initialized with the value and long option passed.

Parameters:

value - The initial value of this integer option.

longOption - The long option associated with integer option.

IntOption

public IntOption(int value,
 char shortOption)

Constructs a character option initialized with the value and short option passed.

Parameters:

value - The initial value of this integer option.

shortOption - The short option associated with this option.

IntOption

public IntOption(int value,
 String longOption,
 char shortOption)

Constructs an integer option initialized with the value, short and long option passed.

Parameters:

shortOption - The short option associated with this option.

longOption - The long option associated with this option.

value - The initial value of this integer option.

Method Details

getObject

public Object getObject()

Return the value as an object.

Specified by:

getObject in class Option

Returns:

This value as an option.

modify

public void modify(String value)
            throws OptionModificationException

Modify this option based on a string representation.

Parameters:

value - String representation of the object.

Throws:

OptionModificationException - Thrown if an error occurs during modification of an option.

setValue

public void setValue(String value)
              throws OptionModificationException

Modify this option based on a string representation.

Parameters:

value - String representation of the object.

Throws:

OptionModificationException - Thrown if an error occurs during modification of an option.

setValue

public void setValue(int value)

Modify this option using an integer value.

Parameters:

value - an integer value.

getValue

public int getValue()

Return this option as an integer.

Returns:

This option as an integer.

getStringValue

public String getStringValue()

Return this option as a string.

Specified by:

getStringValue in class Option

Returns:

This option as a string.

getTypeName

public String getTypeName()

Returns the type name of this option. For an IntegerOption, "INTEGER" is returned.

Specified by:

getTypeName in class Option

Returns:

The type name of this option.

toString

public String toString()

Returns a string representation of this object.

Overrides:

toString in class Object

Returns:

A string representation of this object.