qflib 0.98.1

de.qfs.lib.option
Class StringOption

java.lang.Object
  |
  +--java.util.Observable
        |
        +--de.qfs.lib.option.Option
              |
              +--de.qfs.lib.option.StringOption
All Implemented Interfaces:
java.lang.Cloneable, ConfigurableOption, java.io.Serializable
Direct Known Subclasses:
TextOption

public class StringOption
extends Option
implements ConfigurableOption

A StringOption's value is of class String.

Version:
$Revision: 1.8 $
Author:
Gregor Schmid
See Also:
Serialized Form

Constructor Summary
StringOption()
          Create a new StringOption.
StringOption(java.lang.String name, java.lang.String value)
          Create a new StringOption with a name and a value.
StringOption(java.lang.String name, java.lang.String value, boolean nullOK)
          Create a new StringOption with a name and a value and the nullOK flag.
 
Method Summary
 boolean equals(java.lang.Object object)
          Two StringOptions are considered equal if their names and values are equal.
 java.lang.String getConfigurableValue()
          Get the Option's value as a String.
 void setConfigurableValue(java.lang.String val)
          Set the Option's value from a String.
 
Methods inherited from class de.qfs.lib.option.Option
addResources, addValidator, checkValue, clone, getName, getResources, getValue, hashCode, isNullOK, removeValidator, setName, setNullOK, setResources, setValue, toString
 
Methods inherited from class java.util.Observable
addObserver, clearChanged, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, notifyObservers, setChanged
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

StringOption

public StringOption()
Create a new StringOption.

StringOption

public StringOption(java.lang.String name,
                    java.lang.String value)
Create a new StringOption with a name and a value.
Parameters:
name - The name to use.
value - The value to use.

StringOption

public StringOption(java.lang.String name,
                    java.lang.String value,
                    boolean nullOK)
Create a new StringOption with a name and a value and the nullOK flag.
Parameters:
name - The name to use.
value - The value to use.
nullOK - The nullOK flag to use.
Method Detail

equals

public boolean equals(java.lang.Object object)
Two StringOptions are considered equal if their names and values are equal.
Overrides:
equals in class Option
Parameters:
object - The object to compare to.
Returns:
True if objects are equal

getConfigurableValue

public java.lang.String getConfigurableValue()
Get the Option's value as a String.
Specified by:
getConfigurableValue in interface ConfigurableOption
Returns:
The Option's value as a String.

setConfigurableValue

public void setConfigurableValue(java.lang.String val)
Set the Option's value from a String.
Specified by:
setConfigurableValue in interface ConfigurableOption
Parameters:
val - The value to set.

qflib 0.98.1