Enum Class PromiseResult

java.lang.Object

java.lang.Enum<PromiseResult>

org.freedesktop.gstreamer.gst.PromiseResult

All Implemented Interfaces:

Serializable, Comparable<PromiseResult>, Constable, Enumeration

@Generated("org.javagi.JavaGI")
public enum PromiseResult
extends Enum<PromiseResult>
implements Enumeration

The result of a GstPromise

Since:

1.14

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
EXPIRED	The promise expired (the carrying object lost all refs) and the promise will never be fulfilled.
INTERRUPTED	Interrupted by the consumer as it doesn't want the value anymore.
PENDING	Initial state.
REPLIED	A producer marked a reply

Method Summary

Modifier and Type	Method	Description
static @Nullable Type	getType()	Get the GType of the PromiseResult class.
int	getValue()	Get the numeric value of this enum
static PromiseResult	of(int value)	Create a new PromiseResult for the provided value
static PromiseResult	of(MemorySegment address)	Create a new PromiseResult for the value in the provided memory address.
static PromiseResult	valueOf(String name)	Returns the enum constant of this class with the specified name.
static PromiseResult[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

PENDING

public static final PromiseResult PENDING

Initial state. Waiting for transition to any other state.

INTERRUPTED

public static final PromiseResult INTERRUPTED

Interrupted by the consumer as it doesn't want the value anymore.

REPLIED

public static final PromiseResult REPLIED

A producer marked a reply

EXPIRED

public static final PromiseResult EXPIRED

The promise expired (the carrying object lost all refs) and the promise will never be fulfilled.

Method Details

values

public static PromiseResult[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static PromiseResult valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

of

public static PromiseResult of(int value)

Create a new PromiseResult for the provided value

Parameters:

value - the enum value

Returns:

the enum for the provided value

getValue

public int getValue()

Get the numeric value of this enum

Specified by:

getValue in interface Enumeration

Returns:

the enum value

of

public static PromiseResult of(MemorySegment address)

Create a new PromiseResult for the value in the provided memory address.

Parameters:

address - the memory address holding a enum value

Returns:

the enum for the value in the provided memory address

getType

public static @Nullable Type getType()

Get the GType of the PromiseResult class.

Returns:

the GType