com.sapportals.wcm.util.uri
Class UriReference

[contained in: com.sap.netweaver.bc.util.par - bc.util.public_api.jar]

java.lang.Object
  |
  +--com.sapportals.wcm.util.uri.UriReference

All Implemented Interfaces:

IUriReference

public class UriReference

extends java.lang.Object

implements IUriReference

A RFC2396 reference implementation.

Copyright (c) SAP AG 2001-2002

Constructor Summary

UriReference(IUriReference reference, java.lang.String fragmentIdentifier)

UriReference(IUri uri, java.lang.String fragmentIdentifier)
Construct new absolute uri reference.

UriReference(java.lang.String path, java.lang.String query, java.lang.String fragment)
Construct new relative uri reference without authority and scheme.

UriReference(java.lang.String authority, java.lang.String path, java.lang.String query, java.lang.String fragment)
Construct new relative uri reference without scheme.

UriReference(java.lang.String scheme, java.lang.String authority, java.lang.String path, java.lang.String query, java.lang.String fragment)
Construct new relative uri reference with scheme.

Method Summary

IUriReference	appendPath(java.lang.String path) Create a new uri reference by appending the given path to any existing path in the uri reference.
boolean	equals(IUriReference other)
boolean	equals(java.lang.Object other)
boolean	equals(UriReference other)
java.lang.String	getAuthority() Get the authority of the reference
java.lang.String	getFragmentIdentifier() Get the fragment identifier (without '#') of the uri
java.lang.String	getPath() Get the path of the reference
java.lang.String	getQuery() Get the query of the reference
java.lang.String	getScheme() Get the scheme of the reference
IUri	getUri() Get the uri if the reference is absolute
int	hashCode()
boolean	isAbsolute() Determine if the reference is absolute
IUriReference	resolveWith(IUri base) With base Uri, resolve this reference to an absolute reference.
IUriReference	setQuery(java.lang.String query) Gets a new URI reference resulting from setting the query of this URI reference to the given query.
java.lang.String	toExternalForm() Returns a string representation according to RFC 2396 of this uri reference.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

UriReference

public UriReference(IUri uri,
                    java.lang.String fragmentIdentifier)

Construct new absolute uri reference.

Parameters:

uri - the absolute uri

fragmentIdentifier - the fragment of the uri reference

UriReference

public UriReference(java.lang.String path,
                    java.lang.String query,
                    java.lang.String fragment)

Construct new relative uri reference without authority and scheme.

Parameters:

path - the path of the reference or empty

fragment - used in reference of null

query - TBD: Description of the incoming method parameter

UriReference

public UriReference(java.lang.String authority,
                    java.lang.String path,
                    java.lang.String query,
                    java.lang.String fragment)

Construct new relative uri reference without scheme.

Parameters:

authority - of the relative uri reference

path - the path of the reference or empty

fragment - used in reference of null

query - TBD: Description of the incoming method parameter

UriReference

public UriReference(java.lang.String scheme,
                    java.lang.String authority,
                    java.lang.String path,
                    java.lang.String query,
                    java.lang.String fragment)
             throws java.lang.IllegalArgumentException

Construct new relative uri reference with scheme. This constructor is used for a degenerate case as described in RFC 2396, page 32. The construction of relative uri references with scheme is discouraged. Note that either scheme or authority must be null.

Parameters:

scheme - of the relative uri reference

authority - of the relative uri reference

path - the path of the reference or empty

fragment - used in reference of null

query - TBD: Description of the incoming method parameter

Throws:

java.lang.IllegalArgumentException - Exception raised in failure situation

java.lang.IllegalArgumentException - if both scheme and authority are not null

UriReference

public UriReference(IUriReference reference,
                    java.lang.String fragmentIdentifier)

Method Detail

appendPath

public IUriReference appendPath(java.lang.String path)

Description copied from interface: IUriReference

Create a new uri reference by appending the given path to any existing path in the uri reference. The path must be uri encoded or the created reference will not be valid. The given path is appended by prefixing a slash character, if necessary.

Specified by:

appendPath in interface IUriReference

Following copied from interface: com.sapportals.wcm.util.uri.IUriReference

Parameters:

path - uri encoded path to be appended

Returns:

an uri reference with path appended

Throws:

java.lang.UnsupportedOperationException - Exception raised in failure situation

setQuery

public IUriReference setQuery(java.lang.String query)

Description copied from interface: IUriReference

Gets a new URI reference resulting from setting the query of this URI reference to the given query. The query string must be in RFC 2396 encoded form. See UriQuery for manipulation of query strings.

Specified by:

setQuery in interface IUriReference

Following copied from interface: com.sapportals.wcm.util.uri.IUriReference

Parameters:

query - the encoded query string to be set (may be null )

Returns:

an uri reference with query set to given query

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class java.lang.Object

equals

public boolean equals(IUriReference other)

equals

public boolean equals(UriReference other)

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toExternalForm

public java.lang.String toExternalForm()

Description copied from interface: IUriReference

Returns a string representation according to RFC 2396 of this uri reference.

Specified by:

toExternalForm in interface IUriReference

Following copied from interface: com.sapportals.wcm.util.uri.IUriReference

Returns:

string in uri reference format

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getFragmentIdentifier

public java.lang.String getFragmentIdentifier()

Get the fragment identifier (without '#') of the uri

Specified by:

getFragmentIdentifier in interface IUriReference

Returns:

fragment identifier or emtpy String

getScheme

public java.lang.String getScheme()

Get the scheme of the reference

Specified by:

getScheme in interface IUriReference

Returns:

scheme of reference or null

getAuthority

public java.lang.String getAuthority()

Get the authority of the reference

Specified by:

getAuthority in interface IUriReference

Returns:

authority of reference or null

getPath

public java.lang.String getPath()

Get the path of the reference

Specified by:

getPath in interface IUriReference

Returns:

path of reference or empty string

getQuery

public java.lang.String getQuery()

Get the query of the reference

Specified by:

getQuery in interface IUriReference

Returns:

query of reference or null

getUri

public IUri getUri()

Get the uri if the reference is absolute

Specified by:

getUri in interface IUriReference

Returns:

uri of reference or null

isAbsolute

public boolean isAbsolute()

Determine if the reference is absolute

Specified by:

isAbsolute in interface IUriReference

Returns:

if reference is absolute

resolveWith

public IUriReference resolveWith(IUri base)

With base Uri, resolve this reference to an absolute reference. If this reference is already absolute, this is the identity operation.

Specified by:

resolveWith in interface IUriReference

Parameters:

base - uri to resolve this reference with

Returns:

absolute uri reference