agi.foundation.access

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

Enum LinkGraphDirection

java.lang.Object

java.lang.Enum<LinkGraphDirection>

agi.foundation.access.LinkGraphDirection

All Implemented Interfaces:

Enumeration, Serializable, Comparable<LinkGraphDirection>

public enum LinkGraphDirection
extends Enum<LinkGraphDirection>
implements Enumeration

Identifies the link direction required during a traversal of the LinkGraph.

Enum Constant Summary

Enum Constants

Enum Constant and Description
IGNORE The direction of the signal is ignored.
RECEIVE The initial object is receiving from the final object.
TRANSMIT The initial object is transmitting to the final object.

Method Summary

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

IGNORE

public static final LinkGraphDirection IGNORE

The direction of the signal is ignored.

TRANSMIT

public static final LinkGraphDirection TRANSMIT

The initial object is transmitting to the final object.

RECEIVE

public static final LinkGraphDirection RECEIVE

The initial object is receiving from the final object.

Method Detail

values

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

Returns:

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

valueOf

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

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

Returns:

The default enum constant.