Package jakarta.portlet.filter

Class ActionURLWrapper

java.lang.Object

jakarta.portlet.filter.RenderStateWrapper

jakarta.portlet.filter.BaseURLWrapper

jakarta.portlet.filter.PortletURLWrapper

jakarta.portlet.filter.ActionURLWrapper

All Implemented Interfaces:

ActionURL, BaseURL, Mutable, MutableRenderState, PortletURL, RenderState

public class ActionURLWrapper
extends PortletURLWrapper
implements ActionURL

The ActionURLWrapper provides a convenient implementation of the ActionURL 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.RenderStateWrapper

wrapped

Constructor Summary

Constructors

Constructor	Description
ActionURLWrapper(ActionURL wrapped)

Method Summary

Modifier and Type	Method	Description
MutableActionParameters	getActionParameters()	Gets the action parameter values set for this URL.
ActionURL	getWrapped()	Gets the wrapped object.
void	setWrapped(ActionURL wrapped)	Sets the wrapped object.

Methods inherited from class jakarta.portlet.filter.PortletURLWrapper

getRenderParameters, removePublicRenderParameter, setBeanParameter, setPortletMode, setWindowState, setWrapped

Methods inherited from class jakarta.portlet.filter.BaseURLWrapper

addProperty, append, append, getParameterMap, setParameter, setParameter, setParameters, setProperty, setSecure, setWrapped, toString, write, write

Methods inherited from class jakarta.portlet.filter.RenderStateWrapper

getPortletMode, getWindowState, setWrapped

Methods inherited from class java.lang.Object

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

Methods inherited from interface jakarta.portlet.BaseURL

addProperty, append, append, getParameterMap, setParameter, setParameter, setParameters, setProperty, setSecure, toString, write, write

Methods inherited from interface jakarta.portlet.MutableRenderState

getRenderParameters, setPortletMode, setWindowState

Methods inherited from interface jakarta.portlet.PortletURL

removePublicRenderParameter, setBeanParameter

Methods inherited from interface jakarta.portlet.RenderState

getPortletMode, getWindowState

Constructor Detail

ActionURLWrapper

public ActionURLWrapper(ActionURL wrapped)

Parameters:

wrapped - the wrapped object to set.

Throws:

IllegalArgumentException - if the ActionURL is null.

Method Detail

getWrapped

public ActionURL getWrapped()

Gets the wrapped object.

Overrides:

getWrapped in class PortletURLWrapper

Returns:

the wrapped object.

setWrapped

public void setWrapped(ActionURL wrapped)

Sets the wrapped object.

Parameters:

wrapped - the wrapped object to set.

Throws:

IllegalArgumentException - if the ActionURL is null.

getActionParameters

public MutableActionParameters getActionParameters()

Description copied from interface: ActionURL

Gets the action parameter values set for this URL.

Action parameters are additional portlet parameters added to the URL that extend the state information provided by the render parameters.

Initially the returned object is empty.

Modifying the parameter values encapsulated by the returned object directly modifies the action parameters applied to the URL.

PortletParameters provides a description of the parameter concept.

Specified by:

getActionParameters in interface ActionURL

Returns:

a MutableActionParameters object representing the action parameters.

See Also:

ActionParameters, MutableActionParameters