Module org.elasticsearch.base

Package org.elasticsearch.core

Class Streams

java.lang.Object

org.elasticsearch.core.Streams

public class Streams
extends Object

Simple utility methods for file and stream copying. All copy methods close all affected streams when done.

Mainly for use within the framework, but also useful for application code.

Method Summary

Modifier and Type	Method	Description
static long	copy(InputStream in, OutputStream out)
static long	copy(InputStream in, OutputStream out, boolean close)
static long	copy(InputStream in, OutputStream out, byte[] buffer)
static long	copy(InputStream in, OutputStream out, byte[] buffer, boolean close)	Copy the contents of the given InputStream to the given OutputStream.
static OutputStream	noCloseStream(OutputStream stream)	Wraps an OutputStream such that it's close method becomes a noop
static int	read(InputStream input, ByteBuffer buffer, int count)	Read up to {code count} bytes from input and store them into buffer.
static int	readFully(InputStream reader, byte[] dest)
static int	readFully(InputStream reader, byte[] dest, int offset, int len)

Methods inherited from class java.lang.Object

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

Method Details

copy

public static long copy(InputStream in,
 OutputStream out,
 byte[] buffer,
 boolean close)
                 throws IOException

Copy the contents of the given InputStream to the given OutputStream. Optionally, closes both streams when done.

Parameters:

in - the stream to copy from

out - the stream to copy to

buffer - buffer to use for copying

close - whether to close both streams after copying

Returns:

the number of bytes copied

Throws:

IOException - in case of I/O errors

copy

public static long copy(InputStream in,
 OutputStream out,
 boolean close)
                 throws IOException

Throws:

IOException

See Also:

• copy(InputStream, OutputStream, byte[], boolean)

copy

public static long copy(InputStream in,
 OutputStream out,
 byte[] buffer)
                 throws IOException

Throws:

IOException

See Also:

• copy(InputStream, OutputStream, byte[], boolean)

copy

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

Throws:

IOException

See Also:

• copy(InputStream, OutputStream, byte[], boolean)

read

public static int read(InputStream input,
 ByteBuffer buffer,
 int count)
                throws IOException

Read up to {code count} bytes from input and store them into buffer. The buffers position will be incremented by the number of bytes read from the stream.

Parameters:

input - stream to read from

buffer - buffer to read into

count - maximum number of bytes to read

Returns:

number of bytes read from the stream

Throws:

IOException - in case of I/O errors

readFully

public static int readFully(InputStream reader,
 byte[] dest)
                     throws IOException

Throws:

IOException

readFully

public static int readFully(InputStream reader,
 byte[] dest,
 int offset,
 int len)
                     throws IOException

Throws:

IOException

noCloseStream

public static OutputStream noCloseStream(OutputStream stream)

Wraps an OutputStream such that it's close method becomes a noop

Parameters:

stream - OutputStream to wrap

Returns:

wrapped OutputStream