Top Description Constructors Methods
javax.portlet.filter

public Class EventResponseWrapper

extends StateAwareResponseWrapper
implements EventResponse
Class Inheritance
All Implemented Interfaces
javax.portlet.EventResponse, javax.portlet.StateAwareResponse, javax.portlet.MutableRenderState, javax.portlet.Mutable, javax.portlet.RenderState, javax.portlet.PortletResponse
Imports
javax.portlet.EventRequest, .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

AccessConstructor and Description
public
EventResponseWrapper(EventResponse
the event response to wrap
response
)

Creates an EventResponse adaptor wrapping the given response object.

Method Summary

Modifier and TypeMethod and Description
public EventResponse

Returns:

the wrapped response
getResponse
()

Overrides javax.portlet.filter.StateAwareResponseWrapper.getResponse.

Return the wrapped response object.
public void
setRenderParameters(EventRequest
The request the portlet has been provided with by the portlet container for the current processEvent call, must not be null.
request
)

Implements javax.portlet.EventResponse.setRenderParameters.

Deprecated
Maintain the current render parameters of the request for the response.
public void
setResponse(EventResponse
the response to set
response
)

Sets the response object being wrapped.

Inherited from javax.portlet.filter.StateAwareResponseWrapper:
getPortletModegetRenderParameterMapgetRenderParametersgetWindowStateremovePublicRenderParametersetEventsetEventsetPortletModesetRenderParametersetRenderParametersetRenderParameterssetResponsesetWindowState

Constructor Detail

EventResponseWrapperback to summary
public EventResponseWrapper(EventResponse response)

Creates an EventResponse adaptor wrapping the given response object.

Parameters
response:EventResponse

the event response to wrap

Exceptions
IllegalArgumentException:
if the response is null

Method Detail

getResponseback to summary
public EventResponse getResponse()

Overrides javax.portlet.filter.StateAwareResponseWrapper.getResponse.

Return the wrapped response object.

Returns:EventResponse

the wrapped response

setRenderParametersback to summary
public void setRenderParameters(EventRequest request)

Implements javax.portlet.EventResponse.setRenderParameters.

Doc from javax.portlet.EventResponse.setRenderParameters.

Deprecated

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.

Parameters
request:EventRequest

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

Annotations
@Deprecated
@Override
setResponseback to summary
public void setResponse(EventResponse response)

Sets the response object being wrapped.

Parameters
response:EventResponse

the response to set

Exceptions
IllegalArgumentException:
if the response is null.