public class BooleanOption extends Option
For example, a plus (true) or minus (false) sign directly after the short or long option may be used.
myprogram -a+ -b- --longa+ --longb-The following keywords may be used to invoke an option using the assignment form.
To invoke an option using assignment form where <value> is the <value> of the option, use the following syntax.
myprogram -a=<keyword> -b <keyword> --longa=<keyword> --longb=<keyword>Invoking a boolean option without using any of the aforementioned keywords and forms will set the option to true by default.
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
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 and Description |
---|
BooleanOption()
Constructs a boolean option that is initially false.
|
BooleanOption(boolean value)
Constructs a boolean option initialized with the value passed.
|
BooleanOption(boolean value,
char shortOption)
Constructs a boolean option initialized with the value and short
option passed.
|
BooleanOption(BooleanOption op)
Constructs a boolean option by copying the boolean option passed.
|
BooleanOption(boolean value,
java.lang.String longOption)
Constructs a boolean option initialized with the value and
long option passed.
|
BooleanOption(boolean value,
java.lang.String longOption,
char shortOption)
Constructs a boolean option initialized with the value, short
and long option passed.
|
Modifier and Type | Method and Description |
---|---|
java.lang.Object |
getObject()
Return the value as an object.
|
java.lang.String |
getStringValue()
Return this option as a string.
|
java.lang.String |
getTypeName()
Returns the type name of this option.
|
boolean |
getValue()
Return this option as a boolean.
|
void |
modify(java.lang.String value)
Modify this option based on a string representation.
|
void |
setValue(boolean value)
Modify this option using a boolean value.
|
void |
setValue(java.lang.String value)
Modify this option based on a string representation.
|
java.lang.String |
toString()
Returns a string representation of this object.
|
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
public BooleanOption()
public BooleanOption(BooleanOption op)
op
- The boolean option to copy.public BooleanOption(boolean value)
value
- The initial value of this boolean option.public BooleanOption(boolean value, java.lang.String longOption)
value
- The initial value of this boolean option.longOption
- The long option associated with this option.public BooleanOption(boolean value, char shortOption)
value
- The initial value of this boolean option.shortOption
- The short option associated with this option.public BooleanOption(boolean value, java.lang.String longOption, char shortOption)
shortOption
- The short option associated with this option.longOption
- The long option associated with this option.value
- The initial value of this boolean option.public java.lang.Object getObject()
public void modify(java.lang.String value) throws OptionModificationException
value
- String representation of the object.OptionModificationException
- Thrown if an error occurs
during modification of an option.public void setValue(java.lang.String value) throws OptionModificationException
value
- String representation of the object.OptionModificationException
- Thrown if an error occurs
during modification of an option.public void setValue(boolean value)
value
- A boolean value.public boolean getValue()
public java.lang.String getStringValue()
getStringValue
in class Option
public java.lang.String getTypeName()
getTypeName
in class Option
public java.lang.String toString()
toString
in class java.lang.Object