Package org.apache.jackrabbit.core.fs

Class FileSystemPathUtil

java.lang.Object
org.apache.jackrabbit.core.fs.FileSystemPathUtil
public final class FileSystemPathUtil extends Object
Utility class for handling paths in a file system.

  • Field Details

    • SAFE_NAMECHARS

      public static final BitSet SAFE_NAMECHARS
      The list of characters that are not encoded by the escapeName(String) and unescape(String) methods. They contains the characters which can safely be used in file names:

    • SAFE_PATHCHARS

      public static final BitSet SAFE_PATHCHARS
      The list of characters that are not encoded by the escapePath(String) and unescape(String) methods. They contains the characters which can safely be used in file paths:

  • Method Details

    • escapePath

      public static String escapePath(String path)
      Encodes the specified path. Same as escapeName(String) except that the separator character / is regarded as a legal path character that needs no escaping.
      Parameters:
      path - the path to encode.
      Returns:
      the escaped path

    • escapeName

      public static String escapeName(String name)
      Encodes the specified name. Same as escapePath(String) except that the separator character / is regarded as an illegal character that needs escaping.
      Parameters:
      name - the name to encode.
      Returns:
      the escaped name

    • unescape

      public static String unescape(String pathOrName)
      Decodes the specified path/name.
      Parameters:
      pathOrName - the escaped path/name
      Returns:
      the unescaped path/name

    • denotesRoot

      public static boolean denotesRoot(String path)
      Tests whether the specified path represents the root path, i.e. "/".
      Parameters:
      path - path to test
      Returns:
      true if the specified path represents the root path; false otherwise.

    • checkFormat

      public static void checkFormat(String path) throws FileSystemException
      Checks if path is a valid path.
      Parameters:
      path - the path to be checked
      Throws:
      FileSystemException - If path is not a valid path

    • getParentDir

      public static String getParentDir(String path)
      Returns the parent directory of the specified path.
      Parameters:
      path - a file system path denoting a directory or a file.
      Returns:
      the parent directory.

    • getName

      public static String getName(String path)
      Returns the name of the specified path.
      Parameters:
      path - a file system path denoting a directory or a file.
      Returns:
      the name.