Top Description Constructors Methods
javax.portlet.filter

public Class MutableRenderParametersWrapper

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

Constructor Summary

AccessConstructor and Description
public
MutableRenderParametersWrapper(MutableRenderParameters
the wrapped object to set.
wrapped)

Method Summary

Modifier and TypeMethod and Description
public void
clearPrivate()

Implements javax.portlet.MutableRenderParameters.clearPrivate.

Clears all private parameters that are present in the MutableRenderParameters object.
public void
clearPublic()

Implements javax.portlet.MutableRenderParameters.clearPublic.

Clears all public parameters that are present in the MutableRenderParameters object.
public MutableRenderParameters
clone()

Overrides javax.portlet.filter.PortletParametersWrapper.clone.

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

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

Returns:

the wrapped object.
getWrapped()

Overrides javax.portlet.filter.MutablePortletParametersWrapper.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(MutableRenderParameters
the wrapped object to set.
wrapped)

Sets the wrapped object.

Inherited from javax.portlet.filter.MutablePortletParametersWrapper:
addclearremoveParametersetsetValuesetValuessetWrapped

Constructor Detail

MutableRenderParametersWrapperback to summary
public MutableRenderParametersWrapper(MutableRenderParameters wrapped)
Parameters
wrapped:MutableRenderParameters

the wrapped object to set.

Exceptions
IllegalArgumentException:
if the MutableRenderParameters is null.

Method Detail

clearPrivateback to summary
public void clearPrivate()

Implements javax.portlet.MutableRenderParameters.clearPrivate.

Doc from javax.portlet.MutableRenderParameters.clearPrivate.

Clears all private parameters that are present in the MutableRenderParameters object.
Annotations
@Override
clearPublicback to summary
public void clearPublic()

Implements javax.portlet.MutableRenderParameters.clearPublic.

Doc from javax.portlet.MutableRenderParameters.clearPublic.

Clears all public parameters that are present in the MutableRenderParameters object.
Annotations
@Override
cloneback to summary
public MutableRenderParameters clone()

Overrides javax.portlet.filter.PortletParametersWrapper.clone.

Implements javax.portlet.PortletParameters.clone, javax.portlet.RenderParameters.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 MutableRenderParameters getWrapped()

Overrides javax.portlet.filter.MutablePortletParametersWrapper.getWrapped.

Gets the wrapped object.

Returns:MutableRenderParameters

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(MutableRenderParameters wrapped)

Sets the wrapped object.

Parameters
wrapped:MutableRenderParameters

the wrapped object to set.

Exceptions
IllegalArgumentException:
if the MutableRenderParameters is null.