org.apache.wicket.feedback
Class FeedbackMessage

java.lang.Object
  extended by org.apache.wicket.feedback.FeedbackMessage
All Implemented Interfaces:
Serializable, IClusterable, IDetachable

public class FeedbackMessage
extends Object
implements IClusterable, IDetachable

Represents a generic message meant for the end-user/ pages.

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

Field Summary
static int DEBUG
          Constant for debug level.
static int ERROR
          Constant for error level.
static int FATAL
          Constant for fatal level.
static int INFO
          Constant for info level.
static int UNDEFINED
          Constant for an undefined level; note that components might decide not to render anything when this level is used.
static int WARNING
          Constant for warning level.
 
Constructor Summary
FeedbackMessage(Component reporter, Serializable message, int level)
          Construct using fields.
 
Method Summary
 void detach()
          Detaches model after use.
 int getLevel()
          Gets the message level; can be used by rendering components.
 String getLevelAsString()
          Gets the current level as a String
 Serializable getMessage()
          Gets the actual message.
 Component getReporter()
          Gets the reporting component.
 boolean isDebug()
          Gets whether the current level is DEBUG or up.
 boolean isError()
          Gets whether the current level is ERROR or up.
 boolean isFatal()
          Gets whether the current level is FATAL or up.
 boolean isInfo()
          Gets whether the current level is INFO or up.
 boolean isLevel(int level)
          Returns whether this level is greater than or equal to the given level.
 boolean isRendered()
          Gets whether or not this message has been rendered
 boolean isUndefined()
          Gets whether the current level is UNDEFINED.
 boolean isWarning()
          Gets whether the current level is WARNING or up.
 void markRendered()
          Marks this message as rendered.
 String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

DEBUG

public static final int DEBUG
Constant for debug level.

See Also:
Constant Field Values

ERROR

public static final int ERROR
Constant for error level.

See Also:
Constant Field Values

FATAL

public static final int FATAL
Constant for fatal level.

See Also:
Constant Field Values

INFO

public static final int INFO
Constant for info level.

See Also:
Constant Field Values

UNDEFINED

public static final int UNDEFINED
Constant for an undefined level; note that components might decide not to render anything when this level is used.

See Also:
Constant Field Values

WARNING

public static final int WARNING
Constant for warning level.

See Also:
Constant Field Values
Constructor Detail

FeedbackMessage

public FeedbackMessage(Component reporter,
                       Serializable message,
                       int level)
Construct using fields.

Parameters:
reporter - The message reporter
message - The actual message. Must not be null.
level - The level of the message
Method Detail

isRendered

public final boolean isRendered()
Gets whether or not this message has been rendered

Returns:
true if this message has been rendered, false otherwise

markRendered

public final void markRendered()
Marks this message as rendered.


getLevel

public final int getLevel()
Gets the message level; can be used by rendering components. Note that what actually happens with the level indication is totally up to the components that render feedback messages.

Returns:
The message level indicator.

getLevelAsString

public String getLevelAsString()
Gets the current level as a String

Returns:
The current level as a String

getMessage

public final Serializable getMessage()
Gets the actual message.

Returns:
the message.

getReporter

public final Component getReporter()
Gets the reporting component.

Returns:
the reporting component.

isDebug

public final boolean isDebug()
Gets whether the current level is DEBUG or up.

Returns:
whether the current level is DEBUG or up.

isError

public final boolean isError()
Gets whether the current level is ERROR or up.

Returns:
whether the current level is ERROR or up.

isFatal

public final boolean isFatal()
Gets whether the current level is FATAL or up.

Returns:
whether the current level is FATAL or up.

isInfo

public final boolean isInfo()
Gets whether the current level is INFO or up.

Returns:
whether the current level is INFO or up.

isLevel

public final boolean isLevel(int level)
Returns whether this level is greater than or equal to the given level.

Parameters:
level - the level
Returns:
whether this level is greater than or equal to the given level

isUndefined

public final boolean isUndefined()
Gets whether the current level is UNDEFINED.

Returns:
whether the current level is UNDEFINED.

isWarning

public final boolean isWarning()
Gets whether the current level is WARNING or up.

Returns:
whether the current level is WARNING or up.

toString

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

detach

public void detach()
Detaches model after use. This is generally used to null out transient references that can be re-attached later.

Specified by:
detach in interface IDetachable


Copyright © 2004-2011 Apache Software Foundation. All Rights Reserved.