agi.foundation.access

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

Enum AccessConstraintApplicability

java.lang.Object

java.lang.Enum<AccessConstraintApplicability>

agi.foundation.access.AccessConstraintApplicability

All Implemented Interfaces:

Enumeration, Serializable, Comparable<AccessConstraintApplicability>

public enum AccessConstraintApplicability
extends Enum<AccessConstraintApplicability>
implements Enumeration

An indication of when an access constraint applies.

Enum Constant Summary

Enum Constants

Enum Constant and Description
APPLIES_ALWAYS The constraint always applies, no matter whether the object to which the constraint is attached is the "Transmitter" object or the "Receiver" object.
RECEIVER_ONLY The constraint only applies during access computations in which the object to which the constraint is attached is the "Receiver" object.
TRANSMITTER_ONLY The constraint only applies during access computations in which the object to which the constraint is attached is the "Transmitter" object.

Method Summary

Modifier and Type	Method and Description
static AccessConstraintApplicability	getDefault() Get the enum constant that is considered to be the default.
static AccessConstraintApplicability	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 AccessConstraintApplicability	valueOf(String name) Returns the enum constant of this type with the specified name.
static AccessConstraintApplicability[]	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

APPLIES_ALWAYS

public static final AccessConstraintApplicability APPLIES_ALWAYS

The constraint always applies, no matter whether the object to which the constraint is attached is the "Transmitter" object or the "Receiver" object.

TRANSMITTER_ONLY

public static final AccessConstraintApplicability TRANSMITTER_ONLY

The constraint only applies during access computations in which the object to which the constraint is attached is the "Transmitter" object.

RECEIVER_ONLY

public static final AccessConstraintApplicability RECEIVER_ONLY

The constraint only applies during access computations in which the object to which the constraint is attached is the "Receiver" object.

Method Detail

values

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

Returns:

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

valueOf

public static AccessConstraintApplicability 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 AccessConstraintApplicability 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 AccessConstraintApplicability getDefault()

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

Returns:

The default enum constant.