public final class PathBuilder extends Object
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 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.
|
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 . |
public PathBuilder()
default PathFactory
. See
PathBuilder(PathFactory)
for a constructor explicitly
specifying the factory to use.public PathBuilder(PathFactory factory)
factory
- The PathFactory used to create the elements and the final path.public PathBuilder(Path.Element[] elements)
elements
- public PathBuilder(Path parent)
parent
- public void addRoot()
PathFactory.getRootElement()
.public void addAll(Path.Element[] elements)
elements
- public void addFirst(Path.Element elem)
elem
- public void addFirst(Name name)
name
- public void addFirst(Name name, int index)
name
- index
- public void addLast(Path.Element elem)
elem
- public void addLast(Name name)
name
- public void addLast(Name name, int index)
name
- index
- public Path getPath() throws MalformedPathException
Path
.Path
MalformedPathException
- if the internal path element queue is empty.Copyright © 2004–2021 The Apache Software Foundation. All rights reserved.