agi.foundation.compatibility

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

Enum EventResetMode

java.lang.Object

java.lang.Enum<EventResetMode>

agi.foundation.compatibility.EventResetMode

All Implemented Interfaces:

Enumeration, Serializable, Comparable<EventResetMode>

public enum EventResetMode
extends Enum<EventResetMode>
implements Enumeration

Indicates whether an EventWaitHandle is reset automatically or manually after receiving a signal.

Enum Constant Summary

Enum Constants

Enum Constant and Description
AUTO_RESET When signaled, the EventWaitHandle resets automatically after releasing a single thread.
MANUAL_RESET When signaled, the EventWaitHandle releases all waiting threads and remains signaled until it is manually reset.

Method Summary

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

AUTO_RESET

public static final EventResetMode AUTO_RESET

When signaled, the EventWaitHandle resets automatically after releasing a single thread. If no threads are waiting, the EventWaitHandle remains signaled until a thread blocks, and resets after releasing the thread.

MANUAL_RESET

public static final EventResetMode MANUAL_RESET

When signaled, the EventWaitHandle releases all waiting threads and remains signaled until it is manually reset.

Method Detail

values

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

Returns:

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

valueOf

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

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

Returns:

The default enum constant.