org.jasig.portlet.notice

Class NotificationResponse

java.lang.Object

org.jasig.portlet.notice.NotificationResponse

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class NotificationResponse
extends java.lang.Object
implements java.io.Serializable, java.lang.Cloneable

This class contains all the categories and errors retrieved by an INotificationService. It is also used to aggregate all the NotificationResponses from various services into a single NotificationResponse. The data from the overall NotificationResponse instance is returned to the portlet to be rendered.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static NotificationResponse	EMPTY_RESPONSE Useful for returning an empty set of notices.

Constructor Summary

Constructors

Constructor and Description
NotificationResponse()
NotificationResponse(java.util.List<NotificationCategory> categories, java.util.List<NotificationError> errors)
NotificationResponse(NotificationResponse response)

Method Summary

Modifier and Type	Method and Description
protected java.lang.Object	clone() Implements deep-copy clone.
NotificationResponse	cloneIfNotCloned() Best guess as to the reason this method exists: beans that produce fresh NotificationResponse objects (without cloning them) may safely cache them.
NotificationResponse	combine(NotificationResponse response) Combine the contents of this response with the provided response and return a new instance of NotificationResponse.
NotificationResponse	filter(java.util.function.Predicate<NotificationEntry> predicate) Return a new instance of NotificationResponse containing only NotificationEntry objects within this response that match the specified Predicate.
NotificationResponse	filterErrors(java.util.Set<java.lang.Integer> hiddenErrorKeys) Return a new instance of NotificationResponse from which the specified errors have been removed.
NotificationEntry	findNotificationEntryById(java.lang.String notificationId) Returns the NotificationEntry with the specified id, or null if not present.
java.util.List<NotificationCategory>	getCategories()
java.util.List<NotificationError>	getErrors()
void	setCategories(java.util.List<NotificationCategory> categories)
void	setErrors(java.util.List<NotificationError> errors)
int	size() Provides the total number of notifications contained in the response.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY_RESPONSE

public static final NotificationResponse EMPTY_RESPONSE

Useful for returning an empty set of notices.

Constructor Detail

NotificationResponse

public NotificationResponse()

NotificationResponse

public NotificationResponse(NotificationResponse response)

NotificationResponse

public NotificationResponse(java.util.List<NotificationCategory> categories,
                            java.util.List<NotificationError> errors)

Method Detail

getCategories

public java.util.List<NotificationCategory> getCategories()

setCategories

public void setCategories(java.util.List<NotificationCategory> categories)

getErrors

public java.util.List<NotificationError> getErrors()

setErrors

public void setErrors(java.util.List<NotificationError> errors)

findNotificationEntryById

public NotificationEntry findNotificationEntryById(java.lang.String notificationId)

Returns the NotificationEntry with the specified id, or null if not present.

combine

public NotificationResponse combine(NotificationResponse response)

Combine the contents of this response with the provided response and return a new instance of NotificationResponse. The original instances are unchanged.

Parameters:

response - A new NotificationResponse that contains data from both originals

filterErrors

public NotificationResponse filterErrors(java.util.Set<java.lang.Integer> hiddenErrorKeys)

Return a new instance of NotificationResponse from which the specified errors have been removed. The original instances are unchanged.

Parameters:

hiddenErrorKeys - set of error keys to exclude from result

filter

public NotificationResponse filter(java.util.function.Predicate<NotificationEntry> predicate)

Return a new instance of NotificationResponse containing only NotificationEntry objects within this response that match the specified Predicate. The category structure is preserved. Empty categories are removed.

size

public int size()

Provides the total number of notifications contained in the response.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

clone

protected java.lang.Object clone()
                          throws java.lang.CloneNotSupportedException

Implements deep-copy clone.

Overrides:

clone in class java.lang.Object

Throws:

java.lang.CloneNotSupportedException - Not really, but it's on the method signature we're overriding.

cloneIfNotCloned

public NotificationResponse cloneIfNotCloned()

Best guess as to the reason this method exists: beans that produce fresh NotificationResponse objects (without cloning them) may safely cache them. They need not fear that another bean will transform their copy. Beans that do clone them, however, can safely operate on a clone.