org.daisy.common.messaging

Class MessageAccessor

java.lang.Object

org.daisy.common.messaging.MessageAccessor

Direct Known Subclasses:

AbstractMessageAccessor

public abstract class MessageAccessor
extends Object

Gives access to the stored messages.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	MessageAccessor.MessageFilter

Constructor Summary

Constructors

Constructor and Description
MessageAccessor()

Method Summary

Modifier and Type	Method and Description
abstract MessageAccessor.MessageFilter	createFilter()
abstract List<Message>	getAll() Gets the messgages from a set of levels
List<Message>	getDebugs() Gets the debugs.
List<Message>	getErrors() Gets the errors.
List<Message>	getInfos() Gets the infos.
abstract BigDecimal	getProgress()
List<Message>	getTraces() Gets the traces.
List<Message>	getWarnings() Gets the warnings.
abstract void	listen(Consumer<Integer> callback) Register a callback that is called whenever a new (top-level) message arrives, a message is updated with descendant messages, or the progress of a message changes.
abstract void	unlisten(Consumer<Integer> callback)

Methods inherited from class java.lang.Object

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

Constructor Detail

MessageAccessor

public MessageAccessor()

Method Detail

getErrors

public List<Message> getErrors()

Gets the errors.

Returns:

the error messages

getWarnings

public List<Message> getWarnings()

Gets the warnings.

Returns:

the warning messages

getInfos

public List<Message> getInfos()

Gets the infos.

Returns:

the info messages

getDebugs

public List<Message> getDebugs()

Gets the debugs.

Returns:

the debug messages

getTraces

public List<Message> getTraces()

Gets the traces.

Returns:

the trace messages

getAll

public abstract List<Message> getAll()

Gets the messgages from a set of levels

Parameters:

fromLevels - levels

Returns:

the messages

listen

public abstract void listen(Consumer<Integer> callback)

Register a callback that is called whenever a new (top-level) message arrives, a message is updated with descendant messages, or the progress of a message changes. The argument must be a function that accepts a sequence number representing the event. This sequence number can then be used to get the list of all messages affected by the change, via createFilter().inRange(...).getMessages(). A sequence number is never null and never lower than the sequence numbers previously received, but the same sequence number may occur more than once.

unlisten

public abstract void unlisten(Consumer<Integer> callback)

getProgress

public abstract BigDecimal getProgress()

createFilter

public abstract MessageAccessor.MessageFilter createFilter()