agi.foundation.access

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

Enum AccessConstraintSource

java.lang.Object

java.lang.Enum<AccessConstraintSource>

agi.foundation.access.AccessConstraintSource

All Implemented Interfaces:

Enumeration, Serializable, Comparable<AccessConstraintSource>

public enum AccessConstraintSource
extends Enum<AccessConstraintSource>
implements Enumeration

Indicates the source of an Access constraint.

Enum Constant Summary

Enum Constants

Enum Constant and Description
INHERITED_RECEIVER_CONSTRAINT The constraint is owned by and inherited from the "Receiver" platform.
INHERITED_TRANSMITTER_CONSTRAINT The constraint is owned by and inherited from the "Transmitter" platform.
RECEIVER_CONSTRAINT The constraint is owned by the AccessComputation instance and associated with the "Receiver" platform.
TRANSMITTER_CONSTRAINT The constraint is owned by the AccessComputation instance and associated with the "Transmitter" platform.

Method Summary

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

TRANSMITTER_CONSTRAINT

public static final AccessConstraintSource TRANSMITTER_CONSTRAINT

The constraint is owned by the AccessComputation instance and associated with the "Transmitter" platform.

RECEIVER_CONSTRAINT

public static final AccessConstraintSource RECEIVER_CONSTRAINT

The constraint is owned by the AccessComputation instance and associated with the "Receiver" platform.

INHERITED_TRANSMITTER_CONSTRAINT

public static final AccessConstraintSource INHERITED_TRANSMITTER_CONSTRAINT

The constraint is owned by and inherited from the "Transmitter" platform.

INHERITED_RECEIVER_CONSTRAINT

public static final AccessConstraintSource INHERITED_RECEIVER_CONSTRAINT

The constraint is owned by and inherited from the "Receiver" platform.

Method Detail

values

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

Returns:

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

valueOf

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

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

Returns:

The default enum constant.