com.liferay.faces.bridge.context.url
Interface BridgeURL

All Known Subinterfaces:

BridgeResourceURL

All Known Implementing Classes:

BridgeResourceURLWrapper, BridgeURLWrapper

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

Method Summary

String	getParameter(String name) Returns the first value of the underlying getParameterMap() with the specified name.
Map<String,String[]>	getParameterMap() Returns an mutable Map representing the URL parameters.
boolean	isFacesViewTarget() Determines whether or not the URL targets a Faces View.
boolean	isSecure() Flag indicating whether or not the URL is secure.
boolean	isSelfReferencing() Determines whether or not the URL is self-referencing, meaning, it targets the current Faces view.
void	setParameter(String name, String value) Sets the value of the underlying getParameterMap() according to the specified name.
void	setParameter(String name, String[] value) Sets the value of the underlying getParameterMap() according to the specified name.
void	setSecure(boolean secure) Sets the flag indicating whether or not the URL is secure.
void	setSelfReferencing(boolean selfReferencing) Sets the flag indicating whether or not the URL is self-referencing, meaning, whether or not it targets the current Faces view.
String	toString() Returns a string-based representation of the URL.

Method Detail

toString

String toString()

Returns a string-based representation of the URL.

Overrides:

toString in class Object

isSecure

boolean isSecure()

Flag indicating whether or not the URL is secure. For more information, see BaseURL.setSecure(boolean).

Returns:

true if the URL is secure, otherwise false.

isSelfReferencing

boolean isSelfReferencing()

Determines whether or not the URL is self-referencing, meaning, it targets the current Faces view.

Returns:

true if self-referencing, otherwise false.

getParameter

String getParameter(String name)

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

setParameter

void setParameter(String name,
                  String value)

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

setParameter

void setParameter(String name,
                  String[] value)

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

getParameterMap

Map<String,String[]> getParameterMap()

Returns an mutable Map representing the URL parameters.

setSecure

void setSecure(boolean secure)

Sets the flag indicating whether or not the URL is secure.

Parameters:

secure - true if secure, otherwise false.

setSelfReferencing

void setSelfReferencing(boolean selfReferencing)

Sets the flag indicating whether or not the URL is self-referencing, meaning, whether or not it targets the current Faces view.

Parameters:

selfReferencing - true if self-referencing, otherwise false.

isFacesViewTarget

boolean isFacesViewTarget()

Determines whether or not the URL targets a Faces View.

Returns:

true if the URL targets a Faces View, otherwise false