org.apache.jackrabbit.spi.commons.name

Class PathBuilder

java.lang.Object

org.apache.jackrabbit.spi.commons.name.PathBuilder

public final class PathBuilder
extends Object

Helper class used to build a path from pre-parsed path elements.

Note that this class does neither validate the format of the path elements nor does it validate the format of the entire path. This class should therefore only be used in situations, where the elements and the resulting path are known to be valid. The regular way of creating a Path object is by calling any of the PathFactory.create()methods.

Constructor Summary

Constructors

Constructor and Description
PathBuilder() Creates a new PathBuilder to create a Path using the default PathFactory.
PathBuilder(Path.Element[] elements) Creates a new PathBuilder and initialized it with the given path elements.
PathBuilder(Path parent) Creates a new PathBuilder and initialized it with elements of the given path.
PathBuilder(PathFactory factory) Creates a new PathBuilder.

Method Summary

Modifier and Type	Method and Description
void	addAll(Path.Element[] elements) Adds the given elements
void	addFirst(Name name) Inserts the element at the beginning of the path to be built.
void	addFirst(Name name, int index) Inserts the element at the beginning of the path to be built.
void	addFirst(Path.Element elem) Inserts the element at the beginning of the path to be built.
void	addLast(Name name) Inserts the element at the end of the path to be built.
void	addLast(Name name, int index) Inserts the element at the end of the path to be built.
void	addLast(Path.Element elem) Inserts the element at the end of the path to be built.
void	addRoot() Adds the PathFactory.getRootElement().
Path	getPath() Assembles the built path and returns a new Path.

Methods inherited from class java.lang.Object

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

Constructor Detail

PathBuilder

public PathBuilder()

Creates a new PathBuilder to create a Path using the default PathFactory. See PathBuilder(PathFactory) for a constructor explicitly specifying the factory to use.

PathBuilder

public PathBuilder(PathFactory factory)

Creates a new PathBuilder.

Parameters:

factory - The PathFactory used to create the elements and the final path.

PathBuilder

public PathBuilder(Path.Element[] elements)

Creates a new PathBuilder and initialized it with the given path elements.

Parameters:

elements -

PathBuilder

public PathBuilder(Path parent)

Creates a new PathBuilder and initialized it with elements of the given path.

Parameters:

parent -

Method Detail

addRoot

public void addRoot()

Adds the PathFactory.getRootElement().

addAll

public void addAll(Path.Element[] elements)

Adds the given elements

Parameters:

elements -

addFirst

public void addFirst(Path.Element elem)

Inserts the element at the beginning of the path to be built.

Parameters:

elem -

addFirst

public void addFirst(Name name)

Inserts the element at the beginning of the path to be built.

Parameters:

name -

addFirst

public void addFirst(Name name,
                     int index)

Inserts the element at the beginning of the path to be built.

Parameters:

name -

index -

addLast

public void addLast(Path.Element elem)

Inserts the element at the end of the path to be built.

Parameters:

elem -

addLast

public void addLast(Name name)

Inserts the element at the end of the path to be built.

Parameters:

name -

addLast

public void addLast(Name name,
                    int index)

Inserts the element at the end of the path to be built.

Parameters:

name -

index -

getPath

public Path getPath()
             throws MalformedPathException

Assembles the built path and returns a new Path.

Returns:

a new Path

Throws:

MalformedPathException - if the internal path element queue is empty.