Module org.apache.wicket.util

Package org.apache.wicket.util.io

Class Streams

java.lang.Object

org.apache.wicket.util.io.Streams

public final class Streams
extends Object

Utilities methods for working with input and output streams.

Author:

Jonathan Locke, Igor Vaynberg

Method Summary

Modifier and Type	Method	Description
static int	copy(InputStream in, OutputStream out)	Writes the input stream to the output stream.
static int	copy(InputStream in, OutputStream out, int bufSize)	Writes the input stream to the output stream.
static int	copyAndClose(InputStream in, OutputStream out)	Writes the input stream to the output stream.
static void	loadFromXml(Properties properties, InputStream inputStream)	Loads properties from an XML input stream into the provided properties object.
static InputStream	readNonCaching(URL url)	Sets the connection to a URL as non-caching and returns the input stream.
static String	readString(InputStream in)	Reads a stream as a string.
static String	readString(InputStream in, CharSequence encoding)	Reads a string using a character encoding.
static String	readString(Reader in)	Reads all input from a reader into a string.

Methods inherited from class java.lang.Object

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

Method Details

copyAndClose

public static int copyAndClose(InputStream in,
 OutputStream out)
                        throws IOException

Writes the input stream to the output stream. Input is done without a Reader object, meaning that the input is copied in its raw form. After it is copied it will close the streams.

Parameters:

in - The input stream

out - The output stream

Returns:

Number of bytes copied from one stream to the other

Throws:

IOException

copy

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

Writes the input stream to the output stream. Input is done without a Reader object, meaning that the input is copied in its raw form.

Parameters:

in - The input stream

out - The output stream

Returns:

Number of bytes copied from one stream to the other

Throws:

IOException

copy

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

Writes the input stream to the output stream. Input is done without a Reader object, meaning that the input is copied in its raw form.

Parameters:

in - The input stream

out - The output stream

bufSize - The buffer size. A good value is 4096.

Returns:

Number of bytes copied from one stream to the other

Throws:

IOException

loadFromXml

public static void loadFromXml(Properties properties,
 InputStream inputStream)
                        throws IOException

Loads properties from an XML input stream into the provided properties object.

Parameters:

properties - The object to load the properties into

inputStream -

Throws:

IOException - When the input stream could not be read from

readNonCaching

public static InputStream readNonCaching(URL url)
                                  throws IOException

Sets the connection to a URL as non-caching and returns the input stream.

Parameters:

url - the url to read from

Returns:

the input stream for this url

Throws:

IOException - when a connection cannot be opened

readString

public static String readString(InputStream in)
                         throws IOException

Reads a stream as a string.

Parameters:

in - The input stream

Returns:

The string

Throws:

IOException

readString

public static String readString(InputStream in,
 CharSequence encoding)
                         throws IOException

Reads a string using a character encoding.

Parameters:

in - The input

encoding - The character encoding of the input data

Returns:

The string

Throws:

IOException

readString

public static String readString(Reader in)
                         throws IOException

Reads all input from a reader into a string.

Parameters:

in - The input

Returns:

The string

Throws:

IOException