org.jfree.io
Class IOUtils

java.lang.Object
  org.jfree.io.IOUtils

public class IOUtils
extends Object

The IOUtils provide some IO related helper methods.

Author:

Thomas Morgner.

Method Summary

void	copyStreams(InputStream in, OutputStream out) Copies the InputStream into the OutputStream, until the end of the stream has been reached.
void	copyStreams(InputStream in, OutputStream out, int buffersize) Copies the InputStream into the OutputStream, until the end of the stream has been reached.
void	copyWriter(Reader in, Writer out) Copies the contents of the Reader into the Writer, until the end of the stream has been reached.
void	copyWriter(Reader in, Writer out, int buffersize) Copies the contents of the Reader into the Writer, until the end of the stream has been reached.
String	createRelativeURL(URL url, URL baseURL) Creates a relative url by stripping the common parts of the the url.
String	getFileExtension(String file) Returns the file extension of the given file name.
String	getFileName(URL url) Extracts the file name from the URL.
static IOUtils	getInstance() Gets the singleton instance of the utility package.
boolean	isSubDirectory(File base, File child) Checks, whether the child directory is a subdirectory of the base directory.
String	stripFileExtension(String file) Removes the file extension from the given file name.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static IOUtils getInstance()

Gets the singleton instance of the utility package.

Returns:

the singleton instance.

createRelativeURL

public String createRelativeURL(URL url,
                                URL baseURL)

Creates a relative url by stripping the common parts of the the url.

Parameters:

url - the to be stripped url

baseURL - the base url, to which the url is relative to.

Returns:

the relative url, or the url unchanged, if there is no relation beween both URLs.

copyStreams

public void copyStreams(InputStream in,
                        OutputStream out)
                 throws IOException

Copies the InputStream into the OutputStream, until the end of the stream has been reached. This method uses a buffer of 4096 kbyte.

Parameters:

in - the inputstream from which to read.

out - the outputstream where the data is written to.

Throws:

IOException - if a IOError occurs.

copyStreams

public void copyStreams(InputStream in,
                        OutputStream out,
                        int buffersize)
                 throws IOException

Copies the InputStream into the OutputStream, until the end of the stream has been reached.

Parameters:

in - the inputstream from which to read.

out - the outputstream where the data is written to.

buffersize - the buffer size.

Throws:

IOException - if a IOError occurs.

copyWriter

public void copyWriter(Reader in,
                       Writer out)
                throws IOException

Copies the contents of the Reader into the Writer, until the end of the stream has been reached. This method uses a buffer of 4096 kbyte.

Parameters:

in - the reader from which to read.

out - the writer where the data is written to.

Throws:

IOException - if a IOError occurs.

copyWriter

public void copyWriter(Reader in,
                       Writer out,
                       int buffersize)
                throws IOException

Copies the contents of the Reader into the Writer, until the end of the stream has been reached.

Parameters:

in - the reader from which to read.

out - the writer where the data is written to.

buffersize - the buffer size.

Throws:

IOException - if a IOError occurs.

getFileName

public String getFileName(URL url)

Extracts the file name from the URL.

Parameters:

url - the url.

Returns:

the extracted filename.

stripFileExtension

public String stripFileExtension(String file)

Removes the file extension from the given file name.

Parameters:

file - the file name.

Returns:

the file name without the file extension.

getFileExtension

public String getFileExtension(String file)

Returns the file extension of the given file name. The returned value will contain the dot.

Parameters:

file - the file name.

Returns:

the file extension.

isSubDirectory

public boolean isSubDirectory(File base,
                              File child)
                       throws IOException

Checks, whether the child directory is a subdirectory of the base directory.

Parameters:

base - the base directory.

child - the suspected child directory.

Returns:

true, if the child is a subdirectory of the base directory.

Throws:

IOException - if an IOError occured during the test.