Package org.apache.jackrabbit.oak.namepath

Class NamePathMapper.Default

  • All Implemented Interfaces:
    NameMapper, NamePathMapper, PathMapper
    Enclosing interface:
    NamePathMapper
    public static class NamePathMapper.Default
extends java.lang.Object
implements NamePathMapper
    Default implementation that doesn't perform any conversions for cases where a mapper object only deals with oak internal names and paths.

    • Constructor Summary

      Constructors 
      Constructor Description
      Default()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      @NotNull java.lang.String getJcrName​(@NotNull java.lang.String oakName)
      Returns the JCR name for the given Oak name.
      @NotNull java.lang.String getJcrPath​(java.lang.String oakPath)
      Returns the JCR path for the given Oak path.
      @NotNull java.lang.String getOakName​(@NotNull java.lang.String jcrName)
      Returns the Oak name for the specified JCR name.
      java.lang.String getOakNameOrNull​(@NotNull java.lang.String jcrName)
      Returns the Oak name for the given JCR name, or null if no such mapping exists because the given JCR name contains an unknown namespace URI or prefix, or is otherwise invalid.
      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.
      @NotNull java.util.Map<java.lang.String,​java.lang.String> getSessionLocalMappings()
      Returns the local namespace prefix mappings, or an empty map if there aren't any local mappings.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • Default

        public Default()

    • Method Detail

      • getOakNameOrNull

        public java.lang.String getOakNameOrNull​(@NotNull
                                         @NotNull java.lang.String jcrName)
        Description copied from interface: NameMapper
        Returns the Oak name for the given JCR name, or null if no such mapping exists because the given JCR name contains an unknown namespace URI or prefix, or is otherwise invalid.
        Specified by:
        getOakNameOrNull in interface NameMapper
        Parameters:
        jcrName - JCR name
        Returns:
        Oak name, or null

      • getOakName

        @NotNull
public @NotNull java.lang.String getOakName​(@NotNull
                                            @NotNull java.lang.String jcrName)
                                     throws RepositoryException
        Description copied from interface: NameMapper
        Returns the Oak name for the specified JCR name. In contrast to NameMapper.getOakNameOrNull(String) this method will throw a RepositoryException if the JCR name is invalid and cannot be resolved.
        Specified by:
        getOakName in interface NameMapper
        Parameters:
        jcrName - The JCR name to be converted.
        Returns:
        A valid Oak name.
        Throws:
        RepositoryException - If the JCR name cannot be resolved.

      • getSessionLocalMappings

        @NotNull
public @NotNull java.util.Map<java.lang.String,​java.lang.String> getSessionLocalMappings()
        Description copied from interface: NameMapper
        Returns the local namespace prefix mappings, or an empty map if there aren't any local mappings.
        Specified by:
        getSessionLocalMappings in interface NameMapper
        Returns:
        local namespace prefix to URI mappings

      • getJcrName

        @NotNull
public @NotNull java.lang.String getJcrName​(@NotNull
                                            @NotNull java.lang.String oakName)
        Description copied from interface: NameMapper
        Returns the JCR name for the given Oak name. The given name is expected to have come from a valid Oak repository that contains only valid names with 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.
        Specified by:
        getJcrName in interface NameMapper
        Parameters:
        oakName - Oak name
        Returns:
        JCR name

      • getOakPath

        public java.lang.String getOakPath​(java.lang.String jcrPath)
        Description copied from interface: PathMapper
        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.
        Specified by:
        getOakPath in interface PathMapper
        Parameters:
        jcrPath - JCR path
        Returns:
        Oak path, or null

      • getJcrPath

        @NotNull
public @NotNull java.lang.String getJcrPath​(java.lang.String oakPath)
        Description copied from interface: PathMapper
        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.
        Specified by:
        getJcrPath in interface PathMapper
        Parameters:
        oakPath - Oak path
        Returns:
        JCR path