Package jakarta.portlet.filter

Class EventResponseWrapper

java.lang.Object

jakarta.portlet.filter.PortletResponseWrapper

jakarta.portlet.filter.StateAwareResponseWrapper

jakarta.portlet.filter.EventResponseWrapper

All Implemented Interfaces:

EventResponse, Mutable, MutableRenderState, PortletResponse, RenderState, StateAwareResponse

public class EventResponseWrapper
extends StateAwareResponseWrapper
implements EventResponse

The EventResponseWrapper provides a convenient implementation of the EventResponse interface that can be subclassed by developers. This class implements the Wrapper or Decorator pattern. Methods default to calling through to the wrapped response object.

Since:

2.0

See Also:

EventResponse

Constructor Summary

Constructors

Constructor	Description
EventResponseWrapper(EventResponse response)	Creates an EventResponse adaptor wrapping the given response object.

Method Summary

Modifier and Type	Method	Description
EventResponse	getResponse()	Return the wrapped response object.
void	setRenderParameters(EventRequest request)	Deprecated.
void	setResponse(EventResponse response)	Sets the response object being wrapped.

Methods inherited from class jakarta.portlet.filter.StateAwareResponseWrapper

getPortletMode, getRenderParameterMap, getRenderParameters, getWindowState, removePublicRenderParameter, setEvent, setEvent, setPortletMode, setRenderParameter, setRenderParameter, setRenderParameters, setResponse, setWindowState

Methods inherited from class jakarta.portlet.filter.PortletResponseWrapper

addProperty, addProperty, addProperty, createElement, encodeURL, getNamespace, getProperty, getPropertyNames, getPropertyValues, setProperty, setResponse

Methods inherited from class java.lang.Object

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

Methods inherited from interface jakarta.portlet.MutableRenderState

getRenderParameters, setPortletMode, setWindowState

Methods inherited from interface jakarta.portlet.PortletResponse

addProperty, addProperty, addProperty, createElement, encodeURL, getNamespace, getProperty, getPropertyNames, getPropertyValues, setProperty

Methods inherited from interface jakarta.portlet.RenderState

getPortletMode, getWindowState

Methods inherited from interface jakarta.portlet.StateAwareResponse

getRenderParameterMap, removePublicRenderParameter, setEvent, setEvent, setRenderParameter, setRenderParameter, setRenderParameters

Constructor Detail

EventResponseWrapper

public EventResponseWrapper(EventResponse response)

Creates an EventResponse adaptor wrapping the given response object.

Parameters:

response - the event response to wrap

Throws:

IllegalArgumentException - if the response is null

Method Detail

getResponse

public EventResponse getResponse()

Return the wrapped response object.

Overrides:

getResponse in class StateAwareResponseWrapper

Returns:

the wrapped response

setResponse

public void setResponse(EventResponse response)

Sets the response object being wrapped.

Parameters:

response - the response to set

Throws:

IllegalArgumentException - if the response is null.

setRenderParameters

@Deprecated
public void setRenderParameters(EventRequest request)

Deprecated.

Description copied from interface: EventResponse

Maintain the current render parameters of the request for the response.

All previously set render parameters are cleared.

These parameters will be accessible in all subsequent render calls via the PortletRequest.getParameter call until a new request is targeted to the portlet.

The given parameters do not need to be encoded prior to calling this method.

Specified by:

setRenderParameters in interface EventResponse

Parameters:

request - The request the portlet has been provided with by the portlet container for the current processEvent call, must not be null.