to.etc.util

Class FileTool

java.lang.Object

to.etc.util.FileTool

public class FileTool
extends Object

Contains some often-used file subroutines.

Version:

1.0

Author:

Frits Jalvingh

Method Summary

Modifier and Type	Method and Description
static void	closeAll(Object... list) This attempts to close all of the resources passed to it, without throwing exceptions.
static void	compareDirectories(IDirectoryDelta delta, File a, File b) Compare the content of two directories, and callback methods on changes.
static InputStream	copyAndDumpStream(StringBuilder tgt, InputStream in, String encoding)
static void	copyDir(File destd, File srcd) Copies an entire directory structure from src to dest.
static void	copyFile(File destf, File srcf) Copies a file.
static void	copyFile(OutputStream os, InputStream is) Copies the inputstream to the output stream.
static void	copyFile(Writer w, Reader r) Copy the input reader to the output reader.
static void	copyHardlinked(File targetDir, File sourceDir, String... ignorePaths) Copy a file or directory using hard links.
static void	copyResource(Writer w, Class<?> cl, String rid)
static File	copyStreamToTmpFile(InputStream is)
static File	copyStreamToTmpFile(InputStream is, String name)
static File	createTmpDir()
static void	deleteDir(File f) Delete the directory and all it's contents.
static boolean	dirEmpty(File dirf) Deletes all files in the directory.
static boolean	dirEmpty(File dirf, Vector<Object> elogb) Deprecated.
static String	fileNameSansExtension(String fn) Returns the file name excluding the suffix of the name.
static int	findFilenameExtension(String fn) Returns the start position of the filename extension in the string.
static String	getFileExtension(String fn) Returns the extension of a file.
static int	getIntSizeOfFile(File file) Returns size of a file as int type.
static File	getLogRoot(String appVar) This returns the File location of a directory that should contain application-generated log files.
static int	getNumberOfLines(File file) Returns number of lines in a specified file.
static String	getRelativePath(File root, File other) Calculate the relative path of file in the root passed.
static Reader	getResourceReader(Class<?> root, String name)
static File	getTmpDir() Returns the java.io.tmpdir directory.
static InputStream	getZipContent(File src, String name)
static InputStream	getZipContent(InputStream zipis, String name) Returns a stream which is the uncompressed data stream for a zip file component.
static List<String>	getZipDirectory(File in)
static byte[]	hashBuffers(byte[][] data) Create an MD5 hash for a buffer set.
static String	hashBuffersHex(byte[][] data) Create a HEX MD5 hash for a buffer set.
static byte[]	hashFile(File f) Create an MD5 hash for a file's contents.
static byte[]	hashFile(InputStream is) Hashes all data from an input stream and returns an MD5 hash.
static String	hashFileHex(File f) Hash a file and return it's hex MD5hash.
static String	hashFileHex(InputStream is) Hash an InputStream and return it's hex MD5hash.
static String	hashTextFile(File f) Hashes all data from an input stream and returns an MD5 hash in hex.
static byte[]	hashTextFile(InputStream is) Hashes all data from an input stream and returns an MD5 hash.
static byte[]	loadArray(File src)
static byte[][]	loadByteBuffers(File in) Load an entire file in a byte buffer set.
static byte[][]	loadByteBuffers(InputStream is) Loads a byte[][] from an input stream until exhaustion.
static Properties	loadProperties(File f) Load a file as a Properties file.
static Properties	loadPropertiesFromZip(File f, String name) Opens the jar file and tries to load the plugin.properties file from it.
static Properties	loadPropertiesFromZip(InputStream is, String name) Opens the jar file and tries to load the plugin.properties file from it.
static Object	loadSerialized(File f) Load a single serialized object from a file.
static Object	loadSerialized(InputStream is) Load a single serialized object from a datastream.
static Object	loadSerializedNullOnError(File f)
static Object	loadSerializedNullOnError(InputStream is) Load a serialized object, and return null on any load exception.
static Document	loadXmlFromZip(File f, String name, boolean nsaware) Opens the jar file and tries to load the plugin.properties file from it.
static Document	loadXmlFromZip(InputStream is, String ident, String name, boolean nsaware) Opens the jar file and tries to load the plugin.properties file from it.
static ClassLoader	makeJarLoader(File f) Creates a classloader to load data from the given jar file.
static ClassLoader	makeJarLoader(File f, ClassLoader parent)
static File	makeTempFile(File root) Create a temp file within the specified root directory.
static File	newDir(File root) Create a temp directory within the root directory.
static void	prepareDir(File dir) prepare a directory in this way: if it does not exist, create it.
static String	readAsString(Clob data) Returns the string from specified Clob.
static byte[]	readByteArray(InputStream is)
static byte[]	readFileAsByteArray(File file) Read a file's contents as byte[].
static void	readFileAsString(Appendable o, File f)
static String	readFileAsString(File f) Read a file's contents in a string using the default encoding of the platform.
static String	readFileAsString(File f, String encoding) Read a file into a string using the specified encoding.
static void	readHeadAndTail(StringBuffer sb, File f, int headsize, int tailsize) mbp, moved here from old DaemonBase with some adaptions.
static int	readInt(InputStream is) Reads a 4-byte bigendian int off the connection.
static long	readLong(InputStream is)
static byte[]	readResourceAsByteArray(Class<?> clz, String name) Load a class resource as a byte array.
static String	readResourceAsString(Class<?> base, String name, String encoding)
static void	readStreamAsString(Appendable o, InputStream f, String enc)
static void	readStreamAsString(Appendable o, Reader r)
static String	readStreamAsString(InputStream is, String enc)
static String	readStreamAsString(Reader r)
static String	readString(InputStream is)
static void	save(File of, byte[] data) Save the data in byte array to a file.
static void	save(File of, byte[][] data) Save the data in byte buffers to a file.
static void	save(OutputStream os, byte[][] data) Save the data in byte buffers to an output stream.
static void	saveBlob(File out, Blob in) Saves blob into specified file.
static void	saveProperties(File f, Properties p) Save a properties file.
static void	saveSerialized(File f, Serializable obj)
static void	saveSerialized(OutputStream os, Serializable obj) Save a serializable object to a datastream.
static void	unzip(File dest, File zipfile) Unzip the contents of the zipfile to the directory.
static void	unzip(File dest, InputStream is)
static InputStream	wrapInputStream(InputStream rawStream, ILogSink s, int maxinmemory)
static void	writeFileFromString(File f, String v, String enc)
static void	writeFileFromString(OutputStream os, String v, String enc)
static void	writeInt(OutputStream os, int val) Sends an int fragment
static void	writeLong(OutputStream os, long val) Sends a long
static void	writeString(OutputStream os, String s)
static void	zip(File zipfile, File dir) Zip the contents of dir or file to the zipfile.
static void	zipAppend(ZipOutputStream zos, String fileName, File f)

Methods inherited from class java.lang.Object

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

Method Detail

getLogRoot

@Nonnull
public static File getLogRoot(@Nonnull
                                       String appVar)

This returns the File location of a directory that should contain application-generated log files. This should be used instead of /tmp to allocate log files where needed. It checks for several default locations.

Returns:

getTmpDir

public static File getTmpDir()

Returns the java.io.tmpdir directory. Throws an exception if it does not exist or is inaccessible.

Returns:

newDir

public static File newDir(File root)

Create a temp directory within the root directory.

Parameters:

root -

Returns:

makeTempFile

public static File makeTempFile(File root)

Create a temp file within the specified root directory.

Parameters:

root -

Returns:

dirEmpty

public static boolean dirEmpty(File dirf)

Deletes all files in the directory. It skips errors and tries to delete as much as possible. If elogb is not null then all errors are written there.

deleteDir

public static void deleteDir(File f)

Delete the directory and all it's contents.

Parameters:

f -

prepareDir

public static void prepareDir(File dir)
                       throws Exception

prepare a directory in this way: if it does not exist, create it. if it does exist then delete all files from the dir.

Parameters:

dir - the directory that must be made existent

Throws:

Exception - when creation fails or when removing old contents fails.

dirEmpty

@Deprecated
public static boolean dirEmpty(File dirf,
                                           Vector<Object> elogb)

Deprecated.

Deletes all files in the directory. It skips errors and tries to delete as much as possible. If elogb is not null then all errors are written there.

getFileExtension

@Nonnull
public static String getFileExtension(String fn)

Returns the extension of a file. The extension DOES NOT INCLUDE the . If no extension is present then the empty string is returned ("").

findFilenameExtension

public static int findFilenameExtension(String fn)

Returns the start position of the filename extension in the string. If the string has no extension then this returns -1.

fileNameSansExtension

@Nonnull
public static String fileNameSansExtension(String fn)

Returns the file name excluding the suffix of the name. So test.java returns test.

copyFile

public static void copyFile(File destf,
                            File srcf)
                     throws IOException

Copies a file.

Parameters:

destf - the destination

srcf - the source

Throws:

IOException - the error

copyFile

public static void copyFile(OutputStream os,
                            InputStream is)
                     throws IOException

Copies the inputstream to the output stream.

Parameters:

destf - the destination

srcf - the source

Throws:

IOException - the error

copyFile

public static void copyFile(Writer w,
                            Reader r)
                     throws IOException

Copy the input reader to the output reader.

Parameters:

w -

r -

Throws:

IOException

copyDir

public static void copyDir(File destd,
                           File srcd)
                    throws IOException

Copies an entire directory structure from src to dest. This copies the files from src into destd; it does not remove files in destd that are not in srcd. Use synchronizeDir() for that.

Parameters:

destd -

srcd -

Throws:

IOException

copyHardlinked

public static void copyHardlinked(@Nonnull
                                  File targetDir,
                                  @Nonnull
                                  File sourceDir,
                                  String... ignorePaths)
                           throws IOException

Copy a file or directory using hard links.

Parameters:

targetDir -

sourceDir -

Throws:

IOException

readFileAsString

public static String readFileAsString(File f)
                               throws Exception

Read a file's contents in a string using the default encoding of the platform.

Parameters:

f -

Returns:

Throws:

Exception

readFileAsByteArray

public static byte[] readFileAsByteArray(@Nonnull
                                         File file)
                                  throws IOException

Read a file's contents as byte[].

Parameters:

f -

Returns:

Throws:

IOException

Exception

readByteArray

@Nonnull
public static byte[] readByteArray(@Nonnull
                                            InputStream is)
                                     throws Exception

Throws:

Exception

readResourceAsByteArray

@Nullable
public static byte[] readResourceAsByteArray(@Nonnull
                                                       Class<?> clz,
                                                       @Nonnull
                                                       String name)
                                                throws IOException

Load a class resource as a byte array. If the resource is not found this returns null.

Parameters:

clz -

name -

Returns:

Throws:

IOException

readFileAsString

public static void readFileAsString(Appendable o,
                                    File f)
                             throws Exception

Parameters:

o -

f -

Throws:

Exception

readFileAsString

public static String readFileAsString(File f,
                                      String encoding)
                               throws Exception

Read a file into a string using the specified encoding.

Parameters:

f -

encoding -

Returns:

Throws:

Exception

readHeadAndTail

public static void readHeadAndTail(StringBuffer sb,
                                   File f,
                                   int headsize,
                                   int tailsize)
                            throws Exception

mbp, moved here from old DaemonBase with some adaptions. Reads the head and tail lines of a text file into the stringbuffer. The number of lines in the head is at most "headsize". If this count is exceeded the read lines will be placed in a circular string buffer of size "tailsize", and appended to the stringbuffer when the whole file has been processed. Note that if headsize plus tailsize exceeds the actual number of lines, this means that the whole file will be placed in the stringbuffer. Intended use is to mail (excerpts from) logfiles from Daemon processes.

Throws:

Exception

copyStreamToTmpFile

public static File copyStreamToTmpFile(InputStream is,
                                       String name)
                                throws Exception

Parameters:

is -

Returns:

Throws:

Exception

copyStreamToTmpFile

public static File copyStreamToTmpFile(InputStream is)
                                throws Exception

Parameters:

is -

Returns:

Throws:

Exception

readStreamAsString

public static String readStreamAsString(InputStream is,
                                        String enc)
                                 throws Exception

Throws:

Exception

readStreamAsString

public static void readStreamAsString(Appendable o,
                                      InputStream f,
                                      String enc)
                               throws Exception

Throws:

Exception

readStreamAsString

public static void readStreamAsString(Appendable o,
                                      Reader r)
                               throws Exception

Throws:

Exception

readStreamAsString

public static String readStreamAsString(Reader r)
                                 throws Exception

Throws:

Exception

writeFileFromString

public static void writeFileFromString(File f,
                                       String v,
                                       String enc)
                                throws Exception

Throws:

Exception

writeFileFromString

public static void writeFileFromString(OutputStream os,
                                       String v,
                                       String enc)
                                throws Exception

Throws:

Exception

readResourceAsString

@Nonnull
public static final String readResourceAsString(Class<?> base,
                                                         String name,
                                                         String encoding)
                                                  throws Exception

Throws:

Exception

hashFile

@Nonnull
public static byte[] hashFile(File f)
                                throws IOException

Create an MD5 hash for a file's contents.

Throws:

IOException

hashBuffers

@Nonnull
public static byte[] hashBuffers(byte[][] data)

Create an MD5 hash for a buffer set.

Parameters:

data -

Returns:

hashBuffersHex

@Nonnull
public static String hashBuffersHex(byte[][] data)

Create a HEX MD5 hash for a buffer set.

Parameters:

data -

Returns:

hashFile

@Nonnull
public static byte[] hashFile(InputStream is)
                                throws IOException

Hashes all data from an input stream and returns an MD5 hash.

Parameters:

is - The stream to read and hash.

Returns:

A hash (16 bytes MD5)

Throws:

IOException

hashFileHex

@Nonnull
public static String hashFileHex(File f)
                                   throws IOException

Hash a file and return it's hex MD5hash.

Parameters:

f -

Returns:

Throws:

IOException

hashFileHex

@Nonnull
public static String hashFileHex(InputStream is)
                                   throws IOException

Hash an InputStream and return it's hex MD5hash.

Parameters:

is -

Returns:

Throws:

IOException

hashTextFile

@Nonnull
public static String hashTextFile(@Nonnull
                                           File f)
                                    throws IOException

Hashes all data from an input stream and returns an MD5 hash in hex. This hashes the file but replaces all cr or crlf or lfcr with a single lf.

Parameters:

f -

Returns:

Throws:

IOException

hashTextFile

@Nonnull
public static byte[] hashTextFile(@Nonnull
                                           InputStream is)
                                    throws IOException

Hashes all data from an input stream and returns an MD5 hash. This hashes the file but replaces all cr or crlf or lfcr with a single lf.

Parameters:

is - The stream to read and hash.

Returns:

A hash (16 bytes MD5)

Throws:

IOException

loadProperties

@Nonnull
public static Properties loadProperties(File f)
                                          throws Exception

Load a file as a Properties file.

Parameters:

f -

Returns:

Throws:

Exception

saveProperties

public static void saveProperties(File f,
                                  Properties p)
                           throws Exception

Save a properties file.

Parameters:

f -

p -

Throws:

Exception

loadPropertiesFromZip

public static Properties loadPropertiesFromZip(File f,
                                               String name)
                                        throws Exception

Opens the jar file and tries to load the plugin.properties file from it.

Parameters:

f -

Returns:

Throws:

Exception

loadPropertiesFromZip

public static Properties loadPropertiesFromZip(InputStream is,
                                               String name)
                                        throws Exception

Opens the jar file and tries to load the plugin.properties file from it.

Parameters:

f -

Returns:

Throws:

Exception

loadXmlFromZip

public static Document loadXmlFromZip(File f,
                                      String name,
                                      boolean nsaware)
                               throws Exception

Opens the jar file and tries to load the plugin.properties file from it.

Parameters:

f -

Returns:

Throws:

Exception

loadXmlFromZip

public static Document loadXmlFromZip(InputStream is,
                                      String ident,
                                      String name,
                                      boolean nsaware)
                               throws Exception

Opens the jar file and tries to load the plugin.properties file from it.

Parameters:

f -

Returns:

Throws:

Exception

makeJarLoader

public static ClassLoader makeJarLoader(File f)
                                 throws MalformedURLException

Creates a classloader to load data from the given jar file.

Parameters:

f -

Returns:

Throws:

MalformedURLException

Exception

makeJarLoader

public static ClassLoader makeJarLoader(File f,
                                        ClassLoader parent)
                                 throws MalformedURLException

Throws:

MalformedURLException

copyResource

public static void copyResource(Writer w,
                                Class<?> cl,
                                String rid)
                         throws Exception

Throws:

Exception

zip

public static void zip(File zipfile,
                       File dir)
                throws Exception

Zip the contents of dir or file to the zipfile. The zipfile is deleted before the new contents are added to it.

Throws:

Exception

zipAppend

public static void zipAppend(ZipOutputStream zos,
                             String fileName,
                             File f)
                      throws IOException

Throws:

IOException

unzip

public static void unzip(File dest,
                         InputStream is)
                  throws Exception

Throws:

Exception

unzip

public static void unzip(File dest,
                         File zipfile)
                  throws Exception

Unzip the contents of the zipfile to the directory. The directory is created if it does not yet exist.

Throws:

Exception

getZipDirectory

@Nonnull
public static List<String> getZipDirectory(@Nonnull
                                                    File in)
                                             throws Exception

Throws:

Exception

getZipContent

@Nullable
public static InputStream getZipContent(File src,
                                                  String name)
                                           throws IOException

Throws:

IOException

getZipContent

@Nullable
public static InputStream getZipContent(@Nonnull
                                                  InputStream zipis,
                                                  @Nonnull
                                                  String name)
                                           throws IOException

Returns a stream which is the uncompressed data stream for a zip file component.

Parameters:

zipis -

Returns:

Throws:

IOException

loadByteBuffers

@Nonnull
public static byte[][] loadByteBuffers(@Nonnull
                                                InputStream is)
                                         throws IOException

Loads a byte[][] from an input stream until exhaustion.

Parameters:

is -

Returns:

Throws:

IOException

loadByteBuffers

public static byte[][] loadByteBuffers(File in)
                                throws IOException

Load an entire file in a byte buffer set.

Parameters:

in -

Returns:

Throws:

IOException

save

public static void save(File of,
                        byte[][] data)
                 throws IOException

Save the data in byte buffers to a file.

Parameters:

of -

data -

Throws:

IOException

save

public static void save(OutputStream os,
                        byte[][] data)
                 throws IOException

Save the data in byte buffers to an output stream.

Parameters:

os -

data -

Throws:

IOException

loadArray

@Nonnull
public static byte[] loadArray(@Nonnull
                                        File src)
                                 throws IOException

Throws:

IOException

save

public static void save(File of,
                        byte[] data)
                 throws IOException

Save the data in byte array to a file.

Parameters:

of -

data -

Throws:

IOException

writeInt

public static void writeInt(OutputStream os,
                            int val)
                     throws IOException

Sends an int fragment

Parameters:

val -

Throws:

Exception

IOException

writeLong

public static void writeLong(OutputStream os,
                             long val)
                      throws IOException

Sends a long

Parameters:

val -

Throws:

Exception

IOException

writeString

public static void writeString(OutputStream os,
                               String s)
                        throws IOException

Throws:

IOException

readInt

public static int readInt(InputStream is)
                   throws IOException

Reads a 4-byte bigendian int off the connection.

Returns:

Throws:

Exception

IOException

readLong

public static long readLong(InputStream is)
                     throws IOException

Throws:

IOException

readString

public static String readString(InputStream is)
                         throws IOException

Throws:

IOException

wrapInputStream

public static InputStream wrapInputStream(InputStream rawStream,
                                          ILogSink s,
                                          int maxinmemory)
                                   throws Exception

Throws:

Exception

copyAndDumpStream

public static InputStream copyAndDumpStream(StringBuilder tgt,
                                            InputStream in,
                                            String encoding)
                                     throws IOException

Throws:

IOException

saveSerialized

public static void saveSerialized(@WillClose
                                  OutputStream os,
                                  Serializable obj)
                           throws IOException

Save a serializable object to a datastream.

Parameters:

os -

obj -

Throws:

IOException

saveSerialized

public static void saveSerialized(File f,
                                  Serializable obj)
                           throws IOException

Throws:

IOException

loadSerialized

@Nullable
public static Object loadSerialized(@WillNotClose
                                              InputStream is)
                                       throws IOException,
                                              ClassNotFoundException

Load a single serialized object from a datastream.

Parameters:

is -

Returns:

Throws:

IOException

ClassNotFoundException

loadSerialized

@Nullable
public static Object loadSerialized(File f)
                                       throws IOException,
                                              ClassNotFoundException

Load a single serialized object from a file.

Parameters:

f -

Returns:

Throws:

IOException

ClassNotFoundException

loadSerializedNullOnError

@Nullable
public static Object loadSerializedNullOnError(@WillNotClose
                                                         InputStream is)

Load a serialized object, and return null on any load exception.

Parameters:

is -

Returns:

loadSerializedNullOnError

@Nullable
public static Object loadSerializedNullOnError(File f)
                                                  throws IOException,
                                                         ClassNotFoundException

Throws:

IOException

ClassNotFoundException

closeAll

public static void closeAll(@WillClose
                            Object... list)

This attempts to close all of the resources passed to it, without throwing exceptions. It is meant to be used from finally clauses. Please take care: objects that require a succesful close (like writers or outputstreams) should NOT be closed by this method! They must be closed using a normal close within the exception handler. This list can also contain File objects; these files/directories will be deleted.

Parameters:

list -

compareDirectories

public static void compareDirectories(IDirectoryDelta delta,
                                      File a,
                                      File b)
                               throws Exception

Compare the content of two directories, and callback methods on changes. The callbacks define what needs to be done to change "a" (old) into "b" (new).

Throws:

Exception

saveBlob

public static void saveBlob(@Nonnull
                            File out,
                            @Nonnull
                            Blob in)
                     throws Exception

Saves blob into specified file.

Parameters:

out -

in -

Throws:

Exception

getIntSizeOfFile

public static int getIntSizeOfFile(@Nonnull
                                   File file)

Returns size of a file as int type. In case of Integer range overflow Integer.MAX_VALUE, throws IllegalStateException. This can be used on files with expected size less then 2GB.

Parameters:

file -

Returns:

createTmpDir

@Nonnull
public static File createTmpDir()
                                  throws IOException

Throws:

IOException

getNumberOfLines

public static int getNumberOfLines(@Nonnull
                                   File file)
                            throws IOException

Returns number of lines in a specified file.

Parameters:

file -

Returns:

Throws:

IOException

getRelativePath

@Nullable
public static String getRelativePath(@Nonnull
                                               File root,
                                               @Nonnull
                                               File other)

Calculate the relative path of file in the root passed.

Parameters:

root -

other -

Returns:

Throws:

Exception

getResourceReader

@Nonnull
public static Reader getResourceReader(@Nonnull
                                                Class<?> root,
                                                @Nullable
                                                String name)

readAsString

@Nonnull
public static String readAsString(@Nonnull
                                           Clob data)
                                    throws IOException,
                                           SQLException

Returns the string from specified Clob.

Parameters:

data -

Returns:

Throws:

SQLException

IOException