Top Description Fields Constructors Methods
javax.portlet.filter

public Class RenderParametersWrapper

extends PortletParametersWrapper
implements RenderParameters
Class Inheritance
All Implemented Interfaces
javax.portlet.RenderParameters, javax.portlet.PortletParameters
Imports
javax.portlet.MutableRenderParameters, .RenderParameters
The RenderParametersWrapper provides a convenient implementation of the RenderParameters 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

Inherited from javax.portlet.filter.PortletParametersWrapper:
wrapped

Constructor Summary

AccessConstructor and Description
public
RenderParametersWrapper(RenderParameters
the wrapped object to set.
wrapped)

Method Summary

Modifier and TypeMethod and Description
public MutableRenderParameters
clone()

Overrides javax.portlet.filter.PortletParametersWrapper.clone.

Implements javax.portlet.RenderParameters.clone, javax.portlet.PortletParameters.clone.

Returns a MutableRenderParameters object encapsulating a copy of the same parameters as the original object.
public RenderParameters

Returns:

the wrapped object.
getWrapped()

Overrides javax.portlet.filter.PortletParametersWrapper.getWrapped.

Gets the wrapped object.
public boolean
isPublic(String
the parameter name
name)

Implements javax.portlet.RenderParameters.isPublic.

Returns a boolean value indicating whether the given parameter name represents a public render parameter.
public void
setWrapped(RenderParameters
the wrapped object to set.
wrapped)

Sets the wrapped object.

Inherited from javax.portlet.filter.PortletParametersWrapper:
getNamesgetValuegetValuesisEmptysetWrappedsize

Constructor Detail

RenderParametersWrapperback to summary
public RenderParametersWrapper(RenderParameters wrapped)
Parameters
wrapped:RenderParameters

the wrapped object to set.

Exceptions
IllegalArgumentException:
if the RenderParameters is null.

Method Detail

cloneback to summary
public MutableRenderParameters clone()

Overrides javax.portlet.filter.PortletParametersWrapper.clone.

Implements javax.portlet.RenderParameters.clone, javax.portlet.PortletParameters.clone.

Doc from javax.portlet.RenderParameters.clone.

Returns a MutableRenderParameters object encapsulating a copy of the same parameters as the original object. Changing a mutable copy will not influence the source object.
Returns:MutableRenderParameters

Mutable clone of RenderParameters object

Annotations
@Override
getWrappedback to summary
public RenderParameters getWrapped()

Overrides javax.portlet.filter.PortletParametersWrapper.getWrapped.

Gets the wrapped object.

Returns:RenderParameters

the wrapped object.

isPublicback to summary
public boolean isPublic(String name)

Implements javax.portlet.RenderParameters.isPublic.

Doc from javax.portlet.RenderParameters.isPublic.

Returns a boolean value indicating whether the given parameter name represents a public render parameter. Note that if true is returned, it does not mean that a public render parameter value is set.
Parameters
name:String

the parameter name

Returns:boolean

true if the given parameter name represents a public render parameter. false otherwise

Annotations
@Override
setWrappedback to summary
public void setWrapped(RenderParameters wrapped)

Sets the wrapped object.

Parameters
wrapped:RenderParameters

the wrapped object to set.

Exceptions
IllegalArgumentException:
if the RenderParameters is null.