agi.foundation.access

(agi.foundation.core-2025r1.jar)

Enum LinkRole

java.lang.Object

java.lang.Enum<LinkRole>

agi.foundation.access.LinkRole

All Implemented Interfaces:

Enumeration, Serializable, Comparable<LinkRole>

public enum LinkRole
extends Enum<LinkRole>
implements Enumeration

Identifies an object (transmitter or receiver) in a link (ILinkService).

Enum Constant Summary

Enum Constants

Enum Constant and Description
RECEIVER The receiver.
TRANSMITTER The transmitter.

Method Summary

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

public static final LinkRole TRANSMITTER

The transmitter.

RECEIVER

public static final LinkRole RECEIVER

The receiver.

Method Detail

values

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

Returns:

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

valueOf

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

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

Returns:

The default enum constant.