Top Description Fields Constructors Methods
javax.portlet.filter

public Class RenderStateWrapper

extends Object
implements RenderState
Class Inheritance
All Implemented Interfaces
javax.portlet.RenderState
Known Direct Subclasses
javax.portlet.filter.BaseURLWrapper, javax.portlet.filter.MutableRenderStateWrapper, javax.portlet.filter.PortletRequestWrapper
Imports
javax.portlet.PortletMode, .RenderState, .RenderParameters, .WindowState
The RenderStateWrapper provides a convenient implementation of the RenderState interface that can be subclassed by developers. This class implements the Wrapper or Decorator pattern. Methods default to calling through to the wrapped request object.
Since
3.0

Field Summary

Modifier and TypeField and Description
protected RenderState
wrapped

Constructor Summary

AccessConstructor and Description
public
RenderStateWrapper(RenderState
the wrapped object to set.
wrapped)

Method Summary

Modifier and TypeMethod and Description
public PortletMode
getPortletMode()

Implements javax.portlet.RenderState.getPortletMode.

Returns the current portlet mode of the portlet.
public RenderParameters
getRenderParameters()

Implements javax.portlet.RenderState.getRenderParameters.

Gets the render parameters.
public WindowState
getWindowState()

Implements javax.portlet.RenderState.getWindowState.

Returns the current window state of the portlet.
public RenderState

Returns:

the wrapped object.
getWrapped()

Gets the wrapped object.
public void
setWrapped(RenderState
the wrapped object to set.
wrapped)

Sets the wrapped object.
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

wrappedback to summary
protected RenderState wrapped

Constructor Detail

RenderStateWrapperback to summary
public RenderStateWrapper(RenderState wrapped)
Parameters
wrapped:RenderState

the wrapped object to set.

Exceptions
IllegalArgumentException:
if the RenderState is null.

Method Detail

getPortletModeback to summary
public PortletMode getPortletMode()

Implements javax.portlet.RenderState.getPortletMode.

Doc from javax.portlet.RenderState.getPortletMode.

Returns the current portlet mode of the portlet.
Returns:PortletMode

the portlet mode. If the portlet mode is not available, PortletMode#UNDEFINED is returned.

Annotations
@Override
getRenderParametersback to summary
public RenderParameters getRenderParameters()

Implements javax.portlet.RenderState.getRenderParameters.

Doc from javax.portlet.RenderState.getRenderParameters.

Gets the render parameters.
Returns:RenderParameters

an immutable RenderParameters object representing the private and public render parameters

Annotations
@Override
getWindowStateback to summary
public WindowState getWindowState()

Implements javax.portlet.RenderState.getWindowState.

Doc from javax.portlet.RenderState.getWindowState.

Returns the current window state of the portlet.
Returns:WindowState

the window state. If the window state is not available, WindowState#UNDEFINED is returned.

Annotations
@Override
getWrappedback to summary
public RenderState getWrapped()

Gets the wrapped object.
Returns:RenderState

the wrapped object.

setWrappedback to summary
public void setWrapped(RenderState wrapped)

Sets the wrapped object.
Parameters
wrapped:RenderState

the wrapped object to set.

Exceptions
IllegalArgumentException:
if the RenderState is null.