com.liferay.faces.bridge

Class BridgeURLWrapper

java.lang.Object

com.liferay.faces.bridge.BridgeURLWrapper

All Implemented Interfaces:

BridgeURL

@ConsumerType
public abstract class BridgeURLWrapper
extends java.lang.Object
implements BridgeURL

Author:

Neil Griffin

Constructor Summary

Constructors

Constructor and Description
BridgeURLWrapper()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getParameter(java.lang.String name) Returns the first value of the underlying BridgeURL.getParameterMap() with the specified name.
java.util.Map<java.lang.String,java.lang.String[]>	getParameterMap() Returns a mutable Map representing the URL parameters.
java.lang.String	getViewId() If the URL targets a Faces view, then returns the viewId.
abstract BridgeURL	getWrapped()
java.lang.String	removeParameter(java.lang.String name) Removes the entry of the underlying BridgeURL.getParameterMap() according to the specified name.
void	setParameter(java.lang.String name, java.lang.String value) Sets the value of the underlying BridgeURL.getParameterMap() according to the specified name.
void	setParameter(java.lang.String name, java.lang.String[] value) Sets the value of the underlying BridgeURL.getParameterMap() according to the specified name.
java.lang.String	toString() Returns a string-based representation of the URL.

Methods inherited from class java.lang.Object

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

Constructor Detail

BridgeURLWrapper

public BridgeURLWrapper()

Method Detail

getWrapped

public abstract BridgeURL getWrapped()

getParameter

public java.lang.String getParameter(java.lang.String name)

Description copied from interface: BridgeURL

Returns the first value of the underlying BridgeURL.getParameterMap() with the specified name.

Specified by:

getParameter in interface BridgeURL

getParameterMap

public java.util.Map<java.lang.String,java.lang.String[]> getParameterMap()

Description copied from interface: BridgeURL

Returns a mutable Map representing the URL parameters.

Specified by:

getParameterMap in interface BridgeURL

getViewId

public java.lang.String getViewId()

Description copied from interface: BridgeURL

If the URL targets a Faces view, then returns the viewId. Otherwise, returns null.

Specified by:

getViewId in interface BridgeURL

Returns:

if the URL targets a Faces View, returns the viewId. Otherwise null.

removeParameter

public java.lang.String removeParameter(java.lang.String name)

Description copied from interface: BridgeURL

Removes the entry of the underlying BridgeURL.getParameterMap() according to the specified name.

Specified by:

removeParameter in interface BridgeURL

Returns:

the first value of the underlying BridgeURL.getParameterMap() with the specified name.

setParameter

public void setParameter(java.lang.String name,
                         java.lang.String value)

Description copied from interface: BridgeURL

Sets the value of the underlying BridgeURL.getParameterMap() according to the specified name.

Specified by:

setParameter in interface BridgeURL

setParameter

public void setParameter(java.lang.String name,
                         java.lang.String[] value)

Description copied from interface: BridgeURL

Sets the value of the underlying BridgeURL.getParameterMap() according to the specified name.

Specified by:

setParameter in interface BridgeURL

toString

public java.lang.String toString()

Description copied from interface: BridgeURL

Returns a string-based representation of the URL.

Specified by:

toString in interface BridgeURL

Overrides:

toString in class java.lang.Object