org.knime.core.node.config
Enum ConfigEntries

java.lang.Object
  extended by java.lang.Enum<ConfigEntries>
      extended by org.knime.core.node.config.ConfigEntries
All Implemented Interfaces:
Serializable, Comparable<ConfigEntries>

 enum ConfigEntries
extends Enum<ConfigEntries>

An enumeration holding all possible types that can be written to and read from a Config. All entries have to be defined inside the corresponding DTD.

Author:
Thomas Gabriel, University of Konstanz

Enum Constant Summary
config
          Entry of type sub config.
xboolean
          Entry of type boolean.
xbyte
          Entry of type byte.
xchar
          Entry of type char.
xdouble
          Entry of type double.
xfloat
          Entry of type float.
xint
          Entry of type int.
xlong
          Entry of type long.
xshort
          Entry of type short.
xstring
          Entry of type String.
 
Method Summary
(package private) abstract  AbstractConfigEntry createEntry(String key, String value)
          Creates a new Config entry from String.
static ConfigEntries valueOf(String name)
          Returns the enum constant of this type with the specified name.
static ConfigEntries[] values()
          Returns an array containing the constants of this enum type, in the order they are declared.
 
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

xstring

public static final ConfigEntries xstring
Entry of type String.


xint

public static final ConfigEntries xint
Entry of type int.


xdouble

public static final ConfigEntries xdouble
Entry of type double.


xfloat

public static final ConfigEntries xfloat
Entry of type float.


xlong

public static final ConfigEntries xlong
Entry of type long.


xshort

public static final ConfigEntries xshort
Entry of type short.


xbyte

public static final ConfigEntries xbyte
Entry of type byte.


xchar

public static final ConfigEntries xchar
Entry of type char.


xboolean

public static final ConfigEntries xboolean
Entry of type boolean.


config

public static final ConfigEntries config
Entry of type sub config.

Method Detail

values

public static ConfigEntries[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
for (ConfigEntries c : ConfigEntries.values())
    System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they are declared

valueOf

public static ConfigEntries valueOf(String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:
name - the name of the enum constant to be returned.
Returns:
the enum constant with the specified name
Throws:
IllegalArgumentException - if this enum type has no constant with the specified name
NullPointerException - if the argument is null

createEntry

abstract AbstractConfigEntry createEntry(String key,
                                         String value)
Creates a new Config entry from String.

Parameters:
key - The key for this value.
value - The value.
Returns:
A new Config entry.


Copyright, 2003 - 2010. All rights reserved.
University of Konstanz, Germany.
Chair for Bioinformatics and Information Mining, Prof. Dr. Michael R. Berthold.
You may not modify, publish, transmit, transfer or sell, reproduce, create derivative works from, distribute, perform, display, or in any way exploit any of the content, in whole or in part, except as otherwise expressly permitted in writing by the copyright owner or as specified in the license file distributed with this product.