org.key_project.util.java

Class IOUtil

java.lang.Object

org.key_project.util.java.IOUtil

public final class IOUtil
extends Object

Provides static methods to work with java IO.

Author:

Martin Hentschel

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	IOUtil.IFileVisitor A visitor which does something with Files.
static class	IOUtil.LineInformation A line information returned from computeLineInformation(File) and computeLineInformation(InputStream).

Field Summary

Fields

Modifier and Type	Field and Description
static int	BUFFER_SIZE The size of used buffers.
static Charset	DEFAULT_CHARSET The default charset to use.

Constructor Summary

Constructors

Modifier	Constructor and Description
private	IOUtil() Forbid instances by this private constructor.

Method Summary

Modifier and Type	Method and Description
static IOUtil.LineInformation[]	computeLineInformation(File file) Computes line information for each text line in the given File.
static IOUtil.LineInformation[]	computeLineInformation(InputStream in) Computes line information for each text line in the given InputStream.
static String	computeMD5(File file) Computes the MD5 checksum of the given File.
static String	computeMD5(InputStream in) Computes the MD5 checksum of the given InputStream and closes it.
static boolean	contains(File parent, File child) Checks if the given parent File contains (recursive) the child File.
static boolean	contains(Iterable<File> parents, File child) Checks if at least one given parent File contains (recursive) the child File.
static boolean	copy(InputStream source, OutputStream target) Copies the content from the InputStream to the OutputStream and closes both streams.
static File	createTempDirectory(String prefix, String suffix) Creates a temporary directory with help of File.createTempFile(String, String).
static void	delete(File file) Deletes the given file/folder with all contained sub files/folders.
static boolean	exists(File file) Checks if the given File exists.
static File	getClassLocation(Class<?> classInstance)
static URL	getClassLocationURL(Class<?> classInstance)
static File	getCurrentDirectory() Returns the current directory.
static String	getFileExtension(File file) Returns the file extension of the given File if available.
static String	getFileNameWithoutExtension(String fileName) Returns the file name without file extension for the given file name with extension.
static File	getHomeDirectory() Returns the home directory.
static File	getProjectRoot(Class<?> classInstance)
static File	getTempDirectory() Returns the temporary directory.
static String	readFrom(File file) Reads the complete content from the File.
static String	readFrom(InputStream in) Reads the complete content from the InputStream and closes it.
static String	readFrom(URL url) Reads the complete content from the URL.
static List<File>	search(File file, IFilter<File> filter) Searches recursive in the given File all Files accepted by the given IFilter.
static File	toFile(URL url)
static String	toFileString(URL url)
static URI	toURI(URL url)
static InputStream	unifyLineBreaks(InputStream in) Replaces all line breaks (\r, \r\n) in the given InputStream with \n.
static String	validateOSIndependentFileName(String name) Ensures that the segment is a valid OS independent path segment meaning that it is a valid file/folder name.
static void	visit(File file, IOUtil.IFileVisitor visitor) Visits recursive all files and folders.
static void	writeTo(OutputStream out, String content) Writes the given content into the given OutputStream and closes it.
static void	writeTo(OutputStream out, String content, Charset encoding) Writes the given content into the given OutputStream and closes it.
static void	writeTo(OutputStream out, String content, String encoding) Writes the given content into the given OutputStream and closes it.

Methods inherited from class java.lang.Object

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

Field Detail

BUFFER_SIZE

public static final int BUFFER_SIZE

The size of used buffers.

See Also:

Constant Field Values

DEFAULT_CHARSET

public static final Charset DEFAULT_CHARSET

The default charset to use. The value is independent from the current operating system.

Constructor Detail

IOUtil

private IOUtil()

Forbid instances by this private constructor.

Method Detail

computeMD5

public static String computeMD5(File file)
                         throws IOException

Computes the MD5 checksum of the given File.

Parameters:

file - The File to compute its MD5 checksum.

Returns:

The computed MD5 checksum.

Throws:

IOException - Occurred Exception.

computeMD5

public static String computeMD5(InputStream in)
                         throws IOException

Computes the MD5 checksum of the given InputStream and closes it.

Parameters:

in - The InputStream which provides the content to compute its MD5 checksum. The InputStream will be closed.

Returns:

The computed MD5 checksum.

Throws:

IOException - Occurred Exception.

getHomeDirectory

public static File getHomeDirectory()

Returns the home directory.

Returns:

The home directory.

getFileExtension

public static String getFileExtension(File file)

Returns the file extension of the given File if available.

Parameters:

file - The file to extract it extension.

Returns:

The file extension or null if not available.

getFileNameWithoutExtension

public static String getFileNameWithoutExtension(String fileName)

Returns the file name without file extension for the given file name with extension.

Parameters:

file - The file name with extension for that the file name without extension is needed.

Returns:

The file name without extension or null if it was not possible to compute it.

delete

public static void delete(File file)

Deletes the given file/folder with all contained sub files/folders.

Parameters:

file - The file/folder to delete.

readFrom

public static String readFrom(URL url)
                       throws IOException

Reads the complete content from the URL.

Parameters:

file - The URL to read from.

Returns:

The read content or null if the URL is null.

Throws:

IOException - Occurred Exception.

readFrom

public static String readFrom(File file)
                       throws IOException

Reads the complete content from the File.

Parameters:

file - The File to read from.

Returns:

The read content or null if the File is null or not an existing file.

Throws:

IOException - Occurred Exception.

readFrom

public static String readFrom(InputStream in)
                       throws IOException

Reads the complete content from the InputStream and closes it.

Parameters:

in - The InputStream to read from and to close.

Returns:

The read content or null if the InputStream is null.

Throws:

IOException - Occurred Exception.

writeTo

public static void writeTo(OutputStream out,
                           String content)
                    throws IOException

Writes the given content into the given OutputStream and closes it. Nothing will be written if the content is null, but the stream will be closed.

Parameters:

out - The OutputStream to write to.

content - The content to write.

Throws:

IOException - Occurred Exception.

writeTo

public static void writeTo(OutputStream out,
                           String content,
                           Charset encoding)
                    throws IOException

Writes the given content into the given OutputStream and closes it. Nothing will be written if the content is null, but the stream will be closed.

Parameters:

out - The OutputStream to write to.

content - The content to write.

Throws:

IOException - Occurred Exception.

writeTo

public static void writeTo(OutputStream out,
                           String content,
                           String encoding)
                    throws IOException

Writes the given content into the given OutputStream and closes it. Nothing will be written if the content is null, but the stream will be closed.

Parameters:

out - The OutputStream to write to.

content - The content to write.

encoding - The encoding to use.

Throws:

IOException - Occurred Exception.

computeLineInformation

public static IOUtil.LineInformation[] computeLineInformation(File file)
                                                       throws IOException

Computes line information for each text line in the given File. A IOUtil.LineInformation consists of the offset from the beginning of the file for each line and the indices of tabs '\t' in each line.

Example content, line break is '\n':

 Line 1
 Line 2: With some text
 
 Line 4
 

Computed line start indices:

 result[0] = new LineInformation(0, new int[0]);
 result[1] = new LineInformation(7, new int[] {7});
 result[2] = new LineInformation(30, new int[0]);
 result[3] = new LineInformation(31, new int[0]);
 

Parameters:

file - The given File.

Returns:

The computed start indices.

Throws:

IOException - Occurred Exception.

computeLineInformation

public static IOUtil.LineInformation[] computeLineInformation(InputStream in)
                                                       throws IOException

Computes line information for each text line in the given InputStream. A IOUtil.LineInformation consists of the offset from the beginning of the file for each line and the indices of tabs '\t' in each line.

Example content, line break is '\n':

 Line 1
 Line 2:\tWith some text
 
 Line 4
 

Computed line start indices:

 result[0] = new LineInformation(0, new int[0]);
 result[1] = new LineInformation(7, new int[] {7});
 result[2] = new LineInformation(30, new int[0]);
 result[3] = new LineInformation(31, new int[0]);
 

Parameters:

file - The given File.

Returns:

The computed start indices.

Throws:

IOException - Occurred Exception.

createTempDirectory

public static File createTempDirectory(String prefix,
                                       String suffix)
                                throws IOException

Creates a temporary directory with help of File.createTempFile(String, String).

Parameters:

prefix - The prefix string to be used in generating the file's name; must be at least three characters long.

suffix - The suffix string to be used in generating the file's name; may be null, in which case the suffix ".tmp" will be used.

Returns:

Created temporary directory.

Throws:

IOException - Occurred Exception.

search

public static List<File> search(File file,
                                IFilter<File> filter)
                         throws IOException

Searches recursive in the given File all Files accepted by the given IFilter.

Parameters:

file - The File to start search in.

filter - An optional IFilter used to accept files. Without a filter all Files are accepted.

Returns:

The accepted Files.

Throws:

IOException - Occurred Exception

visit

public static void visit(File file,
                         IOUtil.IFileVisitor visitor)
                  throws IOException

Visits recursive all files and folders.

Parameters:

file - The File to start in.

visitor - The IOUtil.IFileVisitor which does something with the visited files

Throws:

IOException - Occurred Exception

unifyLineBreaks

public static InputStream unifyLineBreaks(InputStream in)
                                   throws IOException

Replaces all line breaks (\r, \r\n) in the given InputStream with \n.

Parameters:

in - The InputStream to replace line breaks in.

Returns:

A new InputStream with with the replaced line breaks.

Throws:

IOException - Occurred Exception.

contains

public static boolean contains(Iterable<File> parents,
                               File child)

Checks if at least one given parent File contains (recursive) the child File.

Parameters:

parents - The parent File.

child - The child File to check for containment in parents.

Returns:

true child is contained (recursive) in at least one parent, false child is not contained in any parent.

contains

public static boolean contains(File parent,
                               File child)

Checks if the given parent File contains (recursive) the child File.

Parameters:

parent - The parent File.

child - The child File to check for containment in parent.

Returns:

true child is contained (recursive) in parent, false child is not contained in parent.

copy

public static boolean copy(InputStream source,
                           OutputStream target)
                    throws IOException

Copies the content from the InputStream to the OutputStream and closes both streams.

Parameters:

source - The InputStream to read from.

target - The OutputStream to write to.

Returns:

true if copy was performed and false if not performed.

Throws:

IOException - Occurred Exception.

exists

public static boolean exists(File file)

Checks if the given File exists.

Parameters:

file - The File to check.

Returns:

true File is not null and exists, false otherwise.

getClassLocationURL

public static final URL getClassLocationURL(Class<?> classInstance)

getClassLocation

public static final File getClassLocation(Class<?> classInstance)

getProjectRoot

public static final File getProjectRoot(Class<?> classInstance)

toFile

public static File toFile(URL url)

toFileString

public static String toFileString(URL url)

toURI

public static URI toURI(URL url)

getCurrentDirectory

public static File getCurrentDirectory()

Returns the current directory.

Returns:

The current directory.

getTempDirectory

public static File getTempDirectory()

Returns the temporary directory.

Returns:

The temporary directory.

validateOSIndependentFileName

public static String validateOSIndependentFileName(String name)

Ensures that the segment is a valid OS independent path segment meaning that it is a valid file/folder name. Each invalid sign will be replaced by '_'.

Parameters:

segment - The segment to validate.

Returns:

The validated OS independent path segment in which each invalid sign is replaced.