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

public interface BridgeURI

Author:

Neil Griffin

Method Summary

String	getContextRelativePath(String contextPath) Returns the path component of the URI, relative to the specified context-path.
Map<String,String[]>	getParameterMap() Returns an immutable Map representing the URI parameters.
String	getPath() Returns the path component of the URI.
Bridge.PortletPhase	getPortletPhase() Returns the Bridge.PortletPhase associated with this URL.
String	getQuery() Returns the query component, meaning all characters after the question-mark of the scheme-specific-part of the URI.
boolean	isAbsolute() Determines whether or not the URI is absolute, meaning it contains a scheme component.
boolean	isEscaped() Determines whether or not the URI is escaped.
boolean	isExternal() Determines whether or not the URL is external.
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	isRelative() Determines whether or not the URI is relative, meaning it does not have a scheme component.
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

getContextRelativePath

String getContextRelativePath(String contextPath)

Returns the path component of the URI, relative to the specified context-path.

isEscaped

boolean isEscaped()

Determines whether or not the URI is escaped.

Returns:

true if all occurrences of the ampersand character appear as & otherwise, returns false.

isAbsolute

boolean isAbsolute()

Determines whether or not the URI is absolute, meaning it contains a scheme component. Note that according to the class-level documentation of URI an absolute URI is non-relative.

Returns:

Returns true if the URI is absolute, otherwise returns false.

isOpaque

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. For more information see URI.isOpaque().

Returns:

true if the URL is opaque, otherwise false.

isPathRelative

boolean isPathRelative()

Determines whether or not the path component of the URL is relative, meaning it does not begin with a forward-slash character.

Returns:

true if the path is relative, otherwise false.

isPortletScheme

boolean isPortletScheme()

Determines whether or not the URL begins with the "portlet:" scheme.

Returns:

true if the URL begins with the "portlet:" scheme, otherwise false.

isRelative

boolean isRelative()

Determines whether or not the URI is relative, meaning it does not have a scheme component. Note that according to the class-level documentation of URI a relative URI is non-absolute.

Returns:

Returns true if the URI is relative, otherwise returns false.

isExternal

boolean isExternal()

Determines whether or not the URL is external.

Returns:

true if external, otherwise false.

isHierarchical

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.

Returns:

true if the URL is hierarchical, otherwise false.

getParameterMap

Map<String,String[]> getParameterMap()

Returns an immutable Map representing the URI parameters.

getPath

String getPath()

Returns the path component of the URI.

getPortletPhase

Bridge.PortletPhase getPortletPhase()

Returns the Bridge.PortletPhase associated with this URL. Note that the value will be null if the URL does not begin with the "portlet:" scheme/prefix.

getQuery

String getQuery()

Returns the query component, meaning all characters after the question-mark of the scheme-specific-part of the URI.