Package it.tidalwave.util.ui

Class UserNotification

java.lang.Object

it.tidalwave.util.ui.UserNotification

Direct Known Subclasses:

UserNotificationWithFeedback

@Immutable
public class UserNotification
extends Object

Version:

$Id$

Author:

Fabrizio Giudici

Field Summary

Fields

Modifier and Type	Field	Description
protected String	caption
protected String	text

Constructor Summary

Constructors

Constructor	Description
UserNotification()

Method Summary

Modifier and Type	Method	Description
static UserNotification	notification()	Creates a notification with empty caption and text.
UserNotification	withCaption(Class<?> bundleClass, String resourceName, Object... params)	Associates a caption to the notification, retrieved from a resource bundle.
UserNotification	withCaption(String caption)	Associates a caption to the notification.
UserNotification	withText(Class<?> bundleClass, String resourceName, Object... params)	Associates a text to the notification, retrieved from a resource bundle.
UserNotification	withText(String text)	Associates a text to the notification.

Methods inherited from class java.lang.Object

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

Field Detail

text

protected final String text

caption

protected final String caption

Constructor Detail

UserNotification

public UserNotification()

Method Detail

notification

@Nonnull
public static UserNotification notification()

Creates a notification with empty caption and text.

Returns:

the notification

withCaption

@Nonnull
public UserNotification withCaption(@Nonnull
                                    String caption)

Associates a caption to the notification.

Parameters:

caption - the caption

Returns:

the notification

withCaption

@Nonnull
public UserNotification withCaption(@Nonnull
                                    Class<?> bundleClass,
                                    @Nonnull
                                    String resourceName,
                                    @Nonnull
                                    Object... params)

Associates a caption to the notification, retrieved from a resource bundle.

Parameters:

bundleClass - the class where to search the resource bundle from

resourceName - the resource name of the caption in the bundle

params - some (optional) parameters to the resource

Returns:

the notification

withText

@Nonnull
public UserNotification withText(@Nonnull
                                 String text)

Associates a text to the notification.

Parameters:

text - the text

Returns:

the notification

withText

@Nonnull
public UserNotification withText(@Nonnull
                                 Class<?> bundleClass,
                                 @Nonnull
                                 String resourceName,
                                 @Nonnull
                                 Object... params)

Associates a text to the notification, retrieved from a resource bundle.

Parameters:

bundleClass - the class where to search the resource bundle from

resourceName - the resource name of the text in the bundle

params - some (optional) parameters to the resource

Returns:

the notification