com.liferay.portlet.internal

Class BaseMutablePortletParameters<T extends javax.portlet.MutablePortletParameters>

Object

com.liferay.portlet.internal.BasePortletParametersImpl<T>

com.liferay.portlet.internal.BaseMutablePortletParameters<T>

All Implemented Interfaces:

LiferayMutablePortletParameters, javax.portlet.Mutable, javax.portlet.MutablePortletParameters, javax.portlet.PortletParameters

Direct Known Subclasses:

MutableActionParametersImpl, MutableRenderParametersImpl, MutableResourceParametersImpl

public abstract class BaseMutablePortletParameters<T extends javax.portlet.MutablePortletParameters>
extends BasePortletParametersImpl<T>
implements LiferayMutablePortletParameters

Author:

Neil Griffin

Field Summary

Fields inherited from interface com.liferay.portlet.internal.LiferayMutablePortletParameters

NULL_PARAM_VALUE

Constructor Summary

Constructors

Constructor and Description
BaseMutablePortletParameters(Map<String,String[]> parameterMap, Function<Map<String,String[]>,T> mutablePortletParametersCreator)

Method Summary

Modifier and Type	Method and Description
javax.portlet.MutablePortletParameters	add(javax.portlet.PortletParameters portletParameters)
void	clear()
boolean	isMutated() Returns true if the state of the portlet parameters has changed.
boolean	removeParameter(String name)
javax.portlet.MutablePortletParameters	set(javax.portlet.PortletParameters portletParameters)
String	setValue(String name, String value)
String	setValue(String name, String value, boolean append) Sets the parameter value.
String[]	setValues(String name, String... values)
String[]	setValues(String name, String[] values, boolean append) Sets the parameter values.

Methods inherited from class com.liferay.portlet.internal.BasePortletParametersImpl

clone, deepCopyMap, getNames, getParameterMap, getValue, getValues, isEmpty, size

Methods inherited from class Object

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

Methods inherited from interface javax.portlet.MutablePortletParameters

getNames

Methods inherited from interface javax.portlet.PortletParameters

clone, getValue, getValues, isEmpty, size

Constructor Detail

BaseMutablePortletParameters

public BaseMutablePortletParameters(Map<String,String[]> parameterMap,
                                    Function<Map<String,String[]>,T> mutablePortletParametersCreator)

Method Detail

add

public javax.portlet.MutablePortletParameters add(javax.portlet.PortletParameters portletParameters)

Specified by:

add in interface javax.portlet.MutablePortletParameters

clear

public void clear()

Specified by:

clear in interface javax.portlet.MutablePortletParameters

isMutated

public boolean isMutated()

Description copied from interface: LiferayMutablePortletParameters

Returns true if the state of the portlet parameters has changed.

Specified by:

isMutated in interface LiferayMutablePortletParameters

Returns:

true if the state has changed; false otherwise

removeParameter

public boolean removeParameter(String name)

Specified by:

removeParameter in interface javax.portlet.MutablePortletParameters

set

public javax.portlet.MutablePortletParameters set(javax.portlet.PortletParameters portletParameters)

Specified by:

set in interface javax.portlet.MutablePortletParameters

setValue

public String setValue(String name,
                       String value)

Specified by:

setValue in interface javax.portlet.MutablePortletParameters

setValue

public String setValue(String name,
                       String value,
                       boolean append)

Description copied from interface: LiferayMutablePortletParameters

Sets the parameter value. An IllegalArgumentException is thrown if the name is null.

Specified by:

setValue in interface LiferayMutablePortletParameters

Parameters:

name - the parameter's name

value - the parameter's value. If null, the parameter is removed.

append - whether the new value is appended to any existing values for the parameter. If this is false, any existing values are overwritten with the new value.

Returns:

the parameter value prior to setting

setValues

public String[] setValues(String name,
                          String... values)

Specified by:

setValues in interface javax.portlet.MutablePortletParameters

setValues

public String[] setValues(String name,
                          String[] values,
                          boolean append)

Description copied from interface: LiferayMutablePortletParameters

Sets the parameter values. An IllegalArgumentException is thrown if the name is null.

Specified by:

setValues in interface LiferayMutablePortletParameters

Parameters:

name - the parameter's name

values - the parameter's values. If null, the parameter is removed.

append - whether the new values are appended to any existing values for the parameter. If this is false, any existing values are overwritten with the new values.

Returns:

the parameter values prior to setting