gobblin.util.io

Class StreamCopier

java.lang.Object

gobblin.util.io.StreamCopier

@NotThreadSafe
public class StreamCopier
extends Object

A class that copies an InputStream to an OutputStream in a configurable way.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	StreamCopier.NotEnoughPermitsException Indicates there were not enough permits in the Limiter to finish the copy.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_BUFFER_SIZE

Constructor Summary

Constructors

Constructor and Description
StreamCopier(InputStream inputStream, OutputStream outputStream)
StreamCopier(ReadableByteChannel inputChannel, WritableByteChannel outputChannel)

Method Summary

Modifier and Type	Method and Description
StreamCopier	closeChannelsOnComplete() Close the input and output Channels after copy, whether the copy was successful or not.
long	copy() Execute the copy of bytes from the input to the output stream.
StreamCopier	withBufferSize(int bufferSize) Set the size in bytes of the buffer used to copy.
StreamCopier	withCopySpeedMeter(com.codahale.metrics.Meter copySpeedMeter) Set a Meter where copy speed will be reported.

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 int DEFAULT_BUFFER_SIZE

See Also:

Constant Field Values

Constructor Detail

StreamCopier

public StreamCopier(InputStream inputStream,
                    OutputStream outputStream)

StreamCopier

public StreamCopier(ReadableByteChannel inputChannel,
                    WritableByteChannel outputChannel)

Method Detail

withBufferSize

public StreamCopier withBufferSize(int bufferSize)

Set the size in bytes of the buffer used to copy.

withCopySpeedMeter

public StreamCopier withCopySpeedMeter(com.codahale.metrics.Meter copySpeedMeter)

Set a Meter where copy speed will be reported.

closeChannelsOnComplete

public StreamCopier closeChannelsOnComplete()

Close the input and output Channels after copy, whether the copy was successful or not.

copy

public long copy()
          throws IOException

Execute the copy of bytes from the input to the output stream. Note: this method should only be called once. Further calls will throw a IllegalStateException.

Returns:

Number of bytes copied.

Throws:

IOException