org.apache.chemistry.opencmis.commons.impl

Class IOUtils

java.lang.Object

org.apache.chemistry.opencmis.commons.impl.IOUtils

public final class IOUtils
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IOUtils.IgnoreCommentsLineHandler
static interface	IOUtils.LineHandler
static class	IOUtils.SkipHeaderLineHandler

Field Summary

Fields

Modifier and Type	Field and Description
static String	ISO_8859_1 ISO-8859-1 character set name.
static String	UTF8 UTF-8 character set name.

Method Summary

Methods

Modifier and Type	Method and Description
static boolean	checkForBytes(InputStream stream) Checks if a stream has more bytes.
static InputStream	checkForBytes(InputStream stream, int bufferSize) Checks if a stream has more bytes.
static void	closeQuietly(Closeable closeable) Closes a stream and ignores any exceptions.
static void	closeQuietly(ContentStream contentStream) Closes the stream of a ContentStream object and ignores any exceptions.
static void	consumeAndClose(InputStream stream) Consumes and closes the provided stream.
static void	consumeAndClose(Reader reader) Consumes and closes the provided reader.
static void	copy(InputStream in, OutputStream out) Copies all bytes of an input stream to an output stream.
static void	copy(InputStream in, OutputStream out, int bufferSize) Copies all bytes of an input stream to an output stream.
static String	decodeURL(String s) URL decodes the given string or throws a CmisRuntimeException if the charset 'UTF-8' is not available.
static String	encodeURL(String s) URL encodes the given string or throws a CmisRuntimeException if the charset 'UTF-8' is not available.
static String	readAllLines(InputStream stream) Reads all lines from a stream and closes the stream.
static String	readAllLinesAndIgnoreComments(InputStream stream) Reads all lines from a stream, ignores all comments, and closes the stream.
static String	readAllLinesAndRemoveHeader(InputStream stream) Reads all lines from a stream, removes the header, and closes the stream.
static List<String>	readAllLinesAsList(InputStream stream) Reads all lines from a stream, ignores all comments, and closes the stream.
static Map<String,String>	readAllLinesAsMap(InputStream stream) Reads all lines from a stream, ignores all comments, and closes the stream.
static String	readFirstLine(InputStream stream) Reads the first line from a stream and closes the stream.
static void	readLinesFromStream(InputStream stream, IOUtils.LineHandler handler) Reads lines from an UTF-8 encoded stream and closes the stream.
static byte[]	toUTF8Bytes(String s) Returns UTF-8 bytes of the given string or throws a CmisRuntimeException if the charset 'UTF-8' is not available.
static String	toUTF8String(byte[] bytes) Converts a UTF-8 encoded byte array into a string or throws a CmisRuntimeException if the charset 'UTF-8' is not available.

Methods inherited from class java.lang.Object

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

Field Detail

UTF8

public static final String UTF8

UTF-8 character set name.

See Also:

Constant Field Values

ISO_8859_1

public static final String ISO_8859_1

ISO-8859-1 character set name.

See Also:

Constant Field Values

Method Detail

toUTF8Bytes

public static byte[] toUTF8Bytes(String s)

Returns UTF-8 bytes of the given string or throws a CmisRuntimeException if the charset 'UTF-8' is not available.

Parameters:

s - the input string

Returns:

the UTF-8 bytes

toUTF8String

public static String toUTF8String(byte[] bytes)

Converts a UTF-8 encoded byte array into a string or throws a CmisRuntimeException if the charset 'UTF-8' is not available.

Parameters:

bytes - the byte array

Returns:

the string

encodeURL

public static String encodeURL(String s)

URL encodes the given string or throws a CmisRuntimeException if the charset 'UTF-8' is not available.

Parameters:

s - the string to encode

Returns:

the encoded

decodeURL

public static String decodeURL(String s)

URL decodes the given string or throws a CmisRuntimeException if the charset 'UTF-8' is not available.

Parameters:

s - the string to decode

Returns:

the decoded string

checkForBytes

public static InputStream checkForBytes(InputStream stream,
                        int bufferSize)
                                 throws IOException

Checks if a stream has more bytes. If the provided stream is not markable, it wrappes a BufferedInputStream around the stream and returns it.

Parameters:

stream - the stream

bufferSize - the size of the buffer in bytes if a BufferedInputStream has to be created

Returns:

null if the stream doesn't have more bytes, the provided stream if the provided stream is markable and has more bytes, or a BufferedInputStream if the provided stream is not markable and has more bytes

Throws:

IOException

checkForBytes

public static boolean checkForBytes(InputStream stream)
                             throws IOException

Checks if a stream has more bytes.

Parameters:

stream - a markable stream

Returns:

true if the stream has more bytes, false otherwise

Throws:

IOException

closeQuietly

public static void closeQuietly(Closeable closeable)

Closes a stream and ignores any exceptions.

Parameters:

closeable - the Closeable object

closeQuietly

public static void closeQuietly(ContentStream contentStream)

Closes the stream of a ContentStream object and ignores any exceptions.

Parameters:

contentStream - the content stream

consumeAndClose

public static void consumeAndClose(InputStream stream)

Consumes and closes the provided stream.

Parameters:

stream - the stream

consumeAndClose

public static void consumeAndClose(Reader reader)

Consumes and closes the provided reader.

Parameters:

reader - the reader

copy

public static void copy(InputStream in,
        OutputStream out)
                 throws IOException

Copies all bytes of an input stream to an output stream. Neither the input stream nor the output stream will the closed after the copy.

Parameters:

in - the input stream, must not be null

out - the output stream, must not be null

Throws:

IOException

copy

public static void copy(InputStream in,
        OutputStream out,
        int bufferSize)
                 throws IOException

Copies all bytes of an input stream to an output stream. Neither the input stream nor the output stream will the closed after the copy.

Parameters:

in - the input stream, must not be null

out - the output stream, must not be null

bufferSize - the size of the internal buffer, must be positive

Throws:

IOException

readLinesFromStream

public static void readLinesFromStream(InputStream stream,
                       IOUtils.LineHandler handler)
                                throws IOException

Reads lines from an UTF-8 encoded stream and closes the stream.

Parameters:

stream - the stream

handler - a handler the processes each line.

Throws:

IOException

readFirstLine

public static String readFirstLine(InputStream stream)
                            throws IOException

Reads the first line from a stream and closes the stream.

Parameters:

stream - the input stream

Throws:

IOException

readAllLines

public static String readAllLines(InputStream stream)
                           throws IOException

Reads all lines from a stream and closes the stream.

Parameters:

stream - the input stream

Throws:

IOException

readAllLinesAndRemoveHeader

public static String readAllLinesAndRemoveHeader(InputStream stream)
                                          throws IOException

Reads all lines from a stream, removes the header, and closes the stream.

Parameters:

stream - the input stream

Throws:

IOException

readAllLinesAndIgnoreComments

public static String readAllLinesAndIgnoreComments(InputStream stream)
                                            throws IOException

Reads all lines from a stream, ignores all comments, and closes the stream.

Parameters:

stream - the input stream

Throws:

IOException

readAllLinesAsList

public static List<String> readAllLinesAsList(InputStream stream)
                                       throws IOException

Reads all lines from a stream, ignores all comments, and closes the stream.

Parameters:

stream - the input stream

Throws:

IOException

readAllLinesAsMap

public static Map<String,String> readAllLinesAsMap(InputStream stream)
                                            throws IOException

Reads all lines from a stream, ignores all comments, and closes the stream.

Parameters:

stream - the input stream

Throws:

IOException