info.bioinfweb.commons.io

Class IOUtils

java.lang.Object

info.bioinfweb.commons.io.IOUtils

public class IOUtils
extends java.lang.Object

This class provides general tools for reading and writing data.

Author:

Ben Stöver

Field Summary

Fields

Modifier and Type	Field and Description
static int	EOF

Constructor Summary

Constructors

Constructor and Description
IOUtils()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	absoluteFilePath(java.io.File path, java.io.File baseDirectory) Returns an absolute version of path.
static void	copy(java.io.File src, java.io.File dest) Copies a file.
static void	copy(java.io.File src, java.io.File dest, IOProgressListener progressListener) Copies a file.
static void	copy(java.io.InputStream in, java.io.OutputStream out) Copies data from an InputStream to an OutputStream.
static void	copy(java.io.InputStream in, java.io.OutputStream out, boolean close) Copies data from an InputStream to an OutputStream.
static void	copy(java.io.InputStream in, java.io.OutputStream out, boolean close, IOProgressListener progressListener) Copies data from an InputStream to an OutputStream.
static void	copy(java.io.InputStream in, java.io.OutputStream out, IOProgressListener progressListener) Copies data from an InputStream to an OutputStream.
static void	copyFromResource(java.lang.String path, java.io.OutputStream out) Copies data from an InputStream to a OutputStream.
static void	copyFromResource(java.lang.String path, java.io.OutputStream out, IOProgressListener progressListener) Copies data from an InputStream to a OutputStream.
static long	dirSize(java.util.zip.ZipFile file, java.lang.String path) Calculates the overall uncompressed size of all files included in the specified directory of an archive.
static void	extractDir(java.util.zip.ZipFile file, java.lang.String sourcePath, java.lang.String destPath) Extracts the contents of a directory from an archive (e.g.
static void	extractDir(java.util.zip.ZipFile file, java.lang.String sourcePath, java.lang.String destPath, IOProgressListener progressListener) Extracts the contents of a directory from an archive (e.g.
static void	extractFile(java.util.zip.ZipFile file, java.lang.String path, java.io.File dest) Extracts a file from an archive (e.g.
static void	extractFile(java.util.zip.ZipFile file, java.lang.String path, java.io.File dest, IOProgressListener progressListener) Extracts a file from an archive (e.g.
static void	extractFile(java.util.zip.ZipFile file, java.lang.String path, java.io.OutputStream out) Extracts a file from an archive (e.g.
static void	extractFile(java.util.zip.ZipFile file, java.lang.String path, java.io.OutputStream out, IOProgressListener progressListener) Extracts a file from an archive (e.g.
static java.lang.String	getClassDir(java.lang.Class<?> c)
static java.lang.String	getClassLocation(java.lang.Class<?> c) Returns either the path to the class file of the specified class without the package path or the path top the archive file that contains it (e.g.

Methods inherited from class java.lang.Object

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

Field Detail

EOF

public static final int EOF

See Also:

Constant Field Values

Constructor Detail

IOUtils

public IOUtils()

Method Detail

getClassLocation

public static java.lang.String getClassLocation(java.lang.Class<?> c)

Returns either the path to the class file of the specified class without the package path or the path top the archive file that contains it (e.g. JAR, ZIP, EXE).

Parameters:

c - the class that is contained in the returned JAR-file

Returns:

the path to the class folder or archive

getClassDir

public static java.lang.String getClassDir(java.lang.Class<?> c)

absoluteFilePath

public static java.lang.String absoluteFilePath(java.io.File path,
                                                java.io.File baseDirectory)

Returns an absolute version of path.

If path is already absolute it will be returned directly. Otherwise it will be considered as being relative to baseDirectory.

Parameters:

path - the path to the file or directory to be referenced

baseDirectory - the directory used to create a absolute path if path is a relative path.

Returns:

the absolute path as a String

Throws:

java.lang.IllegalArgumentException - if baseDirectory is not absolute

copy

public static void copy(java.io.InputStream in,
                        java.io.OutputStream out)
                 throws java.io.IOException

Copies data from an InputStream to an OutputStream.

Parameters:

in - the stream to read from

out - the stream to write to

Throws:

java.io.IOException - if an I/O error occurs

copy

public static void copy(java.io.InputStream in,
                        java.io.OutputStream out,
                        boolean close)
                 throws java.io.IOException

Copies data from an InputStream to an OutputStream.

Parameters:

in - the stream to read from

out - the stream to write to

close - defines whether the streams shall be closed after the input stream ended

Throws:

java.io.IOException - if an I/O error occurs

copy

public static void copy(java.io.InputStream in,
                        java.io.OutputStream out,
                        IOProgressListener progressListener)
                 throws java.io.IOException

Copies data from an InputStream to an OutputStream.

Parameters:

in - the stream to read from

out - the stream to write to

progressListener - the progress listener which is informed about the ongoing progress

Throws:

java.io.IOException - if an I/O error occurs

copy

public static void copy(java.io.InputStream in,
                        java.io.OutputStream out,
                        boolean close,
                        IOProgressListener progressListener)
                 throws java.io.IOException

Copies data from an InputStream to an OutputStream.

Parameters:

in - the stream to read from

out - the stream to write to

close - defines whether the streams shall be closed after the input stream ended.

progressListener - the progress listener which is informed about the ongoing progress

Throws:

java.io.IOException - if an I/O error occurs

copy

public static void copy(java.io.File src,
                        java.io.File dest,
                        IOProgressListener progressListener)
                 throws java.io.IOException

Copies a file.

Parameters:

src - the source file

dest - the destination file

progressListener - the progress listener which is informed about the ongoing progress

Throws:

java.io.IOException - if an I/O error occurs

copy

public static void copy(java.io.File src,
                        java.io.File dest)
                 throws java.io.IOException

Copies a file.

Parameters:

src - the source file

dest - the destination file

Throws:

java.io.IOException - if an I/O error occurs

copyFromResource

public static void copyFromResource(java.lang.String path,
                                    java.io.OutputStream out)
                             throws java.io.IOException

Copies data from an InputStream to a OutputStream.

Parameters:

path - the path to the resource

out - the stream to write to

Throws:

java.io.IOException - if an I/O error occurs

copyFromResource

public static void copyFromResource(java.lang.String path,
                                    java.io.OutputStream out,
                                    IOProgressListener progressListener)
                             throws java.io.IOException

Copies data from an InputStream to a OutputStream.

Parameters:

path - the path to the resource

out - the stream to write to

progressListener - the progress listener which is informed about the ongoing progress

Throws:

java.io.IOException - if an I/O error occurs

extractFile

public static void extractFile(java.util.zip.ZipFile file,
                               java.lang.String path,
                               java.io.OutputStream out,
                               IOProgressListener progressListener)
                        throws java.io.IOException

Extracts a file from an archive (e.g. ZIP or JAR).

Parameters:

file - the source archive file

path - the path of the file to extract inside the archive

out - the output stream to write the contents of the file to

progressListener - the progress listener which is informed about the ongoing progress

Throws:

java.io.IOException - if an I/O error occurs

extractFile

public static void extractFile(java.util.zip.ZipFile file,
                               java.lang.String path,
                               java.io.OutputStream out)
                        throws java.io.IOException

Extracts a file from an archive (e.g. ZIP or JAR).

Parameters:

file - the source archive file

path - the path of the file to extract inside the archive

out - the output stream to write the contents of the file to

Throws:

java.io.IOException - if an I/O error occurs

extractFile

public static void extractFile(java.util.zip.ZipFile file,
                               java.lang.String path,
                               java.io.File dest,
                               IOProgressListener progressListener)
                        throws java.io.IOException

Extracts a file from an archive (e.g. ZIP or JAR).

Parameters:

file - the source archive file

path - the path of the file to extract inside the archive

dest - the destination file

progressListener - the progress listener which is informed about the ongoing progress

Throws:

java.io.IOException - if an I/O error occurs

extractFile

public static void extractFile(java.util.zip.ZipFile file,
                               java.lang.String path,
                               java.io.File dest)
                        throws java.io.IOException

Extracts a file from an archive (e.g. ZIP or JAR).

Parameters:

file - the source archive file

path - the path of the file to extract inside the archive

dest - the destination file

Throws:

java.io.IOException - if an I/O error occurs

extractDir

public static void extractDir(java.util.zip.ZipFile file,
                              java.lang.String sourcePath,
                              java.lang.String destPath,
                              IOProgressListener progressListener)
                       throws java.io.IOException

Extracts the contents of a directory from an archive (e.g. ZIP or JAR).

Parameters:

file - the source archive file

sourcePath - the path of the source directory inside the archive (must not start with a "/")

destPath - the path of the destination directory where the extracted files should be stored

progressListener - the progress listener which is informed about the ongoing progress

Throws:

java.io.IOException - if an I/O error occurs

extractDir

public static void extractDir(java.util.zip.ZipFile file,
                              java.lang.String sourcePath,
                              java.lang.String destPath)
                       throws java.io.IOException

Extracts the contents of a directory from an archive (e.g. ZIP or JAR).

Parameters:

file - the source archive file

sourcePath - the path of the source directory inside the archive (must not start with a "/")

destPath - the path of the destination directory where the extracted files should be stored

Throws:

java.io.IOException - if an I/O error occurs

dirSize

public static long dirSize(java.util.zip.ZipFile file,
                           java.lang.String path)

Calculates the overall uncompressed size of all files included in the specified directory of an archive.

Parameters:

file - the source archive file

path - the path of the source directory inside the archive (must not start with a "/")

Returns:

the sum of all uncompressed file-sizes in bytes