org.dmfs.rfc3986.uris

Class RelativeUri

java.lang.Object

org.dmfs.rfc3986.uris.RelativeUri

All Implemented Interfaces:

Uri

public final class RelativeUri
extends java.lang.Object
implements Uri

A simplified relative reference Uri as per RFC 3986, Section 4.2. A relative Uri has no Scheme. Since scheme relative references are less common, this class supports only relative references without Scheme and Authority. To create a scheme relative reference use StructuredUri.StructuredUri(Optional, Optional, Path, Optional, Optional) and pass None.none() as the Scheme.

Constructor Summary

Constructors

Constructor and Description
RelativeUri(Fragment fragment)
RelativeUri(Path path)
RelativeUri(Path path, org.dmfs.optional.Optional<Query> query, org.dmfs.optional.Optional<Fragment> fragment)
RelativeUri(Path path, Query query)
RelativeUri(Path path, Query query, Fragment fragment)
RelativeUri(Query query)
RelativeUri(Query query, Fragment fragment)

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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RelativeUri

public RelativeUri(Path path)

RelativeUri

public RelativeUri(Query query)

RelativeUri

public RelativeUri(Fragment fragment)

RelativeUri

public RelativeUri(Path path,
                   Query query)

RelativeUri

public RelativeUri(Query query,
                   Fragment fragment)

RelativeUri

public RelativeUri(Path path,
                   Query query,
                   Fragment fragment)

RelativeUri

public RelativeUri(Path path,
                   org.dmfs.optional.Optional<Query> query,
                   org.dmfs.optional.Optional<Fragment> fragment)

Method Detail

scheme

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

Description copied from interface: Uri

Returns the Optional Scheme of the URI reference.

Specified by:

scheme in interface Uri

Returns:

An Optional Scheme.

authority

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

Description copied from interface: Uri

Returns the Optional Authority of the URI reference.

Specified by:

authority in interface Uri

Returns:

An Optional Authority.

path

public Path path()

Description copied from interface: Uri

Returns the Path of this URI reference.

Specified by:

path in interface Uri

Returns:

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

query

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

Description copied from interface: Uri

Returns the Optional Query of the URI reference.

Specified by:

query in interface Uri

Returns:

An Optional Query.

fragment

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

Description copied from interface: Uri

Returns the Optional Fragment of the URI reference.

Specified by:

fragment in interface Uri

Returns:

An Optional Fragment.

isHierarchical

public boolean isHierarchical()

Description copied from interface: Uri

Returns whether this URI reference is hierarchical.

Specified by:

isHierarchical in interface Uri

Returns:

true if the URI is hierarchical, false otherwise.

isAbsolute

public boolean isAbsolute()

Description copied from interface: Uri

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

Specified by:

isAbsolute in interface Uri

Returns:

true if the URI is absolute, false otherwise.