BridgeURLWrapper (Liferay Faces Bridge 3.2.4-ga5 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

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:: BridgeActionURLWrapper, BridgePartialActionURLWrapper, BridgeRedirectURLWrapper, BridgeResourceURLWrapper

public abstract class BridgeURLWrapper
extends Object
implements BridgeURL
extends Object
implements BridgeURL

Author:: Neil Griffin

Constructor Summary
`BridgeURLWrapper()`

Method Summary
`String`	`getContextRelativePath()` Returns the context-relative path in the URL.
`String`	`getParameter(String name)` Returns the value of the underlying `BridgeURL.getParameterMap()` with the specified `name`.
`Map<String,String[]>`	`getParameterMap()` Returns a mutable `Map` representing the URL parameters.
`Set<String>`	`getParameterNames()` Returns a list of key names from the underlying `BridgeURL.getParameterMap()`.
`Bridge.PortletPhase`	`getPortletPhase()` Returns the `Bridge.PortletPhase` associated with this URL.
`abstract BridgeURL`	`getWrapped()`
`boolean`	`isAbsolute()` Determines whether or not the URL is absolute.
`boolean`	`isEscaped()` Determines whether or not the URL is escaped.
`boolean`	`isExternal()` Determines whether or not the URL is external.
`boolean`	`isFacesViewTarget()` Determines whether or not the URL targets a Faces View.
`boolean`	`isHierarchical()` Determines whether or not the URL is hierarchical, meaning it is either 1) absolute and the scheme-specific part begins with a forward-slash character, or 2) is relative.
`boolean`	`isOpaque()` Determines whether or not the URL is opaque, meaning it is absolute and its scheme component does not begin with a forward-slash character.
`boolean`	`isPathRelative()` Determines whether or not the path component of the URL is relative, meaning it does not begin with a forward-slash character.
`boolean`	`isPortletScheme()` Determines whether or not the URL begins with the "portlet:" scheme.
`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.
`String`	`removeParameter(String name)` Removes the value of the underlying `BridgeURL.getParameterMap()` with the specified `name`.
`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
`toString`

Constructor Detail

BridgeURLWrapper

public BridgeURLWrapper()

Method Detail