Package org.apache.jackrabbit.spi.commons.name

Class PathFactoryImpl

java.lang.Object

org.apache.jackrabbit.spi.commons.name.PathFactoryImpl

All Implemented Interfaces:

PathFactory

public class PathFactoryImpl
extends java.lang.Object
implements PathFactory

PathFactoryImpl...

Method Summary

Modifier and Type	Method	Description
Path	create(java.lang.String pathString)	Returns a Path holding the value of the specified string.
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.Element	createElement(java.lang.String identifier)	Creates a path element from the given identifier.
Path.Element	createElement(Name name)	Creates a path element from the given name.
Path.Element	createElement(Name name, int index)	Same as PathFactory.createElement(Name) except that an explicit index can be specified.
Path.Element	getCurrentElement()	Return the current element.
static PathFactory	getInstance()
Path.Element	getParentElement()	Return the parent element.
Path.Element	getRootElement()	Return the root element.
Path	getRootPath()	Return the Path of the root node.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static PathFactory getInstance()

create

public Path create(Path parent,
                   Path relPath,
                   boolean normalize)
            throws java.lang.IllegalArgumentException,
                   RepositoryException

Description copied from interface: PathFactory

Return a new 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).

Specified by:

create in interface PathFactory

Returns:

Throws:

java.lang.IllegalArgumentException - if relPath is absolute.

RepositoryException - If the normalized is true and the resulting path cannot be normalized.

See Also:

PathFactory.create(Path, Path, boolean)

create

public Path create(Path parent,
                   Name name,
                   boolean normalize)
            throws RepositoryException

Description copied from interface: PathFactory

Creates a new 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 PathFactory.create(Path, Name, int, boolean) in order to build a Path having an index with his name element.

Specified by:

create in interface PathFactory

Parameters:

parent - the parent path

name - the name of the new path element.

normalize - If true the Path is normalized before being returned.

Returns:

Throws:

RepositoryException - If the normalized is true and the resulting path cannot be normalized.

See Also:

PathFactory.create(Path, Name, boolean)

create

public Path create(Path parent,
                   Name name,
                   int index,
                   boolean normalize)
            throws java.lang.IllegalArgumentException,
                   RepositoryException

Description copied from interface: PathFactory

Creates a new Path out of the given parent path and the give name and normalized index. See also PathFactory.create(Path, Name, boolean).

Specified by:

create in interface PathFactory

Parameters:

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.

Returns:

Throws:

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.

See Also:

PathFactory.create(Path, Name, int, boolean)

create

public Path create(Name name)
            throws java.lang.IllegalArgumentException

Description copied from interface: PathFactory

Creates a relative path based on a Name.

Specified by:

create in interface PathFactory

Parameters:

name - single Name for this relative path.

Returns:

the relative path created from name.

Throws:

java.lang.IllegalArgumentException - if the name is null.

See Also:

PathFactory.create(Name)

create

public Path create(Name name,
                   int index)
            throws java.lang.IllegalArgumentException

Description copied from interface: PathFactory

Creates a relative path based on a Name and a normalized index. Same as PathFactory.create(Name) but allows to explicitly specify an index.

Specified by:

create in interface PathFactory

Parameters:

name - single Name for this relative path.

index - index of the single name element.

Returns:

the relative path created from name and normalizedIndex.

Throws:

java.lang.IllegalArgumentException - if index is lower than Path.INDEX_UNDEFINED or if the name is not valid.

See Also:

PathFactory.create(Name, int)

create

public Path create(Path.Element element)

Description copied from interface: PathFactory

Creates a path from the given element.

Specified by:

create in interface PathFactory

Parameters:

element - path element

Returns:

the created path

create

public Path create(Path.Element[] elements)
            throws java.lang.IllegalArgumentException

Description copied from interface: PathFactory

Create a new Path from the given elements.

Specified by:

create in interface PathFactory

Returns:

the Path created from the elements.

Throws:

java.lang.IllegalArgumentException - If the given elements are null or have a length of 0 or would otherwise constitute an invalid path.

See Also:

PathFactory.create(org.apache.jackrabbit.spi.Path.Element[])

create

public Path create(java.lang.String pathString)
            throws java.lang.IllegalArgumentException

Description copied from interface: PathFactory

Returns a Path holding the value of the specified string. The string must be in the format returned by the Path.getString() method.

Specified by:

create in interface PathFactory

Parameters:

pathString - a String containing the Path representation to be parsed.

Returns:

the Path represented by the argument

Throws:

java.lang.IllegalArgumentException - if the specified string can not be parsed as a Path.

See Also:

PathFactory.create(String)

createElement

public Path.Element createElement(Name name)
                           throws java.lang.IllegalArgumentException

Description copied from interface: PathFactory

Creates a path element from the given name. The created path element does not contain an explicit index.

If the specified name denotes a special path element (either PathFactory.getParentElement(), PathFactory.getCurrentElement() or PathFactory.getRootElement()) then the associated constant is returned.

Specified by:

createElement in interface PathFactory

Parameters:

name - the name of the element

Returns:

a path element

Throws:

java.lang.IllegalArgumentException - if the name is null

See Also:

PathFactory.createElement(Name)

createElement

public Path.Element createElement(Name name,
                                  int index)
                           throws java.lang.IllegalArgumentException

Description copied from interface: PathFactory

Same as PathFactory.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 PathFactory.getParentElement(), PathFactory.getCurrentElement() or PathFactory.getRootElement()) since an explicit index is not allowed in this context.

Specified by:

createElement in interface PathFactory

Parameters:

name - the name of the element

index - the index if the element.

Returns:

a path element

Throws:

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.

See Also:

PathFactory.createElement(Name, int)

createElement

public Path.Element createElement(java.lang.String identifier)
                           throws java.lang.IllegalArgumentException

Description copied from interface: PathFactory

Creates a path element from the given identifier.

Specified by:

createElement in interface PathFactory

Parameters:

identifier - Node identifier for which the path element should be created.

Returns:

a path element.

Throws:

java.lang.IllegalArgumentException - If the identifier is null.

getCurrentElement

public Path.Element getCurrentElement()

Description copied from interface: PathFactory

Return the current element.

Specified by:

getCurrentElement in interface PathFactory

Returns:

the current element.

See Also:

PathFactory.getCurrentElement()

getParentElement

public Path.Element getParentElement()

Description copied from interface: PathFactory

Return the parent element.

Specified by:

getParentElement in interface PathFactory

Returns:

the parent element.

See Also:

PathFactory.getParentElement()

getRootElement

public Path.Element getRootElement()

Description copied from interface: PathFactory

Return the root element.

Specified by:

getRootElement in interface PathFactory

Returns:

the root element.

See Also:

PathFactory.getRootElement()

getRootPath

public Path getRootPath()

Description copied from interface: PathFactory

Return the Path of the root node.

Specified by:

getRootPath in interface PathFactory

Returns:

the Path of the root node.

See Also:

PathFactory.getRootPath()