Package arc.util.io

Class Streams

java.lang.Object

arc.util.io.Streams

public final class Streams
extends Object

Provides utility methods to copy streams.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Streams.OptimizedByteArrayOutputStream	A ByteArrayOutputStream which avoids copying of the byte array if possible.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	defaultBufferSize
static final byte[]	emptyBytes

Constructor Summary

Constructors

Constructor	Description
Streams()

Method Summary

Modifier and Type	Method	Description
static void	close(Closeable c)	Close and ignore all errors.
static void	copy(InputStream input, OutputStream output)	Allocates a 4096 byte[] for use as a temporary buffer and calls copy(InputStream, OutputStream, byte[]).
static void	copy(InputStream input, OutputStream output, byte[] buffer)	Copy the data from an InputStream to an OutputStream, using the specified byte[] as a temporary buffer.
static void	copy(InputStream input, OutputStream output, int bufferSize)	Allocates a byte[] of the specified size for use as a temporary buffer and calls copy(InputStream, OutputStream, byte[]).
static void	copy(InputStream input, ByteBuffer output)	Allocates a 4096 byte[] for use as a temporary buffer and calls copy(InputStream, OutputStream, byte[]).
static int	copy(InputStream input, ByteBuffer output, byte[] buffer)	Copy the data from an InputStream to a ByteBuffer, using the specified byte[] as a temporary buffer.
static void	copy(InputStream input, ByteBuffer output, int bufferSize)	Allocates a byte[] of the specified size for use as a temporary buffer and calls copy(InputStream, ByteBuffer, byte[]).
static byte[]	copyBytes(InputStream input)	Copy the data from an InputStream to a byte array.
static byte[]	copyBytes(InputStream input, int estimatedSize)	Copy the data from an InputStream to a byte array.
static void	copyProgress(InputStream input, OutputStream output, long totalLength, int bufferSize, Floatc progress)	Copy the data from an InputStream to an OutputStream, using the specified byte[] as a temporary buffer.
static String	copyString(InputStream input)	Calls copyString(InputStream, int, String) using the input's available size and the platform's default charset.
static String	copyString(InputStream input, int estimatedSize)	Calls copyString(InputStream, int, String) using the platform's default charset.
static String	copyString(InputStream input, int estimatedSize, String charset)	Copy the data from an InputStream to a string using the specified charset.

Methods inherited from class java.lang.Object

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

Field Details

defaultBufferSize

public static final int defaultBufferSize

See Also:

• Constant Field Values

emptyBytes

public static final byte[] emptyBytes

Constructor Details

Streams

public Streams()

Method Details

copy

public static void copy(InputStream input,
 OutputStream output)
                 throws IOException

Allocates a 4096 byte[] for use as a temporary buffer and calls copy(InputStream, OutputStream, byte[]).

Throws:

IOException

copy

public static void copy(InputStream input,
 OutputStream output,
 int bufferSize)
                 throws IOException

Allocates a byte[] of the specified size for use as a temporary buffer and calls copy(InputStream, OutputStream, byte[]).

Throws:

IOException

copy

public static void copy(InputStream input,
 OutputStream output,
 byte[] buffer)
                 throws IOException

Copy the data from an InputStream to an OutputStream, using the specified byte[] as a temporary buffer. The stream is not closed.

Throws:

IOException

copyProgress

public static void copyProgress(InputStream input,
 OutputStream output,
 long totalLength,
 int bufferSize,
 Floatc progress)
                         throws IOException

Copy the data from an InputStream to an OutputStream, using the specified byte[] as a temporary buffer. The stream is not closed. Provides progress as a 0-1 value through the specified listener.

Parameters:

totalLength - the total byte length of the input.

Throws:

IOException

copy

public static void copy(InputStream input,
 ByteBuffer output)
                 throws IOException

Allocates a 4096 byte[] for use as a temporary buffer and calls copy(InputStream, OutputStream, byte[]).

Throws:

IOException

copy

public static void copy(InputStream input,
 ByteBuffer output,
 int bufferSize)
                 throws IOException

Allocates a byte[] of the specified size for use as a temporary buffer and calls copy(InputStream, ByteBuffer, byte[]).

Throws:

IOException

copy

public static int copy(InputStream input,
 ByteBuffer output,
 byte[] buffer)
                throws IOException

Copy the data from an InputStream to a ByteBuffer, using the specified byte[] as a temporary buffer. The buffer's limit is increased by the number of bytes copied, the position is left unchanged. The stream is not closed.

Parameters:

output - Must be a direct Buffer with native byte order and the buffer MUST be large enough to hold all the bytes in the stream. No error checking is performed.

Returns:

the number of bytes copied.

Throws:

IOException

copyBytes

public static byte[] copyBytes(InputStream input)
                        throws IOException

Copy the data from an InputStream to a byte array. The stream is not closed.

Throws:

IOException

copyBytes

public static byte[] copyBytes(InputStream input,
 int estimatedSize)
                        throws IOException

Copy the data from an InputStream to a byte array. The stream is not closed.

Parameters:

estimatedSize - Used to allocate the output byte[] to possibly avoid an array copy.

Throws:

IOException

copyString

public static String copyString(InputStream input)
                         throws IOException

Calls copyString(InputStream, int, String) using the input's available size and the platform's default charset.

Throws:

IOException

copyString

public static String copyString(InputStream input,
 int estimatedSize)
                         throws IOException

Calls copyString(InputStream, int, String) using the platform's default charset.

Throws:

IOException

copyString

public static String copyString(InputStream input,
 int estimatedSize,
 String charset)
                         throws IOException

Copy the data from an InputStream to a string using the specified charset.

Parameters:

estimatedSize - Used to allocate the output buffer to possibly avoid an array copy.

charset - May be null to use the platform's default charset.

Throws:

IOException

close

public static void close(Closeable c)

Close and ignore all errors.