View Javadoc
1   // ******************************************************************************
2   //
3   // Title:       Force Field X.
4   // Description: Force Field X - Software for Molecular Biophysics.
5   // Copyright:   Copyright (c) Michael J. Schnieders 2001-2024.
6   //
7   // This file is part of Force Field X.
8   //
9   // Force Field X is free software; you can redistribute it and/or modify it
10  // under the terms of the GNU General Public License version 3 as published by
11  // the Free Software Foundation.
12  //
13  // Force Field X is distributed in the hope that it will be useful, but WITHOUT
14  // ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
15  // FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
16  // details.
17  //
18  // You should have received a copy of the GNU General Public License along with
19  // Force Field X; if not, write to the Free Software Foundation, Inc., 59 Temple
20  // Place, Suite 330, Boston, MA 02111-1307 USA
21  //
22  // Linking this library statically or dynamically with other modules is making a
23  // combined work based on this library. Thus, the terms and conditions of the
24  // GNU General Public License cover the whole combination.
25  //
26  // As a special exception, the copyright holders of this library give you
27  // permission to link this library with independent modules to produce an
28  // executable, regardless of the license terms of these independent modules, and
29  // to copy and distribute the resulting executable under terms of your choice,
30  // provided that you also meet, for each linked independent module, the terms
31  // and conditions of the license of that module. An independent module is a
32  // module which is not derived from or based on this library. If you modify this
33  // library, you may extend this exception to your version of the library, but
34  // you are not obligated to do so. If you do not wish to do so, delete this
35  // exception statement from your version.
36  //
37  // ******************************************************************************
38  package ffx.utilities;
39  
40  import static java.io.File.createTempFile;
41  import static java.nio.file.Paths.get;
42  
43  import java.io.BufferedOutputStream;
44  import java.io.File;
45  import java.io.FileOutputStream;
46  import java.io.IOException;
47  import java.io.InputStream;
48  import java.io.OutputStream;
49  import java.nio.file.Path;
50  
51  /**
52   * FileUtils class.
53   *
54   * @author Michael J. Schnieders
55   * @since 1.0
56   */
57  public class FileUtils {
58  
59    /**
60     * Private constructor to prevent instantiation.
61     */
62    private FileUtils() {
63      // Empty constructor.
64    }
65  
66    /**
67     * Returns the file name of a temporary copy of <code>input</code> content.
68     *
69     * @param input The input stream contents are copied to a temporary file.
70     * @param prefix Temporary file prefix.
71     * @param name Temporary file name.
72     * @param suffix Temporary file suffix.
73     * @return The temporary file.
74     * @throws java.io.IOException An IOException is thrown if a temporary file could not be created.
75     */
76    public static String copyInputStreamToTmpFile(
77        final InputStream input, String prefix, String name, final String suffix) throws IOException {
78      File tmpFile = null;
79  
80      name = prefix + "." + name + ".";
81      try {
82        tmpFile = createTempFile(name, "." + suffix);
83      } catch (IOException e) {
84        System.out.printf(" Could not extract %s.%n", name);
85        System.err.println(e.getMessage());
86        System.exit(-1);
87      }
88      tmpFile.deleteOnExit();
89  
90      try (input;
91          OutputStream output = new BufferedOutputStream(new FileOutputStream(tmpFile))) {
92        byte[] buffer = new byte[8192];
93        int size;
94        while ((size = input.read(buffer)) != -1) {
95          output.write(buffer, 0, size);
96        }
97      }
98  
99      return tmpFile.toString();
100   }
101 
102   /**
103    * Constructs a relative path from the present working directory to a file.
104    *
105    * @param file Construct a relative path to file.
106    * @return Relative path to file.
107    */
108   public static Path relativePathTo(File file) {
109     File pwd = new File(".");
110     Path pwdPath = get(pwd.getAbsolutePath());
111     Path otherPath = get(file.getAbsolutePath());
112     return pwdPath.relativize(otherPath);
113   }
114 }