public class FileTools extends Object
Modifier and Type | Field and Description |
---|---|
protected static String[] |
DATA_EXTENSIONS |
static String |
DEFAULT_DATA_EXTENSION |
static String |
DEFAULT_IMAGE_EXTENSION |
static String |
DEFAULT_XML_EXTENSION |
protected static String |
GIF_EXTENSION |
protected static String[] |
IMAGE_EXTENSIONS |
protected static String[] |
XML_EXTENSIONS |
Constructor and Description |
---|
FileTools() |
Modifier and Type | Method and Description |
---|---|
static String |
addDataExtension(String filename) |
static String |
addImageExtension(String filename) |
static String |
changeExtension(String filename,
String newExtension) |
static void |
checkPathIsReadableFile(String file) |
static String |
chompExtension(String filename) |
static String |
cleanForFileName(String name)
Avoid getting file names with spaces, slashes, quotes, # etc; replace them with "_".
|
static void |
copy(InputStream input,
OutputStream output)
On completion streams are closed.
|
static File |
copyPlainOrCompressedFile(String sourcePath,
String outputFilePath) |
static File |
createDir(String directory)
Creates the directory if it does not exist.
|
static int |
deleteDir(File directory)
Deletes the directory and subdirectories if empty.
|
static int |
deleteFiles(Collection<File> files)
Deletes the specified Collection of files.
|
static String |
getExtension(String filename)
Returns the extension of a file.
|
static InputStream |
getInputStreamFromPlainOrCompressedFile(String fileName)
Open a non-compresed, zipped, or gzipped file.
|
static List<String> |
getLines(File file)
opens a file and returns its contents as a list of lines.
|
static List<String> |
getLines(String filename)
opens a file and returns its contents as a list of lines.
|
static List<String> |
getStringListFromFile(File f)
Used for reading output generated by Collection.toString().
|
static boolean |
hasImageExtension(String filename) |
static boolean |
hasXMLExtension(String filename) |
static boolean |
isGZipped(String fileName) |
static boolean |
isZipped(String filename) |
static Collection<File> |
listDirectoryFiles(File directory)
Given a File object representing a directory, return a collection of File objects representing the files
contained in that directory.
|
static Collection<File> |
listSubDirectories(File directory)
Given a File object representing a directory, return a collection of File objects representing the directories
contained in that directory.
|
static String |
resourceToPath(String resourcePath) |
static void |
stringsToFile(Collection<String> lines,
File f)
Outputs a many strings to a file, one line at a time.
|
static void |
stringsToFile(Collection<String> lines,
File f,
boolean append)
Outputs many strings to a file, one line at a time.
|
static void |
stringsToFile(Collection<String> lines,
String f)
Outputs a many strings to a file, one line at a time.
|
static void |
stringToFile(String s,
File f)
Outputs a string to a file.
|
static void |
stringToFile(String s,
File f,
boolean append)
Outputs a string to a file, one line at a time.
|
static boolean |
testDir(String dirname) |
static boolean |
testFile(File file)
Test whether a File is writeable.
|
static boolean |
testFile(String filename) |
static void |
touch(File f)
Create or update the modification date of the given file.
|
static String |
unGzipFile(String seekFile)
Given the path to a gzipped-file, unzips it into the same directory.
|
static Collection<File> |
unZipFiles(String seekFile) |
public static final String DEFAULT_DATA_EXTENSION
public static final String DEFAULT_IMAGE_EXTENSION
public static final String DEFAULT_XML_EXTENSION
protected static final String[] DATA_EXTENSIONS
protected static final String GIF_EXTENSION
protected static final String[] IMAGE_EXTENSIONS
protected static final String[] XML_EXTENSIONS
public static String addDataExtension(String filename)
filename
- filename
parameter.public static String addImageExtension(String filename)
filename
- filename
parameter.public static String changeExtension(String filename, String newExtension)
filename
- newExtension
- filename
parameter.public static void checkPathIsReadableFile(String file) throws IOException
file
- IOException
public static String cleanForFileName(String name)
ee
- IllegalArgumentException
- if the resulting string is empty, or if the input is empty.public static void copy(InputStream input, OutputStream output) throws IOException
input
- output
- IOException
public static File copyPlainOrCompressedFile(String sourcePath, String outputFilePath) throws FileNotFoundException, IOException
sourcePath
- outputFilePath
- FileNotFoundException
IOException
public static File createDir(String directory)
directory
- public static int deleteDir(File directory)
directory
- File.delete()
public static int deleteFiles(Collection<File> files)
files
- File.delete()
public static String getExtension(String filename)
filename
- public static InputStream getInputStreamFromPlainOrCompressedFile(String fileName) throws IOException, FileNotFoundException
fileName.
- If Zipped, only the first file in the archive is used.IOException
FileNotFoundException
public static List<String> getLines(File file) throws IOException
IOException
public static List<String> getLines(String filename) throws IOException
IOException
public static List<String> getStringListFromFile(File f) throws Exception
Warning this relies on behaviour of other API's toString.
f
- - input file, with only one line for the toString output.Exception
public static boolean hasImageExtension(String filename)
filename
- public static boolean hasXMLExtension(String filename)
filename
- public static boolean isGZipped(String fileName)
fileName
- public static boolean isZipped(String filename)
filename
- public static Collection<File> listDirectoryFiles(File directory)
directory
- public static Collection<File> listSubDirectories(File directory)
directory
- public static String resourceToPath(String resourcePath) throws URISyntaxException
resourcePath
- URISyntaxException
public static void stringsToFile(Collection<String> lines, File f) throws Exception
Exception
public static void stringsToFile(Collection<String> lines, File f, boolean append) throws Exception
lines
- - input linesf
- - file that wrote toappend
- - add to end of file or overwriteException
public static void stringsToFile(Collection<String> lines, String f) throws Exception
Exception
public static void stringToFile(String s, File f) throws Exception
Exception
public static void stringToFile(String s, File f, boolean append) throws Exception
s
- - input line/stringf
- - file that wrote toappend
- - add to end of file or overwriteException
public static boolean testDir(String dirname)
dirname
- directory namepublic static boolean testFile(File file)
file
- public static boolean testFile(String filename)
filename
- public static void touch(File f) throws IOException
f
- IOException
public static String unGzipFile(String seekFile) throws IOException
seekFile
- IOException
public static Collection<File> unZipFiles(String seekFile) throws IOException
seekFile
- IOException
Copyright © 2003–2023 UBC Michael Smith Laboratories. All rights reserved.