Package org.apache.pekko.stream

Class QueueOfferResult

java.lang.Object

org.apache.pekko.stream.QueueOfferResult

Direct Known Subclasses:

QueueCompletionResult, QueueOfferResult.Dropped$, QueueOfferResult.Enqueued$

public abstract class QueueOfferResult
extends Object

Not for user extension

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	QueueOfferResult.Dropped$	Type is used to indicate that stream is dropped an element
static class	QueueOfferResult.Enqueued$	Type is used to indicate that stream is successfully enqueued an element
static final class	QueueOfferResult.Failure	Type is used to indicate that stream is failed before or during call to the stream param: cause - exception that stream failed with
static class	QueueOfferResult.Failure$
static class	QueueOfferResult.QueueClosed$	Type is used to indicate that stream is completed before call

Constructor Summary

Constructors

Constructor	Description
QueueOfferResult()

Method Summary

Modifier and Type	Method	Description
static QueueOfferResult	closed()	Java API: The QueueClosed singleton instance
static QueueOfferResult	dropped()	Java API: The Dropped singleton instance
static QueueOfferResult	enqueued()	Java API: The Enqueued singleton instance
abstract boolean	isEnqueued()	Return true if the element was already enqueued, otherwise false.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

QueueOfferResult

public QueueOfferResult()

Method Details

enqueued

public static QueueOfferResult enqueued()

Java API: The Enqueued singleton instance

dropped

public static QueueOfferResult dropped()

Java API: The Dropped singleton instance

closed

public static QueueOfferResult closed()

Java API: The QueueClosed singleton instance

Since:

1.1.0

isEnqueued

public abstract boolean isEnqueued()

Return true if the element was already enqueued, otherwise false.