Package jakarta.portlet.filter

Class RenderStateWrapper

java.lang.Object

jakarta.portlet.filter.RenderStateWrapper

All Implemented Interfaces:

RenderState

Direct Known Subclasses:

BaseURLWrapper, MutableRenderStateWrapper, PortletRequestWrapper

public class RenderStateWrapper
extends Object
implements RenderState

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

Fields

Modifier and Type	Field	Description
protected RenderState	wrapped

Constructor Summary

Constructors

Constructor	Description
RenderStateWrapper(RenderState wrapped)

Method Summary

Modifier and Type	Method	Description
PortletMode	getPortletMode()	Returns the current portlet mode of the portlet.
RenderParameters	getRenderParameters()	Gets the render parameters.
WindowState	getWindowState()	Returns the current window state of the portlet.
RenderState	getWrapped()	Gets the wrapped object.
void	setWrapped(RenderState wrapped)	Sets the wrapped object.

Methods inherited from class java.lang.Object

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

Field Detail

wrapped

protected RenderState wrapped

Constructor Detail

RenderStateWrapper

public RenderStateWrapper(RenderState wrapped)

Parameters:

wrapped - the wrapped object to set.

Throws:

IllegalArgumentException - if the RenderState is null.

Method Detail

getWrapped

public RenderState getWrapped()

Gets the wrapped object.

Returns:

the wrapped object.

setWrapped

public void setWrapped(RenderState wrapped)

Sets the wrapped object.

Parameters:

wrapped - the wrapped object to set.

Throws:

IllegalArgumentException - if the RenderState is null.

getRenderParameters

public RenderParameters getRenderParameters()

Description copied from interface: RenderState

Gets the render parameters.

Specified by:

getRenderParameters in interface RenderState

Returns:

an immutable RenderParameters object representing the private and public render parameters

See Also:

PortletParameters, RenderParameters

getPortletMode

public PortletMode getPortletMode()

Description copied from interface: RenderState

Returns the current portlet mode of the portlet.

Specified by:

getPortletMode in interface RenderState

Returns:

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

See Also:

PortletMode

getWindowState

public WindowState getWindowState()

Description copied from interface: RenderState

Returns the current window state of the portlet.

Specified by:

getWindowState in interface RenderState

Returns:

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

See Also:

WindowState