org.marketcetera.util.file
Class CopyCharsUtils

java.lang.Object
  org.marketcetera.util.file.CopyCharsUtils

public final class CopyCharsUtils
extends Object

Utilities for copying textual data, in the default JVM charset. The participating media include files, arrays, readers/writers, or some combinations thereof.

Since:

0.6.0

Version:

$Id: CopyCharsUtils.java 16154 2012-07-14 16:34:05Z colin $

Author:

tlerios@marketcetera.com

Method Summary

static void	copy(char[] data, String name) Copies an in-memory character array into the given location.
static long	copy(Reader in, boolean skipClose, String out) Copies a character stream from the given source to the given location.
static long	copy(Reader in, boolean inSkipClose, Writer out, boolean outSkipClose) Copies a character stream from the given source to the given sink.
static char[]	copy(String name) Copies the character stream at the given location into memory, returning a character array.
static long	copy(String in, String out) Copies a character stream from one given location to another.
static long	copy(String in, Writer out, boolean skipClose) Copies a character stream from the given location to the given sink.

Methods inherited from class java.lang.Object

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

Method Detail

copy

public static long copy(Reader in,
                        boolean inSkipClose,
                        Writer out,
                        boolean outSkipClose)
                 throws I18NException

Copies a character stream from the given source to the given sink.

Parameters:

in - The character source, as interpreted by ReaderWrapper.ReaderWrapper(Reader,boolean).

inSkipClose - True if the source reader should not be closed.

out - The character sink, as interpreted by WriterWrapper.WriterWrapper(Writer,boolean).

outSkipClose - True if the sink writer should not be closed.

Returns:

The number of characters copied.

Throws:

I18NException - Thrown if there is a data read/write error.

copy

public static long copy(String in,
                        String out)
                 throws I18NException

Copies a character stream from one given location to another.

Parameters:

in - The name of the character source, as interpreted by ReaderWrapper.ReaderWrapper(String).

out - The name of the character sink, as interpreted by WriterWrapper.WriterWrapper(String).

Returns:

The number of characters copied.

Throws:

I18NException - Thrown if there is a data read/write error.

copy

public static long copy(Reader in,
                        boolean skipClose,
                        String out)
                 throws I18NException

Copies a character stream from the given source to the given location.

Parameters:

in - The character source, as interpreted by ReaderWrapper.ReaderWrapper(Reader,boolean).

skipClose - True if the source reader should not be closed.

out - The name of the character sink, as interpreted by WriterWrapper.WriterWrapper(String).

Returns:

The number of characters copied.

Throws:

I18NException - Thrown if there is a data read/write error.

copy

public static long copy(String in,
                        Writer out,
                        boolean skipClose)
                 throws I18NException

Copies a character stream from the given location to the given sink.

Parameters:

in - The name of the character source, as interpreted by ReaderWrapper.ReaderWrapper(String).

out - The character sink, as interpreted by WriterWrapper.WriterWrapper(Writer,boolean).

skipClose - True if the sink writer should not be closed.

Returns:

The number of characters copied.

Throws:

I18NException - Thrown if there is a data read/write error.

copy

public static char[] copy(String name)
                   throws I18NException

Copies the character stream at the given location into memory, returning a character array.

Parameters:

name - The name of the character source, as interpreted by ReaderWrapper.ReaderWrapper(String).

Returns:

The array.

Throws:

I18NException - Thrown if there is a data read/write error.

copy

public static void copy(char[] data,
                        String name)
                 throws I18NException

Copies an in-memory character array into the given location.

Parameters:

data - The array.

name - The name of the character sink, as interpreted by WriterWrapper.WriterWrapper(String).

Throws:

I18NException - Thrown if there is a data read/write error.