org.dmfs.rfc3986

Interface Uri

All Known Implementing Classes:

EmptyUri, LazyUri, Normalized, OpaqueUri, RelativeUri, Resolved, StructuredUri

public interface Uri

A URI as specified in RFC 3986.

For convenience this represents a URI-reference as specified in RFC 3986, Section 4.1. For brevity and as per common usage it's still called just Uri instead of UriReference.

As a consequence, scheme() returns an Optional, because in contrast to a URI, a relative reference doesn't have a scheme.

isAbsolute() may be used to distinguish between real URIs that have a scheme (isAbsolute() returns true) and relative references (isAbsolute() returns false).

Method Summary

Modifier and Type	Method and Description
org.dmfs.optional.Optional<? extends Authority>	authority() Returns the Optional Authority of the URI reference.
org.dmfs.optional.Optional<? extends Fragment>	fragment() Returns the Optional Fragment of the URI reference.
boolean	isAbsolute() Returns whether this URI reference is absolute, i.e. a URI.
boolean	isHierarchical() Returns whether this URI reference is hierarchical.
Path	path() Returns the Path of this URI reference.
org.dmfs.optional.Optional<? extends Query>	query() Returns the Optional Query of the URI reference.
org.dmfs.optional.Optional<? extends Scheme>	scheme() Returns the Optional Scheme of the URI reference.

Method Detail

scheme

org.dmfs.optional.Optional<? extends Scheme> scheme()

Returns the Optional Scheme of the URI reference.

Returns:

An Optional Scheme.

authority

org.dmfs.optional.Optional<? extends Authority> authority()

Returns the Optional Authority of the URI reference.

Returns:

An Optional Authority.

path

Path path()

Returns the Path of this URI reference.

Returns:

A Path. The path is always present, but may be empty.

query

org.dmfs.optional.Optional<? extends Query> query()

Returns the Optional Query of the URI reference.

Returns:

An Optional Query.

fragment

org.dmfs.optional.Optional<? extends Fragment> fragment()

Returns the Optional Fragment of the URI reference.

Returns:

An Optional Fragment.

isHierarchical

boolean isHierarchical()

Returns whether this URI reference is hierarchical.

Returns:

true if the URI is hierarchical, false otherwise.

isAbsolute

boolean isAbsolute()

Returns whether this URI reference is absolute, i.e. a URI. A URI reference is absolute if it has a scheme, otherwise it's a relative reference as per RFC 3986, Section 4.2

Returns:

true if the URI is absolute, false otherwise.