org.opentox.toxotis.core.component
Enum Parameter.ParameterScope

java.lang.Object
  extended by java.lang.Enum<Parameter.ParameterScope>
      extended by org.opentox.toxotis.core.component.Parameter.ParameterScope
All Implemented Interfaces:
Serializable, Comparable<Parameter.ParameterScope>
Enclosing class:
Parameter<T>

public static enum Parameter.ParameterScope
extends Enum<Parameter.ParameterScope>

The scope of the parameter of an Algorithm that can either be Mandatory or Optional.


Enum Constant Summary
MANDATORY
          A parameter is mandatory when the user has to provide it's value and no default values can be assigned to it.
OPTIONAL
          If a parameter is tagged as 'Optional' then the client does not need to provide its value explicitly but instead a default value will be used.
 
Method Summary
static Parameter.ParameterScope valueOf(String name)
          Returns the enum constant of this type with the specified name.
static Parameter.ParameterScope[] 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

OPTIONAL

public static final Parameter.ParameterScope OPTIONAL
If a parameter is tagged as 'Optional' then the client does not need to provide its value explicitly but instead a default value will be used.


MANDATORY

public static final Parameter.ParameterScope MANDATORY
A parameter is mandatory when the user has to provide it's value and no default values can be assigned to it.

Method Detail

values

public static Parameter.ParameterScope[] 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 (Parameter.ParameterScope c : Parameter.ParameterScope.values())
    System.out.println(c);

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

valueOf

public static Parameter.ParameterScope 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


Copyright © 2011-2012 OpenTox. All Rights Reserved.