com.day.io

Class IO

java.lang.Object

com.day.io.IO

public class IO
extends java.lang.Object

Contains I/O utility functions.

Since:

antbear

Constructor Summary

Constructors

Constructor and Description
IO()

Method Summary

Modifier and Type	Method and Description
static java.io.File	createTempFile() Create a temporary file in the generic tmp directory.
static java.io.File	createTempFile(java.util.Collection tracker) Create a temporary file and add it to the given tracker
static java.io.File	createTempFile(java.util.Collection tracker, java.lang.String prefix, java.lang.String suffix) Create a temporary file and add it to the given tracker
static java.io.File	createTempFile(java.lang.String prefix, java.lang.String suffix) Create a temporary file in the generic tmp directory.
static java.io.File	getAbsoluteFile(java.lang.String path) returns an absolute file regarding the cq3 home as cwd.
static java.lang.String	getAbsolutePath(java.lang.String path) returns an absolute path regarding the cq3 home as cwd.
static java.lang.String	getAppHome() Deprecated. use getCWD().getPath() instead.
static java.io.File	getAppHomeDirectory() Deprecated. use getCWD() instead.
static java.io.File	getCanonicalFile(java.lang.String path) Normalize a path, converting slashes to platform dependent separators and removing dots.
static java.io.File	getCWD() Returns the directory of the application home
static java.io.File	getTempDir() Return the temporary directory.
static boolean	isParent(java.io.File parent, java.io.File child) Return a flag indicating whether a file is the parent of another file
static java.lang.String	readUTF(java.io.InputStream in) Read a UTF encoded string from an input stream.
static boolean	rename(java.io.File src, java.io.File dst) Renames a file to another.
static boolean	rename0(java.io.File src, java.io.File dst) Renames a file to another.
static void	setCQ3Home(java.io.File cq3Home) Deprecated. use setCWD(File) instead.
static void	setCWD(java.io.File cwd) Initialization of CQ3 home.
static void	setTempDir(java.io.File tempDir) Initialization of temporary directory when used as a separate component.
static int	spool(java.io.InputStream in, byte[] buffer) Spools data from an InputStream into an byte buffer.
static int	spool(java.io.InputStream in, java.io.OutputStream out) Spools data from an InputStream into an OutputStream.
static int	spool(java.io.InputStream in, java.io.OutputStream out, int num) Spools data from an InputStream into an OutputStream.
static int	spool(java.io.Reader in, java.io.Writer out) Spools characters from an Reader into an Writer.
static void	tryClose(java.io.InputStream in) Closes the InputStream in if not null and ignores a potential IOException thrown from closing the stream.
static void	tryClose(java.io.OutputStream out) Closes the OutputStream out if not null and ignores a potential IOException thrown from closing the stream.
static void	tryClose(java.io.Reader reader) Closes the Reader out if not null and ignores a potential IOException thrown from closing the reader.
static void	tryClose(java.io.Writer writer) Closes the Writer in if not null and ignores a potential IOException thrown from closing the writer.

Methods inherited from class java.lang.Object

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

Constructor Detail

IO

public IO()

Method Detail

spool

public static int spool(java.io.InputStream in,
                        java.io.OutputStream out)
                 throws java.io.IOException

Spools data from an InputStream into an OutputStream. Please note, that both, input and output stream, remain open after the spooling.

Parameters:

in - input stream

out - output stream

Returns:

number of bytes transmitted

Throws:

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

spool

public static int spool(java.io.InputStream in,
                        byte[] buffer)
                 throws java.io.IOException

Spools data from an InputStream into an byte buffer. either until the buffer is full or the EOF is reached.

Parameters:

in - input stream

buffer - output buffer

Returns:

number of bytes transmitted

Throws:

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

spool

public static int spool(java.io.Reader in,
                        java.io.Writer out)
                 throws java.io.IOException

Spools characters from an Reader into an Writer. Please note, that both, reader and writer remain open after the spooling.

Parameters:

in - input Reader

out - output Writer

Returns:

number of characters transmitted

Throws:

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

spool

public static int spool(java.io.InputStream in,
                        java.io.OutputStream out,
                        int num)
                 throws java.io.IOException

Spools data from an InputStream into an OutputStream. Please note, that both, input and output stream, remain open after the spooling. This method only transfers num bytes or less.

Parameters:

in - input stream

out - output stream

Returns:

number of bytes transmitted

Throws:

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

tryClose

public static void tryClose(java.io.InputStream in)

Closes the InputStream in if not null and ignores a potential IOException thrown from closing the stream.

Parameters:

in - The InputStream to close. This may be null.

tryClose

public static void tryClose(java.io.OutputStream out)

Closes the OutputStream out if not null and ignores a potential IOException thrown from closing the stream.

Parameters:

out - The OutputStream to close. This may be null.

tryClose

public static void tryClose(java.io.Reader reader)

Closes the Reader out if not null and ignores a potential IOException thrown from closing the reader.

Parameters:

reader - The Reader to close. This may be null.

tryClose

public static void tryClose(java.io.Writer writer)

Closes the Writer in if not null and ignores a potential IOException thrown from closing the writer.

Parameters:

writer - The Writer to close. This may be null.

rename0

public static boolean rename0(java.io.File src,
                              java.io.File dst)

Renames a file to another. If the renaming does not work, it copies the content and tries to delete the source file.

Parameters:

src - the source file

dst - the destination file

Returns:

true if the renaming was successful and the file at leas exists at the new location; false if the renaming failed. in this case, the original file still exists.

readUTF

public static java.lang.String readUTF(java.io.InputStream in)
                                throws java.io.UTFDataFormatException,
                                       java.io.IOException

Read a UTF encoded string from an input stream.

Parameters:

in - input stream

Returns:

string

Throws:

java.io.UTFDataFormatException - if the input stream contains an invalid combination of bytes

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

setCWD

public static void setCWD(java.io.File cwd)

Initialization of CQ3 home. Either this method or setTempDir(File) must be called before methods inside IO may be used.

Parameters:

cwd - directory to use as current work directory

setCQ3Home

public static void setCQ3Home(java.io.File cq3Home)

Deprecated. use setCWD(File) instead.

Initialization of CQ3 home. Either this method or setTempDir(File) must be called before methods inside IO may be used.

Parameters:

cq3Home - directory to use as CQ3 home.

setTempDir

public static void setTempDir(java.io.File tempDir)

Initialization of temporary directory when used as a separate component. This class has some functionality based on a temporary directory to use and in order to use that functionality without having an engine at hand makes this method necessary.

Parameters:

tempDir - temporary directory to use

getTempDir

public static java.io.File getTempDir()

Return the temporary directory.

Returns:

the temporary directory.

getAppHome

public static java.lang.String getAppHome()

Deprecated. use getCWD().getPath() instead.

Returns the path of the application home directory

Returns:

the path of the application home directory

getAppHomeDirectory

public static java.io.File getAppHomeDirectory()

Deprecated. use getCWD() instead.

Returns the directory of the application home

Returns:

the directory of the application home

getCWD

public static java.io.File getCWD()

Returns the directory of the application home

Returns:

the directory of the application home

getCanonicalFile

public static java.io.File getCanonicalFile(java.lang.String path)

Normalize a path, converting slashes to platform dependent separators and removing dots.

Returns:

canonical file path or null if the path cannot be normalized

isParent

public static boolean isParent(java.io.File parent,
                               java.io.File child)

Return a flag indicating whether a file is the parent of another file

Parameters:

parent - parent file

child - child file

Returns:

true if parent is parent of child, otherwise false

createTempFile

public static java.io.File createTempFile(java.util.Collection tracker)
                                   throws java.io.IOException

Create a temporary file and add it to the given tracker

Parameters:

tracker - collection that is use to record the generated temp file.

Returns:

a new temporary file.

Throws:

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

createTempFile

public static java.io.File createTempFile(java.util.Collection tracker,
                                          java.lang.String prefix,
                                          java.lang.String suffix)
                                   throws java.io.IOException

Create a temporary file and add it to the given tracker

Parameters:

tracker - collection that is use to record the generated temp file.

prefix - the prefix for the temporary file

suffix - the suffix for the temporary file

Returns:

a new temp file

Throws:

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

createTempFile

public static java.io.File createTempFile()
                                   throws java.io.IOException

Create a temporary file in the generic tmp directory.

Returns:

a new temporary file

Throws:

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

createTempFile

public static java.io.File createTempFile(java.lang.String prefix,
                                          java.lang.String suffix)
                                   throws java.io.IOException

Create a temporary file in the generic tmp directory.

Parameters:

prefix - the prefix for the file

suffix - the suffix for the file

Returns:

a new temporary file

Throws:

java.lang.IllegalArgumentException - If the prefix argument contains fewer than three characters

java.io.IOException - If a file could not be created

getAbsolutePath

public static java.lang.String getAbsolutePath(java.lang.String path)

returns an absolute path regarding the cq3 home as cwd. If the path already is absolute, this string itself is returned.

Parameters:

path - the relative path

Returns:

an absolute path

getAbsoluteFile

public static java.io.File getAbsoluteFile(java.lang.String path)

returns an absolute file regarding the cq3 home as cwd.

Parameters:

path - the relative path

Returns:

a new file pointing to the absolute path

rename

public static boolean rename(java.io.File src,
                             java.io.File dst)

Renames a file to another. If the renaming does not work, it copies the content and tries to delete the source file.

Parameters:

src - the source file

dst - the destination file

Returns:

true if the renaming was successful and the file at leas exists at the new location; false if the renaming failed. in this case, the original file still exists.