Class URI

public URI(String str)
            throws URISyntaxException

Creates an URI from the given string

Parameters:

str - The string to create the URI from

Throws:

URISyntaxException - If the given string violates RFC 2396

NullPointerException - If str is null

public URI(String scheme,
           String ssp,
           String fragment)
            throws URISyntaxException

Create an URI from the given components

Parameters:

scheme - The scheme name

ssp - The scheme specific part

fragment - The fragment

Throws:

URISyntaxException - If the given string violates RFC 2396

public URI(String scheme,
           String userInfo,
           String host,
           int port,
           String path,
           String query,
           String fragment)
            throws URISyntaxException

Create an URI from the given components

Parameters:

scheme - The scheme name

userInfo - The username and authorization info

host - The hostname

port - The port number

path - The path

query - The query

fragment - The fragment

Throws:

URISyntaxException - If the given string violates RFC 2396

public URI(String scheme,
           String host,
           String path,
           String fragment)
            throws URISyntaxException

Create an URI from the given components

Parameters:

scheme - The scheme name

host - The hostname

path - The path

fragment - The fragment

Throws:

URISyntaxException - If the given string violates RFC 2396

public URI(String scheme,
           String authority,
           String path,
           String query,
           String fragment)
            throws URISyntaxException

Create an URI from the given components

Parameters:

scheme - The scheme name

authority - The authority

path - The apth

query - The query

fragment - The fragment

Throws:

URISyntaxException - If the given string violates RFC 2396

public int compareTo(URI uri)
            throws ClassCastException

Compare the URI with another URI. Undefined components are taken to be less than any other component. The following criteria are observed:

• Two URIs with different schemes are compared according to their scheme, regardless of case.
• A hierarchical URI is less than an opaque URI with the same scheme.
• For opaque URIs:

• URIs with differing scheme-specific parts are ordered according to the ordering of the scheme-specific part.
• URIs with the same scheme-specific part are ordered by the raw fragment.

For hierarchical URIs:

• URIs are ordered according to their raw authority sections, if they are unequal.
• For registry-based authorities:

• they are ordered according to the ordering of the authority component.

For server-based authorities:

• URIs are ordered according to the raw user information.
• URIs with the same user information are ordered by the host, ignoring case.
• URIs with the same host are ordered by the port.

URIs with the same authority section are ordered by the raw path.

URIs with the same path are ordered by their raw query.

URIs with the same query are ordered by their raw fragments.

Parameters:

uri - The other URI to compare this URI with

Returns:

a negative integer, zero or a positive integer depending on whether this URI is less than, equal to or greater than that supplied, respectively.

public static URI create(String str)

Create an URI from the given string

Parameters:

str - The string to create the URI from

Throws:

IllegalArgumentException - If the given string violates RFC 2396

NullPointerException - If str is null

public boolean equals(Object obj)

Compares the URI with the given object for equality. If the object is not a URI, then the method returns false. Otherwise, the following criteria are observed:

• The scheme of the URIs must either be null (undefined) in both cases, or equal, ignorant of case.
• The raw fragment of the URIs must either be null (undefined) in both cases, or equal, ignorant of case.
• Both URIs must be of the same type (opaque or hierarchial)
• For opaque URIs:

• The raw scheme-specific parts must be equal.

For hierarchical URIs:

• The raw paths must be equal, ignorant of case.
• The raw queries are either both undefined or both equal, ignorant of case.
• The raw authority sections are either both undefined or:
• For registry-based authorities:

• they are equal.

For server-based authorities:

• the hosts are equal, ignoring case
• the ports are equal
• the user information components are equal

Overrides:

equals in interface Object

Parameters:

obj - the obj to compare the URI with.

Returns:

true if the objects are equal, according to the specification above.

public String getAuthority()

Returns the decoded authority part of this URI

public String getFragment()

Returns the fragment of the URI

public String getHost()

Returns the hostname of the URI

public String getPath()

Returns the path of the URI

public int getPort()

Returns the port number of the URI

public String getQuery()

Returns the query of the URI

public String getRawAuthority()

Returns the raw authority part of this URI

public String getRawFragment()

Return the raw fragment part of this URI

public String getRawPath()

Returns the raw path part of this URI

public String getRawQuery()

Returns the raw query part of this URI

public String getRawSchemeSpecificPart()

Returns the raw scheme specific part of this URI. The scheme-specific part is never undefined, though it may be empty

public String getRawUserInfo()

Returns the raw user info part of this URI

public String getScheme()

Returns the scheme of the URI

public String getSchemeSpecificPart()

Returns the decoded scheme specific part of this URI.

public String getUserInfo()

Returns the decoded user info part of this URI

public int hashCode()

Computes the hashcode of the URI

Overrides:

hashCode in interface Object

public boolean isAbsolute()

Tells whether this URI is absolute or not

public boolean isOpaque()

Tell whether this URI is opaque or not

public URI normalize()

Returns a normalized version of the URI. If the URI is opaque, or its path is already in normal form, then this URI is simply returned. Otherwise, the following transformation of the path element takes place:

1. All `.' segments are removed.
2. Each `..' segment which can be paired with a prior non-`..' segment is removed along with the preceding segment.
3. A `.' segment is added to the front if the first segment contains a colon (`:'). This is a deviation from the RFC, which prevents confusion between the path and the scheme.

The resulting URI will be free of `.' and `..' segments, barring those that were prepended or which couldn't be paired, respectively.

Returns:

the normalized URI.

public URI parseServerAuthority()
            throws URISyntaxException

Attempts to parse this URI's authority component, if defined, into user-information, host, and port components. The purpose of this method was to disambiguate between some authority sections, which form invalid server-based authories, but valid registry based authorities. In the updated RFC 3986, the authority section is defined differently, with registry-based authorities part of the host section. Thus, this method is now simply an explicit way of parsing any authority section.

Returns:

the URI, with the authority section parsed into user information, host and port components.

Throws:

URISyntaxException - if the given string violates RFC 2396

public URI relativize(URI uri)

Relativizes the given URI against this URI. The following algorithm is used:

• If either URI is opaque, the given URI is returned.
• If the schemes of the URIs differ, the given URI is returned.
• If the authority components of the URIs differ, then the given URI is returned.
• If the path of this URI is not a prefix of the supplied URI, then the given URI is returned.
• If all the above conditions hold, a new URI is created using the query and fragment components of the given URI, along with a path computed by removing the path of this URI from the start of the path of the supplied URI.

Parameters:

uri - the URI to relativize agsint this URI

Returns:

the resulting URI

Throws:

NullPointerException - if the uri is null

public URI resolve(String str)
            throws IllegalArgumentException

Resolves the given URI string against this URI

Parameters:

str - The URI as string to resolve against this URI

Returns:

The resulting URI

Throws:

IllegalArgumentException - If the given URI string violates RFC 2396

NullPointerException - If uri is null

public URI resolve(URI uri)

Resolves the given URI against this URI

Parameters:

uri - The URI to resolve against this URI

Returns:

The resulting URI, or null when it couldn't be resolved for some reason.

Throws:

NullPointerException - if uri is null

public String toASCIIString()

Returns the URI as US-ASCII string. This is the same as the result from toString() for URIs that don't contain any non-US-ASCII characters. Otherwise, the non-US-ASCII characters are replaced by their percent-encoded representations.

Returns:

a string representation of the URI, containing only US-ASCII characters.

public String toString()

Returns the URI as a String. If the URI was created using a constructor, then this will be the same as the original input string.

Overrides:

toString in interface Object

Returns:

a string representation of the URI.

public URL toURL()
            throws IllegalArgumentException,
                   MalformedURLException

Creates an URL from an URI

Throws:

MalformedURLException - If a protocol handler for the URL could not be found, or if some other error occurred while constructing the URL

IllegalArgumentException - If the URI is not absolute