org.apache.wicket.feedback

Class FeedbackMessages

java.lang.Object

org.apache.wicket.feedback.FeedbackMessages

All Implemented Interfaces:

Serializable, Iterable<FeedbackMessage>, IClusterable

public final class FeedbackMessages
extends Object
implements IClusterable, Iterable<FeedbackMessage>

Holds list of feedback messages. The list can be added to, cleared, queried and filtered.

WARNING: This class should typically NOT be used directly.

Author:

Eelco Hillenius, Jonathan Locke

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
FeedbackMessages() Construct.

Method Summary

Methods

Modifier and Type	Method and Description
void	add(Component reporter, Serializable message, int level) Adds a message
void	add(FeedbackMessage message) Adds a message.
int	clear() Clears any existing messages.
int	clear(IFeedbackMessageFilter filter) Clears all messages that are accepted by the filter.
void	debug(Component reporter, Serializable message) Adds a new ui message with level DEBUG to the current messages.
void	detach() Detaches each stored message
void	error(Component reporter, Serializable message) Adds a new ui message with level ERROR to the current messages.
void	fatal(Component reporter, Serializable message) Adds a new ui message with level FATAL to the current messages.
FeedbackMessage	first() Retrieves the first message
FeedbackMessage	first(int level) Retrieves the first message that level is greater than or equal to the given level
boolean	hasMessage(IFeedbackMessageFilter filter)
boolean	hasMessage(int level) Checks if a message of the specified level or greater was registered. To check for a precise level use hasMessage(IFeedbackMessageFilter) and pass it a reference to ExactLevelFeedbackMessageFilter.
void	info(Component reporter, Serializable message) Adds a new ui message with level INFO to the current messages.
boolean	isEmpty() Gets whether there are no messages.
Iterator<FeedbackMessage>	iterator() Gets an iterator over stored messages
List<FeedbackMessage>	messages(IFeedbackMessageFilter filter) Gets a list of messages from the page using a filter.
int	size() Gets the number of messages
int	size(IFeedbackMessageFilter filter) Gets the number of messages.
void	success(Component reporter, Serializable message) Adds a new ui message with level SUCCESS to the current messages.
List<FeedbackMessage>	toList() Retrieves all stored messages as an unmodifiable list
String	toString()
void	warn(Component reporter, Serializable message) Adds a new ui message with level WARNING to the current messages.

Methods inherited from class java.lang.Object

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

Constructor Detail

FeedbackMessages

public FeedbackMessages()

Construct.

Method Detail

add

public final void add(FeedbackMessage message)

Adds a message.

Parameters:

message - the message

add

public final void add(Component reporter,
       Serializable message,
       int level)

Adds a message

Parameters:

reporter -

message -

level -

debug

public final void debug(Component reporter,
         Serializable message)

Adds a new ui message with level DEBUG to the current messages.

Parameters:

reporter - the reporting component

message - the actual message

info

public final void info(Component reporter,
        Serializable message)

Adds a new ui message with level INFO to the current messages.

Parameters:

reporter - The reporting component

message - The actual message

success

public final void success(Component reporter,
           Serializable message)

Adds a new ui message with level SUCCESS to the current messages.

Parameters:

reporter - The reporting component

message - The actual message

warn

public final void warn(Component reporter,
        Serializable message)

Adds a new ui message with level WARNING to the current messages.

Parameters:

reporter - the reporting component

message - the actual message

error

public final void error(Component reporter,
         Serializable message)

Adds a new ui message with level ERROR to the current messages.

Parameters:

reporter - the reporting component

message - the actual message

fatal

public final void fatal(Component reporter,
         Serializable message)

Adds a new ui message with level FATAL to the current messages.

Parameters:

reporter - the reporting component

message - the actual message

clear

public final int clear()

Clears any existing messages.

Returns:

The number of messages deleted

clear

public final int clear(IFeedbackMessageFilter filter)

Clears all messages that are accepted by the filter.

Parameters:

filter - Filter for selecting messages. If null, all messages will be returned

Returns:

The number of messages deleted

hasMessage

public final boolean hasMessage(IFeedbackMessageFilter filter)

Parameters:

filter - Filter for selecting messages

Returns:

True if one or more messages matches the filter

hasMessage

public final boolean hasMessage(int level)

Checks if a message of the specified level or greater was registered.
To check for a precise level use hasMessage(IFeedbackMessageFilter) and pass it a reference to ExactLevelFeedbackMessageFilter.

Parameters:

level - The level of the message

Returns:

true if a message with the specified level or greater was registered

first

public final FeedbackMessage first()

Retrieves the first message

Returns:

message or null if none

first

public final FeedbackMessage first(int level)

Retrieves the first message that level is greater than or equal to the given level

Parameters:

level - The minimum level of the message

Returns:

a message with the same or a higher level, or null if none

iterator

public final Iterator<FeedbackMessage> iterator()

Gets an iterator over stored messages

Specified by:

iterator in interface Iterable<FeedbackMessage>

Returns:

iterator over stored messages

messages

public final List<FeedbackMessage> messages(IFeedbackMessageFilter filter)

Gets a list of messages from the page using a filter.

Parameters:

filter - Filter for selecting messages. If null, all messages will be returned

Returns:

The messages or an empty list if no messages are found

isEmpty

public final boolean isEmpty()

Gets whether there are no messages.

Returns:

True when there are no messages

size

public final int size()

Gets the number of messages

Returns:

the number of messages

size

public final int size(IFeedbackMessageFilter filter)

Gets the number of messages.

Parameters:

filter - Filter for counting messages. If null, the count of all messages will be returned

Returns:

the number of messages

toString

public String toString()

Overrides:

toString in class Object

See Also:

Object.toString()

toList

public List<FeedbackMessage> toList()

Retrieves all stored messages as an unmodifiable list

Returns:

stored messages as unmodifiable list

detach

public void detach()

Detaches each stored message