kinetic.util
Class EffectParameter.String

java.lang.Object
  |
  +--kinetic.util.EffectParameter
        |
        +--kinetic.util.EffectParameter.String
Enclosing class:
EffectParameter

public static class EffectParameter.String
extends EffectParameter

Unrestricted String Parameter Class


Nested Class Summary
 
Nested classes inherited from class kinetic.util.EffectParameter
EffectParameter.Boolean, EffectParameter.BoundedDouble, EffectParameter.BoundedInteger, EffectParameter.Double, EffectParameter.EnumeratedString, EffectParameter.Integer, EffectParameter.Percentage, EffectParameter.String, EffectParameter.ZeroToOne
 
Field Summary
 
Fields inherited from class kinetic.util.EffectParameter
currentValue, defaultValue, name, type, TYPE_BOOLEAN, TYPE_BOUNDED_DOUBLE, TYPE_BOUNDED_INTEGER, TYPE_DOUBLE, TYPE_ENUMERATED_STRING, TYPE_INTEGER, TYPE_PERCENTAGE, TYPE_STRING, TYPE_UNKNOWN, TYPE_ZERO_TO_ONE
 
Constructor Summary
EffectParameter.String(java.lang.String n, java.lang.String v)
          creates a new instance of the type parameter
 
Method Summary
 java.lang.String getValue()
          gets the type casted version of the current value object
 void setValue(java.lang.String v)
          sets the current value object with a type casted variable
 
Methods inherited from class kinetic.util.EffectParameter
getCurrentObject, getDefaultObject, getName, getType, setCurrentObject, setDefaultObject, setName, setType
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

EffectParameter.String

public EffectParameter.String(java.lang.String n,
                              java.lang.String v)
creates a new instance of the type parameter

Parameters:
n - name of the parameter
v - the default and initial value for the parameter
Method Detail

getValue

public java.lang.String getValue()
gets the type casted version of the current value object

Returns:
value of the parameter

setValue

public void setValue(java.lang.String v)
sets the current value object with a type casted variable

Parameters:
v - new value for the parameter