RID
public final class URI extends Object implements Comparable
An URI holds all information to identify a WCM resource and retrieve it via the WCM Framework. Each WCM resource has its unique URI.
A URI has a path-like structure, like a path in a file system and follows the following production:
URI ::= '/' pathsegment | '/' pathsegment '?' query pathsegment ::= name | name '/' pathsegment | empty name ::= any char except '/' query ::= parameter | parameter '&' query | empty parameter ::= varname | varname '=' value varname ::= any char except '=', '&' value ::= any character except '&'Equality is defined as ignoring trailing '/' characters. Thus, the URIs "/docs/" and /docs" are considered equal. There is special handling for the root collection "/", which is not equal to the empty URI "".
Copyright (c) SAP AG 2001-2005
Constructor and Description |
---|
URI(String uri)
Deprecated.
Create a new UTI with given path, without query
|
URI(String path,
String query)
Deprecated.
Create a new URI with given path and query string
|
Modifier and Type | Method and Description |
---|---|
URI |
add(String uri)
Deprecated.
Concatenate this URI with the given URI.
|
URI |
add(URI uri)
Deprecated.
Concatenate this URI with the given URI.
|
URI |
addQueryParameter(Properties parameter)
Deprecated.
as of NW04. Use setQueryParameter
|
int |
compareTo(Object o)
Deprecated.
|
URI |
decode()
Deprecated.
as of NW04. URI objects are never decoded
|
URI |
encode()
Deprecated.
as of NW04. URI objects are never encoded
|
boolean |
endsWithSlash()
Deprecated.
Return if this URI ends with a slash.
|
boolean |
equals(Object other)
Deprecated.
Determine if this URI equals other.
|
boolean |
equals(String other)
Deprecated.
Determine if this URI equals other.
|
boolean |
equals(URI other)
Deprecated.
Determine if this URI equals other.
|
String |
extension()
Deprecated.
Get the extension part of the resource name.
|
String |
getPath()
Deprecated.
Return the path component of this URI.
|
String |
getQuery()
Deprecated.
Return the query component of this URI (null if it does not exist).
|
Properties |
getQueryParameter()
Deprecated.
Get the query parameters of the URI.
|
int |
hashCode()
Deprecated.
|
boolean |
isAbsolute()
Deprecated.
Return if URI is absolute, e.g. start with a slash.
|
boolean |
isAncestorOf(URI child)
Deprecated.
Determine if this URI is an ancestor (parent or parent's parent, etc.) of
the given child URI.
|
boolean |
isRoot()
Deprecated.
Return if URI is root collection.
|
int |
length()
Deprecated.
Return length of URI in string representation
|
URI |
name()
Deprecated.
Get the name of the resource, designated by this URI.
|
URI |
parent()
Deprecated.
Get the URI of the parent collection of this URI
|
URI |
removeExtension()
Deprecated.
Remove the (optional) extension of the resource name.
|
URI |
removeName()
Deprecated.
Remove the name of the resource, same as parent()
|
URI |
removeRoot()
Deprecated.
Get a new URI with the toplevel collection removed
|
URI |
removeTrailingSlash()
Deprecated.
Remove a possible trailing slash from the URI.
|
URI |
resolveRelativeURI(String uri)
Deprecated.
Resolve relative URIs
|
URI |
root()
Deprecated.
Get URI of toplevel collection (below root) of this URI.
|
URI |
setQueryParameter(Properties parameter)
Deprecated.
Create a new URI by setting the given parameters as query part of this URI.
|
List |
split()
Deprecated.
Splits the URI into its path components
|
String |
toExternalForm()
Deprecated.
Convert this URI to a representation usable in W3C Uri References.
|
String |
toString()
Deprecated.
Returns string representation of this URI
|
public URI(String path, String query)
path
- of URIquery
- part or URI (can be null)public URI(String uri)
public URI encode()
public URI decode()
public String toExternalForm()
Note that such an encoded string cannot be used to construct an new URI object! The path in URI objects is never, ever encoded.
public String getPath()
public String getQuery()
public Properties getQueryParameter()
Properties
object has no
effect on the URI itself.Properties
public URI root()
The root URI of a toplevel collection is the root collection URI. The root URI of the root URI is the root URI itself.
public URI name()
public URI parent()
public String extension()
public URI removeRoot()
public URI removeName()
public URI removeExtension()
public URI removeTrailingSlash()
public boolean isAbsolute()
public boolean isRoot()
public boolean isAncestorOf(URI child)
child
- to test againstpublic boolean endsWithSlash()
public URI add(String uri)
uri
- to append to thispublic URI add(URI uri)
uri
- to append to thispublic List split()
String
spublic String toString()
public boolean equals(URI other)
other
- URIpublic boolean equals(String other)
other
- URI (string representation)public boolean equals(Object other)
public int length()
public URI resolveRelativeURI(String uri)
uri
- An URI, which may be relative or absolutepublic URI addQueryParameter(Properties parameter)
parameter
- to set to querypublic URI setQueryParameter(Properties parameter)
parameter
- to set to querypublic int compareTo(Object o)
compareTo
in interface Comparable
Access Rights |
---|
SC | DC | Public Part | ACH |
---|---|---|---|
[sap.com] KMC-CM
|
[sap.com] tc/km/frwk
|
api
|
EP-KM-CM
|
[sap.com] KMC-WPC
|
[sap.com] tc/kmc/wpc/wpcfacade
|
api
|
EP-PIN-WPC-WCM
|
Copyright 2018 SAP AG Complete Copyright Notice