Return the path within a base directory : Path « File Input Output « Java

Return the path within a base directory


 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * See the License for the specific language governing permissions and
 * limitations under the License.

public class Main {

   * Return the path within a base directory
  public static String getContextFilePath(String directoryPath, String filePath) {
      try {
          File directory = new File(directoryPath);
          File file = new File(filePath);

          directoryPath = directory.getCanonicalPath();
          filePath = file.getCanonicalPath();

          // If the context directory does not have a File.separator
          // at the end then add one explicitly
              directoryPath += File.separator;

          // If the context dir contains both kinds of separator
          // then standardize on using the File.separator
          if ((directoryPath.indexOf('/') !=-1) && (directoryPath.indexOf('\\') !=-1)) {
              directoryPath = directoryPath.replace('\\', File.separator.charAt(0));
              directoryPath = directoryPath.replace('/', File.separator.charAt(0));

          // If the file path contains both kinds of separator
          // then standardize on using the File.separator
          if ((filePath.indexOf('/') !=-1) && (filePath.indexOf('\\') !=-1)) {
              filePath = filePath.replace('\\', File.separator.charAt(0));
              filePath = filePath.replace('/', File.separator.charAt(0));

          if (filePath.startsWith(directoryPath)) {
              filePath = filePath.substring(directoryPath.length());
      } catch (Exception e){
          // ignore

      return filePath;


Related examples in the same category

1.Returns the path of the given resource.
2.Remove path and file information from a filename returning only its extension component
3.Absolutize a relative resource path on the given absolute base path.
4.Remove File Name SuffixRemove File Name Suffix
5.A utility class for manipulating paths
6.Strip File Extension
7.Get relative path
8.Fixes the file sperator char for the target platform using the following replacement.
9.Concatenates an array of string using a seperator.
10.Rename To Temporary Name
11.Match a path which may contain a wildcard
12.Merges the two paths to create a valid version of the second path
13.General filename and filepath manipulation utilities
14.Extract File Extension
15.Get File Name SuffixGet File Name Suffix
16.Extract the page path from the given request path
17.File name Utils
18.Convert a list of path elements to a platform-specific path.
19.Change File Name To Class NameChange File Name To Class Name
20.strip Extension name
21.Create File Name with specified white space character
22.Build a relative path to the given base path
23.Checks, whether the child directory is a subdirectory of the base directory.
24.Return a context-relative path, beginning with a "/", that represents the canonical version of the specified path after ".." and "." elements are resolved out.
25.Decode a path.
26.Convert a path to a cananonical form
27.Extract file name (without path and suffix) from file name with path and suffix
28.Extract file name (without path but with suffix) from file name with path and suffix
29.Build a path, but do not create it
30.Build a directory path - creating directories if neccesary
31.Collection of file path related stuff
32.Path Util
33.Get the first/last token from a path
34.Calculates the relative path between a specified root directory and a target path.
35.Get relative Path