org.dmfs.rfc3986.paths

Class Extended

java.lang.Object

org.dmfs.rfc3986.paths.Extended

All Implemented Interfaces:

java.lang.Iterable<UriEncoded>, Path

public final class Extended
extends java.lang.Object
implements Path

A decorator for Paths that appends path segments to the decorated Path.

Note, the result is automatically normalized, so this can be used to remove path segments, by appending IdempotentEncoded.PARENT.

Examples:

 Base path                     appended path                                   result

 (empty Path)                  (empty segment)                                 /
 (empty Path)                  .                                               ./
 (empty Path)                  ..                                              ../
 (empty Path)                  a                                               a

 .                             (empty segment)                                 ./     or  .
 .                             .                                               ./     or  ./.
 .                             ..                                              ../    or  ./..
 .                             a                                               a

 ..                            (empty segment)                                 ../    or  ..
 ..                            .                                               ../    or  ../.
 ..                            ..                                              ../../
 ..                            a                                               ../a

 /                             (empty segment)                                 /
 /                             .                                               /      or  /.
 /                             ..                                              /      or  /..
 /                             a                                               /a

 /a                            (empty segment)                                 /a/
 /a                            .                                               /a/    or  /a/.
 /a                            ..                                              /
 /a                            b                                               /a/b

 /a/                           (empty segment)                                 /a/
 /a/                           .                                               /a/    or  /a/.
 /a/                           ..                                              /
 /a/                           b                                               /a/b

 /a/b                          (empty segment)                                 /a/b/
 /a/b                          .                                               /a/b/  or  /a/b/.
 /a/b                          ..                                              /a/
 /a/b                          c                                               /a/b/c

 a                             (empty segment)                                 a/
 a                             .                                               a/     or  a/.
 a                             ..                                              ./
 a                             b                                               a/b

 a/                            (empty segment)                                 a/
 a/                            .                                               a/     or  a/.
 a/                            ..                                              ./
 a/                            b                                               a/b
 

Note that this is different from the result of Resolved

• Extended doesn't remove the last path segment of the base path if it's not a directory
• Resolved returns the path reference if it's an absolute path.

The following examples illustrate these differences:

 new Extended(new StringPath("/a/b"), new StringPath("c/d"));  // results in "/a/b/c/d"
 new Extended(new StringPath("/a/b"), new StringPath("/c/d"));  // results in "/a/b/c/d"

 new Resolved(new StringPath("/a/b"), new StringPath("c/d"));  // results in "/a/c/d"
 new Resolved(new StringPath("/a/b"), new StringPath("/c/d"));  // results in "/c/d"
 

Constructor Summary

Constructors

Constructor and Description
Extended(Path delegate, Path newSegments)
Extended(Path delegate, UriEncoded... newSegments)

Method Summary

Modifier and Type	Method and Description
boolean	isAbsolute() Returns whether this path is absolute, i.e. starts with a "/".
boolean	isEmpty() Returns whether this path is empty, i.e. contains no path segments.
java.util.Iterator<UriEncoded>	iterator()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

Extended

public Extended(Path delegate,
                UriEncoded... newSegments)

Extended

public Extended(Path delegate,
                Path newSegments)

Method Detail

isEmpty

public boolean isEmpty()

Description copied from interface: Path

Returns whether this path is empty, i.e. contains no path segments.

Specified by:

isEmpty in interface Path

Returns:

true if this path is empty, false otherwise.

isAbsolute

public boolean isAbsolute()

Description copied from interface: Path

Returns whether this path is absolute, i.e. starts with a "/".

Specified by:

isAbsolute in interface Path

Returns:

true if this path is absolute, false otherwise.

iterator

public java.util.Iterator<UriEncoded> iterator()

Specified by:

iterator in interface java.lang.Iterable<UriEncoded>