jcgp.backend.parameters

Enum ParameterStatus

java.lang.Object

java.lang.Enum<ParameterStatus>

jcgp.backend.parameters.ParameterStatus

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ParameterStatus>

public enum ParameterStatus
extends java.lang.Enum<ParameterStatus>

Enum type containing all possible states for parameters.

• INVALID: the new parameter value is not valid, and the experiment will not be allowed to run.
• WARNING: the new parameter value is technically valid, though it might lead to undesirable behaviour.
• WARNING_RESET: the new parameter value is technically valid but will require a reset.
• VALID: the new value is valid.

The above definitions are final in the sense that they outline how parameters are treated by the program depending on their status (e.g. if any parameters are set to WARNING_RESET, a reset will automatically be performed when the experiment is run).
In addition to the status itself, this class includes a field to contain details about the current status. If a GUI is in use, the contents of the field should be displayed to the user, as well as some visual indication of the status itself. Both the status and the message should be updated by each parameter when validate() is called.

Author:

Eduardo Pedroni

See Also:

Parameter

Enum Constant Summary

Enum Constants

Enum Constant and Description
INVALID
VALID
WARNING
WARNING_RESET

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDetails()
void	setDetails(java.lang.String details) Sets a new string containing details about the current status.
static ParameterStatus	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static ParameterStatus[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

INVALID

public static final ParameterStatus INVALID

WARNING

public static final ParameterStatus WARNING

WARNING_RESET

public static final ParameterStatus WARNING_RESET

VALID

public static final ParameterStatus VALID

Method Detail

values

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

Returns:

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

valueOf

public static ParameterStatus valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

setDetails

public void setDetails(java.lang.String details)

Sets a new string containing details about the current status. This should be displayed by the GUI, if one is in use.

Parameters:

details - an explanation of the current status.

getDetails

public java.lang.String getDetails()

Returns:

the string containing details about the current status.