public interface PathFactory
PathFactory
...Modifier and Type | Method and Description |
---|---|
Path |
create(Name name)
Creates a relative path based on a
Name . |
Path |
create(Name name,
int index)
Creates a relative path based on a
Name and a normalized index. |
Path |
create(Path.Element element)
Creates a path from the given element.
|
Path |
create(Path.Element[] elements)
Create a new
Path from the given elements. |
Path |
create(Path parent,
Name name,
boolean normalize)
Creates a new
Path out of the given parent path
and the give name. |
Path |
create(Path parent,
Name name,
int index,
boolean normalize)
Creates a new
Path out of the given parent path
and the give name and normalized index. |
Path |
create(Path parent,
Path relPath,
boolean normalize)
Return a new
Path out of the given parent path
and the given relative path. |
Path |
create(java.lang.String pathString)
Returns a
Path holding the value of the specified
string. |
Path.Element |
createElement(Name name)
Creates a path element from the given
name . |
Path.Element |
createElement(Name name,
int index)
Same as
createElement(Name) except that an explicit index can be
specified. |
Path.Element |
createElement(java.lang.String identifier)
Creates a path element from the given
identifier . |
Path.Element |
getCurrentElement()
Return the current element.
|
Path.Element |
getParentElement()
Return the parent element.
|
Path.Element |
getRootElement()
Return the root element.
|
Path |
getRootPath()
Return the
Path of the root node. |
Path create(Path parent, Path relPath, boolean normalize) throws java.lang.IllegalArgumentException, RepositoryException
Path
out of the given parent
path
and the given relative path. If normalize
is
true
, the returned path will be normalized (or
canonicalized, if the parent path is absolute).parent
- relPath
- normalize
- java.lang.IllegalArgumentException
- if relPath
is absolute.RepositoryException
- If the normalized
is
true
and the resulting path cannot be normalized.Path create(Path parent, Name name, boolean normalize) throws RepositoryException
Path
out of the given parent
path
and the give name. If normalize
is true
,
the returned path will be normalized (or canonicalized, if the parent
path is absolute). Use create(Path, Name, int, boolean)
in order to build a Path
having an index with his name element.parent
- the parent pathname
- the name of the new path element.normalize
- If true the Path is normalized before being returned.RepositoryException
- If the normalized
is
true
and the resulting path cannot be normalized.Path create(Path parent, Name name, int index, boolean normalize) throws java.lang.IllegalArgumentException, RepositoryException
Path
out of the given parent
path
and the give name and normalized index. See also
create(Path, Name, boolean)
.parent
- the parent path.name
- the name of the new path element.index
- the index of the new path element.normalize
- If true the Path is normalized before being returned.java.lang.IllegalArgumentException
- If the given index is lower than
Path.INDEX_UNDEFINED
.RepositoryException
- If the normalized
is
true
and the resulting path cannot be normalized.Path create(Name name) throws java.lang.IllegalArgumentException
Name
.name
- single Name
for this relative path.name
.java.lang.IllegalArgumentException
- if the name is null
.Path create(Name name, int index) throws java.lang.IllegalArgumentException
Name
and a normalized index.
Same as create(Name)
but allows to explicitly specify an
index.name
- single Name
for this relative path.index
- index of the single name element.name
and normalizedIndex
.java.lang.IllegalArgumentException
- if index
is lower
than Path.INDEX_UNDEFINED
or if the name is not valid.Path create(Path.Element element) throws java.lang.IllegalArgumentException
element
- path elementjava.lang.IllegalArgumentException
- if the given element is null
Path create(Path.Element[] elements) throws java.lang.IllegalArgumentException
Path
from the given elements.elements
- Path
created from the elements.java.lang.IllegalArgumentException
- If the given elements are null
or have a length of 0 or would otherwise constitute an invalid path.Path create(java.lang.String pathString) throws java.lang.IllegalArgumentException
Path
holding the value of the specified
string. The string must be in the format returned by the
Path.getString()
method.pathString
- a String
containing the Path
representation to be parsed.Path
represented by the argumentjava.lang.IllegalArgumentException
- if the specified string can not be parsed
as a Path
.Path.getString()
,
Path.DELIMITER
Path.Element createElement(Name name) throws java.lang.IllegalArgumentException
name
.
The created path element does not contain an explicit index.
If the specified name denotes a special path element (either
getParentElement()
, getCurrentElement()
or
getRootElement()
) then the associated constant is returned.
name
- the name of the elementjava.lang.IllegalArgumentException
- if the name is null
Path.Element createElement(Name name, int index) throws java.lang.IllegalArgumentException
createElement(Name)
except that an explicit index can be
specified.
Note that an IllegalArgumentException will be thrown if the specified
name denotes a special path element (either
getParentElement()
, getCurrentElement()
or
getRootElement()
) since an explicit index is not allowed
in this context.
name
- the name of the elementindex
- the index if the element.java.lang.IllegalArgumentException
- if the name is null
,
if the given index is lower than Path.INDEX_UNDEFINED
or if name
denoting a special path element.Path.Element createElement(java.lang.String identifier) throws java.lang.IllegalArgumentException
identifier
.identifier
- Node identifier for which the path element should be created.java.lang.IllegalArgumentException
- If the identifier
is null
.Path.Element getCurrentElement()
Path.Element getParentElement()
Path.Element getRootElement()
Path getRootPath()
Path
of the root node.Path
of the root node."Copyright © 2010 - 2020 Adobe Systems Incorporated. All Rights Reserved"