Class BaseMutablePortletParameters<T extends jakarta.portlet.MutablePortletParameters>

Object
com.liferay.portlet.internal.BasePortletParametersImpl<T>
com.liferay.portlet.internal.BaseMutablePortletParameters<T>
All Implemented Interfaces:
LiferayMutablePortletParameters, jakarta.portlet.Mutable, jakarta.portlet.MutablePortletParameters, jakarta.portlet.PortletParameters
Direct Known Subclasses:
MutableActionParametersImpl, MutableRenderParametersImpl, MutableResourceParametersImpl

public abstract class BaseMutablePortletParameters<T extends jakarta.portlet.MutablePortletParameters> extends BasePortletParametersImpl<T> implements LiferayMutablePortletParameters
Author:
Neil Griffin
  • Constructor Details

  • Method Details

    • add

      public jakarta.portlet.MutablePortletParameters add(jakarta.portlet.PortletParameters portletParameters)
      Specified by:
      add in interface jakarta.portlet.MutablePortletParameters
    • clear

      public void clear()
      Specified by:
      clear in interface jakarta.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 jakarta.portlet.MutablePortletParameters
    • set

      public jakarta.portlet.MutablePortletParameters set(jakarta.portlet.PortletParameters portletParameters)
      Specified by:
      set in interface jakarta.portlet.MutablePortletParameters
    • setValue

      public String setValue(String name, String value)
      Specified by:
      setValue in interface jakarta.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 jakarta.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