wicket.feedback
Class FeedbackMessages

java.lang.Object
  extended by wicket.feedback.FeedbackMessages
All Implemented Interfaces:
java.io.Serializable

public final class FeedbackMessages
extends java.lang.Object
implements java.io.Serializable

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

Author:
Eelco Hillenius, Jonathan Locke
See Also:
Serialized Form

Constructor Summary
FeedbackMessages()
          Package local constructor; clients are not allowed to create instances as this class is managed by the framework.
FeedbackMessages(java.util.List messagesList)
          Call this constructor if you want to replace the internal store with another implemention then the default (ArrayList).
 
Method Summary
 void add(Component reporter, java.lang.String message, int level)
          Adds a message
 void clear()
          Clears any existing messages
 void clearRendered()
          Removes messages that have been rendered
 void debug(Component reporter, java.lang.String message)
          Adds a new ui message with level DEBUG to the current messages.
 void error(Component reporter, java.lang.String message)
          Adds a new ui message with level ERROR to the current messages.
 void fatal(Component reporter, java.lang.String message)
          Adds a new ui message with level FATAL to the current messages.
 boolean hasErrorMessageFor(Component component)
          Convenience method that looks up whether the given component registered a message with this list with the level ERROR.
 boolean hasMessage(IFeedbackMessageFilter filter)
           
 boolean hasMessageFor(Component component)
          Looks up whether the given component registered a message with this list.
 boolean hasMessageFor(Component component, int level)
          Looks up whether the given component registered a message with this list with the given level.
 void info(Component reporter, java.lang.String message)
          Adds a new ui message with level INFO to the current messages.
 boolean isEmpty()
          Gets whether there are no messages.
 java.util.Iterator iterator()
          Gets an iterator over stored messages
 FeedbackMessage messageForComponent(Component component)
          Looks up a message for the given component.
 java.util.List messages(IFeedbackMessageFilter filter)
          Gets a list of messages from the page using a filter.
 int size()
          Gets the number of messages
 java.lang.String toString()
           
 void trimToSize()
          Frees any unnecessary internal storage
 void warn(Component reporter, java.lang.String 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()
Package local constructor; clients are not allowed to create instances as this class is managed by the framework.

Parameters:
sessionStored - whether or not this object is stored in session

FeedbackMessages

public FeedbackMessages(java.util.List messagesList)
Call this constructor if you want to replace the internal store with another implemention then the default (ArrayList). This could be a CopyOnWriteArrayList if this feedbackmessages instance is used by multiply threads.

Parameters:
messagesList -
Method Detail

clear

public final void clear()
Clears any existing messages


size

public final int size()
Gets the number of messages

Returns:
the number of messages

clearRendered

public final void clearRendered()
Removes messages that have been rendered


debug

public final void debug(Component reporter,
                        java.lang.String message)
Adds a new ui message with level DEBUG to the current messages.

Parameters:
reporter - the reporting component
message - the actual message

error

public final void error(Component reporter,
                        java.lang.String 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,
                        java.lang.String message)
Adds a new ui message with level FATAL to the current messages.

Parameters:
reporter - the reporting component
message - the actual message

hasErrorMessageFor

public final boolean hasErrorMessageFor(Component component)
Convenience method that looks up whether the given component registered a message with this list with the level ERROR.

Parameters:
component - the component to look up whether it registered a message
Returns:
whether the given component registered a message with this list with level ERROR

hasMessage

public final boolean hasMessage(IFeedbackMessageFilter filter)
Parameters:
filter - Filter for selecting messages
Returns:
True if one or more messages matches the filter

hasMessageFor

public final boolean hasMessageFor(Component component)
Looks up whether the given component registered a message with this list.

Parameters:
component - the component to look up whether it registered a message
Returns:
whether the given component registered a message with this list

hasMessageFor

public final boolean hasMessageFor(Component component,
                                   int level)
Looks up whether the given component registered a message with this list with the given level.

Parameters:
component - The component to look up whether it registered a message
level - The level of the message
Returns:
Whether the given component registered a message with this list with the given level

info

public final void info(Component reporter,
                       java.lang.String message)
Adds a new ui message with level INFO to the current messages.

Parameters:
reporter - The reporting component
message - The actual message

isEmpty

public final boolean isEmpty()
Gets whether there are no messages.

Returns:
True when there are no messages

messageForComponent

public final FeedbackMessage messageForComponent(Component component)
Looks up a message for the given component.

Parameters:
component - the component to look up the message for
Returns:
the message that is found for the given component (first match) or null if none was found

messages

public final java.util.List messages(IFeedbackMessageFilter filter)
Gets a list of messages from the page using a filter.

Parameters:
filter - Filter for selecting messages
Returns:
The messages or an empty list if no messages are found

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object
See Also:
Object.toString()

warn

public final void warn(Component reporter,
                       java.lang.String message)
Adds a new ui message with level WARNING to the current messages.

Parameters:
reporter - the reporting component
message - the actual message

add

public final void add(Component reporter,
                      java.lang.String message,
                      int level)
Adds a message

Parameters:
reporter -
message -
level -

iterator

public final java.util.Iterator iterator()
Gets an iterator over stored messages

Returns:
iterator over stored messages

trimToSize

public final void trimToSize()
Frees any unnecessary internal storage



Copyright © 2004-2007 Wicket developers. All Rights Reserved.