Package org.axonframework.messaging.deadletter

Class Ignore<M extends Message>

java.lang.Object

org.axonframework.messaging.deadletter.Ignore<M>

Type Parameters:

M - An implementation of Message contained in the dead letter that's been made a decision on.

All Implemented Interfaces:

EnqueueDecision<M>

public class Ignore<M extends Message>
extends Object
implements EnqueueDecision<M>

An EnqueueDecision stating a dead letter should be ignored.

This means the decision can be ignored entirely. As such the component enqueueing a letter will decide what to do with it. In most scenarios this result in enqueueing the given letter, or keeping it in the queue.

Do not that an EnqueueDecision only impacts how, and if, to enqueue a dead letter, and nothing more.

Since:

4.6.0

Author:

Steven van Beelen

Constructor Summary

Constructors

Constructor	Description
Ignore()

Method Summary

Modifier and Type	Method	Description
Optional<Throwable>	enqueueCause()	A Throwable Optional that was part of deciding to enqueue the dead letter in a queue.
boolean	shouldEnqueue()	The decision whether the dead letter should be enqueued in a queue.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.axonframework.messaging.deadletter.EnqueueDecision

withDiagnostics

Constructor Details

Ignore

public Ignore()

Method Details

shouldEnqueue

public boolean shouldEnqueue()

Description copied from interface: EnqueueDecision

The decision whether the dead letter should be enqueued in a queue. When false the dead letter should be evicted.

Specified by:

shouldEnqueue in interface EnqueueDecision<M extends Message>

Returns:

true if the dead letter should be enqueued, false if the dead letter should be evicted.

enqueueCause

public Optional<Throwable> enqueueCause()

Description copied from interface: EnqueueDecision

A Throwable Optional that was part of deciding to enqueue the dead letter in a queue. Empty if the dead letter should be evicted or when there is no failure cause used for deciding to enqueue.

Specified by:

enqueueCause in interface EnqueueDecision<M extends Message>

Returns:

The deciding failure for enqueueing a dead letter, when present.

toString

public String toString()

Overrides:

toString in class Object