Package nl.vpro.util

Class Copier

java.lang.Object

nl.vpro.util.Copier

All Implemented Interfaces:

Closeable, AutoCloseable, Runnable

public class Copier
extends Object
implements Runnable, Closeable

Can be used to copy an InputStream to an OutputStream in a stand alone thread. Used by FileCachingInputStream.

Since:

3.1

Author:

Michiel Meeuwissen

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Copier.Builder

Constructor Summary

Constructors

Constructor	Description
Copier(@NonNull InputStream i, @NonNull OutputStream o)
Copier(@NonNull InputStream i, @NonNull OutputStream o, Long batch)

Method Summary

Modifier and Type	Method	Description
int	available()
static Copier.Builder	builder()
void	close()	Closes and interrupts the copier if necessary (This may be desired if it was detected that the receiver is no longer interested).
Copier	execute()
boolean	executeIfNotRunning()
long	getCount()	Returns the number of bytes read from the input stream so far
Optional<Throwable>	getException()
Future<?>	getFuture()
boolean	isReady()	Checks whether this copier is ready.
boolean	isReadyIOException()	Checks whether this copier is ready, but will throw an IOException it it did not _successfully_ finish.
void	run()
String	toString()
void	waitFor()
void	waitForAndClose()

Methods inherited from class java.lang.Object

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

Constructor Details

Copier

public Copier(@NonNull InputStream i,
 @NonNull OutputStream o,
 Long batch)

Copier

public Copier(@NonNull InputStream i,
 @NonNull OutputStream o)

Method Details

run

public void run()

Specified by:

run in interface Runnable

waitFor

public void waitFor()
             throws InterruptedException

Throws:

InterruptedException

waitForAndClose

public void waitForAndClose()
                     throws InterruptedException,
IOException

Throws:

InterruptedException

IOException

isReadyIOException

public boolean isReadyIOException()
                           throws IOException

Checks whether this copier is ready, but will throw an IOException it it did not _successfully_ finish.

Throws:

IOException

getException

public Optional<Throwable> getException()

getCount

public long getCount()

Returns the number of bytes read from the input stream so far

execute

public Copier execute()

executeIfNotRunning

public boolean executeIfNotRunning()

close

public void close()
           throws IOException

Closes and interrupts the copier if necessary (This may be desired if it was detected that the receiver is no longer interested). And closes associated resources.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException

available

public int available()
              throws IOException

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object

builder

public static Copier.Builder builder()

isReady

public boolean isReady()

Checks whether this copier is ready. You may want to check or use to deal with unsuccessful terminations

getFuture

public Future<?> getFuture()