Package jakarta.portlet.filter

Class MutableRenderParametersWrapper

java.lang.Object

jakarta.portlet.filter.PortletParametersWrapper

jakarta.portlet.filter.MutablePortletParametersWrapper

jakarta.portlet.filter.MutableRenderParametersWrapper

All Implemented Interfaces:

Mutable, MutablePortletParameters, MutableRenderParameters, PortletParameters, RenderParameters

public class MutableRenderParametersWrapper
extends MutablePortletParametersWrapper
implements 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

Field Summary

Fields inherited from class jakarta.portlet.filter.PortletParametersWrapper

wrapped

Constructor Summary

Constructors

Constructor	Description
MutableRenderParametersWrapper(MutableRenderParameters wrapped)

Method Summary

Modifier and Type	Method	Description
void	clearPrivate()	Clears all private parameters that are present in the MutableRenderParameters object.
void	clearPublic()	Clears all public parameters that are present in the MutableRenderParameters object.
MutableRenderParameters	clone()	Returns a MutablePortletParameters object encapsulating a copy of the same parameters as the original object.
MutableRenderParameters	getWrapped()	Gets the wrapped object.
boolean	isPublic(String name)	Returns a boolean value indicating whether the given parameter name represents a public render parameter.
void	setWrapped(MutableRenderParameters wrapped)	Sets the wrapped object.

Methods inherited from class jakarta.portlet.filter.MutablePortletParametersWrapper

add, clear, removeParameter, set, setValue, setValues, setWrapped

Methods inherited from class jakarta.portlet.filter.PortletParametersWrapper

getNames, getValue, getValues, isEmpty, setWrapped, size

Methods inherited from class java.lang.Object

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

Methods inherited from interface jakarta.portlet.MutablePortletParameters

add, clear, getNames, removeParameter, set, setValue, setValues

Methods inherited from interface jakarta.portlet.PortletParameters

getValue, getValues, isEmpty, size

Constructor Detail

MutableRenderParametersWrapper

public MutableRenderParametersWrapper(MutableRenderParameters wrapped)

Parameters:

wrapped - the wrapped object to set.

Throws:

IllegalArgumentException - if the MutableRenderParameters is null.

Method Detail

getWrapped

public MutableRenderParameters getWrapped()

Gets the wrapped object.

Overrides:

getWrapped in class MutablePortletParametersWrapper

Returns:

the wrapped object.

setWrapped

public void setWrapped(MutableRenderParameters wrapped)

Sets the wrapped object.

Parameters:

wrapped - the wrapped object to set.

Throws:

IllegalArgumentException - if the MutableRenderParameters is null.

clone

public MutableRenderParameters clone()

Description copied from interface: PortletParameters

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

Specified by:

clone in interface PortletParameters

Specified by:

clone in interface RenderParameters

Overrides:

clone in class PortletParametersWrapper

Returns:

Mutable clone of PortletParameters object

isPublic

public boolean isPublic(String name)

Description copied from interface: RenderParameters

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.

Specified by:

isPublic in interface RenderParameters

Parameters:

name - the parameter name

Returns:

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

clearPrivate

public void clearPrivate()

Description copied from interface: MutableRenderParameters

Clears all private parameters that are present in the MutableRenderParameters object.

Specified by:

clearPrivate in interface MutableRenderParameters

clearPublic

public void clearPublic()

Description copied from interface: MutableRenderParameters

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

Specified by:

clearPublic in interface MutableRenderParameters