org.zkoss.io
Class Files

java.lang.Object
  org.zkoss.io.Files

public class Files
extends java.lang.Object

File related utilities.

Author:

tomyeh

Field Summary

static int	CP_OVERWRITE Overwrites the destination file.
static int	CP_PRESERVE Preserves the last modified time and other attributes if possible.
static int	CP_UPDATE Copy only when the source is newer or when the destination is missing.
static char	DRIVE_SEPARATOR_CHAR The separator representing the drive in a path.

Constructor Summary

protected

Files()

Method Summary

static void	close(java.io.InputStream strm) Close an input stream without throwing an exception.
static void	close(java.io.Reader reader) Close a reader without throwing an exception.
static void	copy(java.io.File dst, java.io.File src, int flags) Copies a file or a directory into another.
static void	copy(java.io.File dst, java.io.InputStream in) Copies an input stream into a file (the original content, if any, are erased).
static void	copy(java.io.File dst, java.io.Reader reader, java.lang.String charset) Copies a reader into a file (the original content, if any, are erased).
static void	copy(java.io.OutputStream out, java.io.InputStream in) Copies an input stream to a output stream.
static void	copy(java.io.Writer writer, java.io.Reader reader) Copies a reader into a writer.
static java.lang.String	correctSeparator(java.lang.String flnm) Corrects the separator from '/' to the system dependent one.
static boolean	deleteAll(java.io.File file) Deletes all files under the specified path.
static java.io.File	getConfigDirectory() Returns the conf directory.
static byte[]	readAll(java.io.InputStream in) Returns all bytes in the input stream, never null (but its length might zero).
static java.lang.StringBuffer	readAll(java.io.Reader reader) Returns all characters in the reader, never null (but its length might zero).

Methods inherited from class java.lang.Object

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

Field Detail

DRIVE_SEPARATOR_CHAR

public static final char DRIVE_SEPARATOR_CHAR

The separator representing the drive in a path. In Windows, it is ':', while 0 in other platforms.

CP_PRESERVE

public static int CP_PRESERVE

Preserves the last modified time and other attributes if possible.

See Also:

copy(File, File, int)

CP_UPDATE

public static int CP_UPDATE

Copy only when the source is newer or when the destination is missing.

See Also:

copy(File, File, int)

CP_OVERWRITE

public static int CP_OVERWRITE

Overwrites the destination file.

See Also:

copy(File, File, int)

Constructor Detail

Files

protected Files()

Method Detail

correctSeparator

public static final java.lang.String correctSeparator(java.lang.String flnm)

Corrects the separator from '/' to the system dependent one. Note: i3 always uses '/' while Windows uses '\\'.

getConfigDirectory

public static final java.io.File getConfigDirectory()

Returns the conf directory.

The configure directory is assumed to be specified by the system property called "org.zkoss.io.conf.dir". If property not found, it assumes the conf or config directory under the directory specified by the system property called "user.dir". If property not found, it assumes the conf directory under the current directory.

readAll

public static final byte[] readAll(java.io.InputStream in)
                            throws java.io.IOException

Returns all bytes in the input stream, never null (but its length might zero).

Notice: this method is memory hungry.

Throws:

java.io.IOException

readAll

public static final java.lang.StringBuffer readAll(java.io.Reader reader)
                                            throws java.io.IOException

Returns all characters in the reader, never null (but its length might zero).

Notice: this method is memory hungry.

Throws:

java.io.IOException

copy

public static final void copy(java.io.Writer writer,
                              java.io.Reader reader)
                       throws java.io.IOException

Copies a reader into a writer.

Parameters:

writer - the destination

reader - the source

Throws:

java.io.IOException

copy

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

Copies an input stream to a output stream.

Parameters:

out - the destination

in - the source

Throws:

java.io.IOException

copy

public static final void copy(java.io.File dst,
                              java.io.Reader reader,
                              java.lang.String charset)
                       throws java.io.IOException

Copies a reader into a file (the original content, if any, are erased). The source and destination files will be closed after copied.

Parameters:

dst - the destination

reader - the source

charset - the charset; null as default (ISO-8859-1).

Throws:

java.io.IOException

copy

public static final void copy(java.io.File dst,
                              java.io.InputStream in)
                       throws java.io.IOException

Copies an input stream into a file (the original content, if any, are erased). The file will be closed after copied.

Parameters:

dst - the destination

in - the source

Throws:

java.io.IOException

copy

public static final void copy(java.io.File dst,
                              java.io.File src,
                              int flags)
                       throws java.io.IOException

Copies a file or a directory into another.

If neither CP_UPDATE nor CP_OVERWRITE, IOException is thrown if the destination exists.

Parameters:

flags - any combination of CP_UPDATE, CP_PRESERVE, CP_OVERWRITE.

Throws:

java.io.IOException

deleteAll

public static final boolean deleteAll(java.io.File file)

Deletes all files under the specified path.

close

public static final void close(java.io.InputStream strm)

Close an input stream without throwing an exception.

close

public static final void close(java.io.Reader reader)

Close a reader without throwing an exception.