com.liferay.faces.bridge.context.url
Class BridgeURLWrapper

java.lang.Object
  com.liferay.faces.bridge.context.url.BridgeURLWrapper

All Implemented Interfaces:

BridgeURL

Direct Known Subclasses:

BridgeResourceURLWrapper

public abstract class BridgeURLWrapper
extends Object
implements BridgeURL

Author:

Neil Griffin

Constructor Summary

BridgeURLWrapper()

Method Summary

String	getParameter(String name) Returns the first value of the underlying BridgeURL.getParameterMap() with the specified name.
abstract BridgeURL	getWrapped()
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 BridgeURL.getParameterMap() according to the specified name.
void	setParameter(String name, String[] value) Sets the value of the underlying BridgeURL.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.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.liferay.faces.bridge.context.url.BridgeURL

getParameterMap, toString

Constructor Detail

BridgeURLWrapper

public BridgeURLWrapper()

Method Detail

isSecure

public boolean isSecure()

Description copied from interface: BridgeURL

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

Specified by:

isSecure in interface BridgeURL

Returns:

true if the URL is secure, otherwise false.

isSelfReferencing

public boolean isSelfReferencing()

Description copied from interface: BridgeURL

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

Specified by:

isSelfReferencing in interface BridgeURL

Returns:

true if self-referencing, otherwise false.

getParameter

public String getParameter(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

setParameter

public void setParameter(String name,
                         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(String name,
                         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

setSecure

public void setSecure(boolean secure)

Description copied from interface: BridgeURL

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

Specified by:

setSecure in interface BridgeURL

Parameters:

secure - true if secure, otherwise false.

setSelfReferencing

public void setSelfReferencing(boolean selfReferencing)

Description copied from interface: BridgeURL

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

Specified by:

setSelfReferencing in interface BridgeURL

Parameters:

selfReferencing - true if self-referencing, otherwise false.

isFacesViewTarget

public boolean isFacesViewTarget()

Description copied from interface: BridgeURL

Determines whether or not the URL targets a Faces View.

Specified by:

isFacesViewTarget in interface BridgeURL

Returns:

true if the URL targets a Faces View, otherwise false

getWrapped

public abstract BridgeURL getWrapped()