Top Description Constructors Methods
javax.portlet.filter

public Class RenderResponseWrapper

extends MimeResponseWrapper
implements RenderResponse
Class Inheritance
All Implemented Interfaces
javax.portlet.RenderResponse, javax.portlet.MimeResponse, javax.portlet.PortletResponse
Imports
java.util.Collection, javax.portlet.PortletMode, .RenderResponse
The RenderResponseWrapper provides a convenient implementation of the RenderResponse 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
RenderResponse

Constructor Summary

AccessConstructor and Description
public
RenderResponseWrapper(RenderResponse
the event response to wrap
response)

Creates an RenderResponse adaptor wrapping the given response object.

Method Summary

Modifier and TypeMethod and Description
public RenderResponse

Returns:

the wrapped response
getResponse()

Overrides javax.portlet.filter.MimeResponseWrapper.getResponse.

Return the wrapped response object.
public void
setNextPossiblePortletModes(Collection<? extends PortletMode>
Enumeration of objects of type PortletMode or any subtype of PortletMode with the next possible portlet modes that the make sense from the portlet point of view, must not be null or an empty enumeration.
portletModes)

Implements javax.portlet.RenderResponse.setNextPossiblePortletModes.

This method allows the portlet to tell the portal the next possible portlet modes that the make sense from the portlet point of view.
public void
setResponse(RenderResponse
the response to set
response)

Sets the response object being wrapped.

public void
setTitle(String
portlet title as text String or resource URI
title)

Implements javax.portlet.RenderResponse.setTitle.

Deprecated
This method sets the title of the portlet.
Inherited from javax.portlet.filter.MimeResponseWrapper:
createActionURLcreateActionURLcreateRenderURLcreateRenderURLcreateResourceURLflushBuffergetBufferSizegetCacheControlgetCharacterEncodinggetContentTypegetLocalegetPortletOutputStreamgetWriterisCommittedresetresetBuffersetBufferSizesetContentTypesetResponse

Constructor Detail

RenderResponseWrapperback to summary
public RenderResponseWrapper(RenderResponse response)

Creates an RenderResponse adaptor wrapping the given response object.

Parameters
response:RenderResponse

the event response to wrap

Exceptions
IllegalArgumentException:
if the response is null

Method Detail

getResponseback to summary
public RenderResponse getResponse()

Overrides javax.portlet.filter.MimeResponseWrapper.getResponse.

Return the wrapped response object.

Returns:RenderResponse

the wrapped response

setNextPossiblePortletModesback to summary
public void setNextPossiblePortletModes(Collection<? extends PortletMode> portletModes)

Implements javax.portlet.RenderResponse.setNextPossiblePortletModes.

Doc from javax.portlet.RenderResponse.setNextPossiblePortletModes.

This method allows the portlet to tell the portal the next possible portlet modes that the make sense from the portlet point of view.

If set, the portal should honor these enumeration of portlet modes and only provide the end user with choices to the provided portlet modes or a subset of these modes based on access control considerations.

If the portlet does not set any next possible portlet modes the default is that all portlet modes that the portlet has defined supporting in the portlet deployment descriptor are meaningful new portlet modes.

Parameters
portletModes:Collection<? extends PortletMode>

Enumeration of objects of type PortletMode or any subtype of PortletMode with the next possible portlet modes that the make sense from the portlet point of view, must not be null or an empty enumeration.

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

Sets the response object being wrapped.

Parameters
response:RenderResponse

the response to set

Exceptions
IllegalArgumentException:
if the response is null.
setTitleback to summary
public void setTitle(String title)

Implements javax.portlet.RenderResponse.setTitle.

Doc from javax.portlet.RenderResponse.setTitle.

Deprecated

This method sets the title of the portlet.

The value can be a text String

Parameters
title:String

portlet title as text String or resource URI

Annotations
@Deprecated
@Override