cz.ues.core.commons

Class StreamUtils

java.lang.Object

cz.ues.core.commons.StreamUtils

public class StreamUtils
extends java.lang.Object

Utility class to work with streams.

Since:

UES6-06

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_BUFFER_SIZE Default size of buffer for working with streams.

Constructor Summary

Constructors

Constructor and Description
StreamUtils()

Method Summary

Methods

Modifier and Type	Method and Description
static long	copy(java.io.InputStream pIn, java.io.OutputStream pOut) Copies the contents of the given InputStream to the given OutputStream and closes streams.
static long	copy(java.io.InputStream pIn, java.io.OutputStream pOut, boolean pClose, byte[] pBuffer) Copies the contents of the given InputStream to the given OutputStream.
static java.lang.String	getContentFromReader(java.io.Reader aReader) Converts whole Reader content into String
static java.lang.String	getContentFromStream(java.io.InputStream pStream) * This convenience method allows to read an InputStream's content into a string.
static void	XMLStreamReaderCloseQuietly(javax.xml.stream.XMLStreamReader xsr) Try to close XMLStreamReader.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_BUFFER_SIZE

public static final DEFAULT_BUFFER_SIZE

Default size of buffer for working with streams.

See Also:

Constant Field Values

Constructor Detail

StreamUtils

public StreamUtils()

Method Detail

getContentFromReader

public static java.lang.String getContentFromReader(java.io.Reader aReader)
throws java.io.IOException

Converts whole Reader content into String

Parameters:

aReader - Reader to read from

Returns:

String representing content whole Reader

Throws:

java.io.IOException

Since:

UES6-06

getContentFromStream

public static java.lang.String getContentFromStream(java.io.InputStream pStream)
throws java.io.IOException

* This convenience method allows to read an InputStream's content into a string. UTF-8 character encoding is used for converting bytes into characters.

Parameters:

pStream - The input stream to read.

Returns:

The streams contents, as a string.

Throws:

java.io.IOException - An I/O error occurred.

Since:

UES6-06

copy

public static long copy(java.io.InputStream pIn,
java.io.OutputStream pOut)
throws java.io.IOException

Copies the contents of the given InputStream to the given OutputStream and closes streams.

Parameters:

pIn - The input stream, which is being read. It is guaranteed, that InputStream.close() is called on the stream.

pOut - The output stream, to which data should be written. May be null, in which case the input streams contents are simply discarded.

Returns:

Number of bytes, which have been copied.

Throws:

java.io.IOException - An I/O error occurred.

Since:

UES6-06

copy

public static long copy(java.io.InputStream pIn,
java.io.OutputStream pOut,
boolean pClose,
byte[] pBuffer)
throws java.io.IOException

Copies the contents of the given InputStream to the given OutputStream.

Parameters:

pIn - The input stream, which is being read. It is guaranteed, that InputStream.close() is called on the stream.

pOut - The output stream, to which data should be written. May be null, in which case the input streams contents are simply discarded.

pClose - True guarantees, that OutputStream.close() is called on the stream. False indicates, that only OutputStream.flush() should be called finally.

pBuffer - Temporary buffer, which is to be used for copying data.

Returns:

Number of bytes, which have been copied.

Throws:

java.io.IOException - An I/O error occurred.

Since:

UES6-06

XMLStreamReaderCloseQuietly

public static void XMLStreamReaderCloseQuietly(javax.xml.stream.XMLStreamReader xsr)

Try to close XMLStreamReader. May be null or already closed.

Parameters:

xsr - XMLStreamReader which should be closed.