com.liferay.faces.bridge

Interface BridgeURL

All Known Implementing Classes:

BridgeURLWrapper

@ProviderType
public interface BridgeURL

This interface represents a bridge URL, meaning a URL that has convenience methods for representing URLs according to Section 6.1.3.1 of the Bridge Spec.

Author:

Neil Griffin

See Also:

Bridge.DIRECT_LINK, Bridge.FACES_AJAX_PARAMETER, Bridge.FACES_PARTIAL_PARAMETER, Bridge.FACES_VIEW_ID_PARAMETER, Bridge.FACES_VIEW_PATH_PARAMETER, Bridge.NONFACES_TARGET_PATH_PARAMETER, Bridge.PORTLET_MODE_PARAMETER, Bridge.PORTLET_WINDOWSTATE_PARAMETER, Bridge.PORTLET_SECURE_PARAMETER

Method Summary

Modifier and Type	Method and Description
java.lang.String	getParameter(java.lang.String name) Returns the first value of the underlying 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.
java.lang.String	removeParameter(java.lang.String name) Removes the entry of the underlying getParameterMap() according to the specified name.
void	setParameter(java.lang.String name, java.lang.String value) Sets the value of the underlying getParameterMap() according to the specified name.
void	setParameter(java.lang.String name, java.lang.String[] value) Sets the value of the underlying getParameterMap() according to the specified name.
java.lang.String	toString() Returns a string-based representation of the URL.

Method Detail

getParameter

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

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

getParameterMap

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

Returns a mutable Map representing the URL parameters.

getViewId

java.lang.String getViewId()

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

Returns:

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

removeParameter

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

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

Returns:

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

setParameter

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

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

setParameter

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

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

toString

java.lang.String toString()

Returns a string-based representation of the URL.

Overrides:

toString in class java.lang.Object