agi.foundation.graphics

(agi.foundation.graphics-2024r3.jar)

Enum BinaryLogicOperation

java.lang.Object

java.lang.Enum<BinaryLogicOperation>

agi.foundation.graphics.BinaryLogicOperation

All Implemented Interfaces:

Enumeration, Serializable, Comparable<BinaryLogicOperation>

public enum BinaryLogicOperation
extends Enum<BinaryLogicOperation>
implements Enumeration

Binary logic operations that can be used by CompositeDisplayCondition.

See Also:

Display Conditions topic, CompositeDisplayCondition

Enum Constant Summary

Enum Constants

Enum Constant and Description
AND Logically and together display conditions in the composite.
OR Logically or together display conditions in the composite.

Method Summary

Modifier and Type	Method and Description
static BinaryLogicOperation	getDefault() Get the enum constant that is considered to be the default.
static BinaryLogicOperation	getFromValue(int value) Get the enum constant that is associated with the given numeric value.
int	getValue() Get the numeric value associated with this enum constant.
static BinaryLogicOperation	valueOf(String name) Returns the enum constant of this type with the specified name.
static BinaryLogicOperation[]	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 BinaryLogicOperation AND

Logically and together display conditions in the composite.

OR

public static final BinaryLogicOperation OR

Logically or together display conditions in the composite.

Method Detail

values

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

Returns:

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

valueOf

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

getValue

public int getValue()

Get the numeric value associated with this enum constant.

Specified by:

getValue in interface Enumeration

Returns:

A numeric value.

getFromValue

@Nonnull
public static BinaryLogicOperation getFromValue(int value)

Get the enum constant that is associated with the given numeric value.

Parameters:

value - a numeric value.

Returns:

The enum constant associated with value.

getDefault

@Nonnull
public static BinaryLogicOperation getDefault()

Get the enum constant that is considered to be the default.

Returns:

The default enum constant.