javax.portlet

Interface RenderParameters

All Superinterfaces:

PortletParameters

All Known Subinterfaces:

MutableRenderParameters

All Known Implementing Classes:

MutableRenderParametersWrapper, RenderParametersWrapper

public interface RenderParameters
extends PortletParameters

Provides access to render parameters, which make up part of the render state.

Since:

3.0

See Also:

PortletParameters, MutableRenderParameters

Method Summary

Methods

Modifier and Type	Method and Description
MutableRenderParameters	clone() Returns a MutableRenderParameters object encapsulating a copy of the same parameters as the original object.
boolean	isPublic(String name) Returns a boolean value indicating whether the given parameter name represents a public render parameter.

Methods inherited from interface javax.portlet.PortletParameters

getNames, getValue, getValues, isEmpty, size

Method Detail

clone

MutableRenderParameters 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.

Specified by:

clone in interface PortletParameters

Returns:

Mutable clone of RenderParameters object

Since:

3.0

isPublic

boolean isPublic(String name)

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 - the parameter name

Returns:

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

Throws:

IllegalArgumentException - if name is null.

Since:

3.0