plugins.adufour.vars.lang
Class VarEnum<T extends java.lang.Enum<T>>

java.lang.Object
  plugins.adufour.vars.lang.Var<T>
      plugins.adufour.vars.lang.VarEnum<T>

All Implemented Interfaces:

icy.file.xml.XMLPersistent, VarListener<T>

public class VarEnum<T extends java.lang.Enum<T>>
extends Var<T>

Field Summary

Fields inherited from class plugins.adufour.vars.lang.Var

listeners, NO_VALUE, type, XML_KEY_ID

Constructor Summary

VarEnum(java.lang.String name, T defaultValue)

Method Summary

java.lang.String	getValueAsString()
T	parse(java.lang.String s) Parses the given string into an Enumeration value

Methods inherited from class plugins.adufour.vars.lang.Var

addListener, createVarEditor, createVarViewer, fireVariableChanged, fireVariableChanged, getDefaultEditorModel, getDefaultValue, getIterableReferrers, getName, getReference, getReferencingPolicy, getReferrers, getType, getTypeAsString, getValue, getValue, getValueAsString, isAssignableFrom, isEnabled, isOptional, isReferenced, loadFromXML, prettyPrint, referenceChanged, removeListener, removeListeners, saveToXML, setDefaultEditorModel, setEnabled, setOptional, setReference, setReferencingPolicy, setValue, toString, valueChanged

Methods inherited from class java.lang.Object

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

Constructor Detail

VarEnum

public VarEnum(java.lang.String name,
               T defaultValue)
        throws java.lang.NullPointerException

Parameters:

name -

defaultValue -

Throws:

java.lang.NullPointerException - if defaultValue is null

Method Detail

getValueAsString

public java.lang.String getValueAsString()

Overrides:

getValueAsString in class Var<T extends java.lang.Enum<T>>

Returns:

a pretty-printed text representation of the variable's local value (referenced variables are not followed). This text is used to display the value (e.g. in a graphical interface) or store the value into XML files. Overriding implementations should make sure that the result of this method is compatible with the Var.parse(String) method to ensure proper reloading from XML files.

parse

public T parse(java.lang.String s)

Parses the given string into an Enumeration value

Overrides:

parse in class Var<T extends java.lang.Enum<T>>

Returns:

The variable value corresponding to the given string