Package jakarta.portlet.filter

Class PortletParametersWrapper

java.lang.Object

jakarta.portlet.filter.PortletParametersWrapper

All Implemented Interfaces:

PortletParameters

Direct Known Subclasses:

ActionParametersWrapper, MutablePortletParametersWrapper, RenderParametersWrapper, ResourceParametersWrapper

public class PortletParametersWrapper
extends Object
implements PortletParameters

The PortletParametersWrapper provides a convenient implementation of the PortletParameters 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 PortletParameters	wrapped

Constructor Summary

Constructors

Constructor	Description
PortletParametersWrapper(PortletParameters wrapped)

Method Summary

Modifier and Type	Method	Description
MutablePortletParameters	clone()	Returns a MutablePortletParameters object encapsulating a copy of the same parameters as the original object.
Set<String>	getNames()	Returns a Set of String objects containing the names of the parameters contained in this object.
String	getValue(String name)	Returns the value of a parameter as a String.
String[]	getValues(String name)	Returns an array of String objects containing all of the values the given parameter, or null if the parameter does not exist.
PortletParameters	getWrapped()	Gets the wrapped object.
boolean	isEmpty()	Returns a true if no parameters have been set.
void	setWrapped(PortletParameters wrapped)	Sets the wrapped object.
int	size()	Returns the number of parameters in this object.

Methods inherited from class java.lang.Object

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

Field Detail

wrapped

protected PortletParameters wrapped

Constructor Detail

PortletParametersWrapper

public PortletParametersWrapper(PortletParameters wrapped)

Parameters:

wrapped - the wrapped object to set.

Throws:

IllegalArgumentException - if the PortletParameters is null.

Method Detail

getWrapped

public PortletParameters getWrapped()

Gets the wrapped object.

Returns:

the wrapped object.

setWrapped

public void setWrapped(PortletParameters wrapped)

Sets the wrapped object.

Parameters:

wrapped - the wrapped object to set.

Throws:

IllegalArgumentException - if the PortletParameters is null.

getValue

public String getValue(String name)

Description copied from interface: PortletParameters

Returns the value of a parameter as a String.

Note that null is a valid parameter value. To determine whether a parameter is present, use the Set.contains(Object) method on the set returned by PortletParameters.getNames().

Only parameters targeted to the current portlet are accessible.

This method should only be used if the parameter has only one value. If the parameter might have more than one value, use PortletParameters.getValues(java.lang.String).

If this method is used with a multivalued parameter, the value returned is equal to the first value in the array returned by getValues.

Specified by:

getValue in interface PortletParameters

Parameters:

name - a String specifying the name of the parameter

Returns:

a String representing the single value of the parameter, or null.

See Also:

PortletParameters.getValues(java.lang.String), PortletParameters.getNames()

getNames

public Set<String> getNames()

Description copied from interface: PortletParameters

Returns a Set of String objects containing the names of the parameters contained in this object. Changing the Set has no effect on the originating PortletParameters object.

Only parameter names targeted to the current portlet are returned.

Specified by:

getNames in interface PortletParameters

Returns:

a Set of String objects, each String containing the name of a parameter; or an empty Set if the PortletParameters object has no parameters.

getValues

public String[] getValues(String name)

Description copied from interface: PortletParameters

Returns an array of String objects containing all of the values the given parameter, or null if the parameter does not exist.

If the parameter has a single value, the array has a length of 1.

Note that individual parameter values in the returned array may be null.

Specified by:

getValues in interface PortletParameters

Parameters:

name - a String containing the name of the parameter the value of which is requested

Returns:

an array of String objects containing the parameter values, or null if the parameter does not exist.

See Also:

PortletParameters.getValue(java.lang.String)

isEmpty

public boolean isEmpty()

Description copied from interface: PortletParameters

Returns a true if no parameters have been set.

Specified by:

isEmpty in interface PortletParameters

Returns:

true if the object contains no parameters. false otherwise

size

public int size()

Description copied from interface: PortletParameters

Returns the number of parameters in this object.

Specified by:

size in interface PortletParameters

Returns:

the number of parameters in this object

clone

public MutablePortletParameters 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

Overrides:

clone in class Object

Returns:

Mutable clone of PortletParameters object