org.jscsi.target.settings

Enum NumericalResultFunction

java.lang.Object

java.lang.Enum<NumericalResultFunction>

org.jscsi.target.settings.NumericalResultFunction

All Implemented Interfaces:

Serializable, Comparable<NumericalResultFunction>

public enum NumericalResultFunction
extends Enum<NumericalResultFunction>

A result function used by the NumericalEntry class to determine the outcome of integer parameter negotiations.

The behavior of this enumeration is described in the getResult(int, int) method.

Author:

Andreas Ergenzinger

Enum Constant Summary

Enum Constants

Enum Constant and Description
MAX The getResult(int, int) method will return the larger one of the two parameters.
MIN The getResult(int, int) method will return the smaller one of the two parameters.

Method Summary

Methods

Modifier and Type	Method and Description
int	getResult(int a, int b) Returns either the value of the first or the second parameter, depending of the value of this enumeration.
static NumericalResultFunction	valueOf(String name) Returns the enum constant of this type with the specified name.
static NumericalResultFunction[]	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

MIN

public static final NumericalResultFunction MIN

The getResult(int, int) method will return the smaller one of the two parameters.

MAX

public static final NumericalResultFunction MAX

The getResult(int, int) method will return the larger one of the two parameters.

Method Detail

values

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

Returns:

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

valueOf

public static NumericalResultFunction 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

getResult

public int getResult(int a,
            int b)

Returns either the value of the first or the second parameter, depending of the value of this enumeration.

Parameters:

a - the first value

b - the second value

Returns:

either a or b