org.jscsi.target.settings

Enum BooleanResultFunction

java.lang.Object

java.lang.Enum<BooleanResultFunction>

org.jscsi.target.settings.BooleanResultFunction

All Implemented Interfaces:

Serializable, Comparable<BooleanResultFunction>

public enum BooleanResultFunction
extends Enum<BooleanResultFunction>

BooleanResultFunctions are used by instances ofBooleanEntry during the negotiation of boolean parameters.

They determine a negotiation outcome based on a logical AND or OR operation.

Author:

Andreas Ergenzinger

Enum Constant Summary

Enum Constants

Enum Constant and Description
AND The negotiation result will be true only if both initiator and target support that value.
OR The negotiation result will be true only if either the initiator or the target support that value.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	getResult(boolean a, boolean b) Performs a logical AND or OR operation on the two parameters and returns the result.
static BooleanResultFunction	valueOf(String name) Returns the enum constant of this type with the specified name.
static BooleanResultFunction[]	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

AND

public static final BooleanResultFunction AND

The negotiation result will be true only if both initiator and target support that value.

OR

public static final BooleanResultFunction OR

The negotiation result will be true only if either the initiator or the target support that value.

Method Detail

values

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

Returns:

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

valueOf

public static BooleanResultFunction 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 final boolean getResult(boolean a,
                boolean b)

Performs a logical AND or OR operation on the two parameters and returns the result. The type of the operation depends on the value of this BooleanResultFunction.

Parameters:

a - the first boolean value

b - the second boolean value

Returns:

the result of a logical AND or OR operation.