org.apache.jackrabbit.oak.namepath

Interface PathMapper

All Known Subinterfaces:

NamePathMapper

All Known Implementing Classes:

NamePathMapper.Default, NamePathMapperImpl

@ProviderType
public interface PathMapper

PathMapper instances provide methods for mapping paths from their JCR string representation to their Oak representation and vice versa. The Oak representation of a path consists of a forward slash followed by the names of the respective items in the Tree separated by forward slashes.

Method Summary

Modifier and Type	Method and Description
@NotNull java.lang.String	getJcrPath(java.lang.String oakPath) Returns the JCR path for the given Oak path.
@Nullable java.lang.String	getOakPath(java.lang.String jcrPath) Returns the Oak path for the given JCR path, or null if no such mapping exists because the given JCR path contains a name element with an unknown namespace URI or prefix, or is otherwise invalid.

Method Detail

getOakPath

@Nullable
@Nullable java.lang.String getOakPath(java.lang.String jcrPath)

Returns the Oak path for the given JCR path, or null if no such mapping exists because the given JCR path contains a name element with an unknown namespace URI or prefix, or is otherwise invalid.

Parameters:

jcrPath - JCR path

Returns:

Oak path, or null

getJcrPath

@NotNull
@NotNull java.lang.String getJcrPath(java.lang.String oakPath)

Returns the JCR path for the given Oak path. The given path is expected to have come from a valid Oak repository that contains only valid paths whose name elements only use proper namespace mappings. If that's not the case, either a programming error or a repository corruption has occurred and an appropriate unchecked exception gets thrown.

Parameters:

oakPath - Oak path

Returns:

JCR path