Package com.github.tadukoo.util.download

Class ProgressReadableByteChannelWrapper

java.lang.Object

com.github.tadukoo.util.download.ProgressReadableByteChannelWrapper

All Implemented Interfaces:

Closeable, AutoCloseable, Channel, ReadableByteChannel

public class ProgressReadableByteChannelWrapper
extends Object
implements ReadableByteChannel

Progress Readable Byte Channel Wrapper is a wrapper around ReadableByteChannel that will send progress updates to a ProgressRBCWrapperListener, which is keeping track of progress.

Version:

Beta v.0.5

Author:

Logan Ferree (Tadukoo)

Field Summary

Fields

Modifier and Type	Field	Description
private final ReadableByteChannel	byteChannel	The underlying ReadableByteChannel to use for reading
private final long	expectedSize	The expected total size in bytes to be read
private final ProgressRBCWrapperListener	listener	The ProgressRBCWrapperListener that is keeping track of progress
private long	readSoFar	The amount of bytes read so far

Constructor Summary

Constructors

Constructor	Description
ProgressReadableByteChannelWrapper(ReadableByteChannel byteChannel, ProgressRBCWrapperListener listener, long expectedSize)	Wraps the given ReadableByteChannel so we can send progress updates to the given ProgressRBCWrapperListener, which is keeping track of progress

Method Summary

Modifier and Type	Method	Description
void	close()	Closes the underlying byteChannel
boolean	isOpen()
int	read(ByteBuffer bb)	Reads bytes from the underlying byteChannel into the given ByteBuffer and will send a progress update to the listener that is keeping track of progress

Methods inherited from class java.lang.Object

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

Field Details

byteChannel

private final ReadableByteChannel byteChannel

The underlying ReadableByteChannel to use for reading

listener

private final ProgressRBCWrapperListener listener

The ProgressRBCWrapperListener that is keeping track of progress

expectedSize

private final long expectedSize

The expected total size in bytes to be read

readSoFar

private long readSoFar

The amount of bytes read so far

Constructor Details

ProgressReadableByteChannelWrapper

public ProgressReadableByteChannelWrapper(ReadableByteChannel byteChannel,
 ProgressRBCWrapperListener listener,
 long expectedSize)

Wraps the given ReadableByteChannel so we can send progress updates to the given ProgressRBCWrapperListener, which is keeping track of progress

Parameters:

byteChannel - The underlying ReadableByteChannel to be wrapped

listener - The ProgressRBCWrapperListener which will track progress

expectedSize - The expected total size in bytes to be read

Method Details

close

public void close()
           throws IOException

Closes the underlying byteChannel

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Channel

Specified by:

close in interface Closeable

Throws:

IOException - If anything goes wrong in closing the byte channel

isOpen

public boolean isOpen()

Specified by:

isOpen in interface Channel

Returns:

Whether the underlying byteChannel is open or not

read

public int read(ByteBuffer bb)
         throws IOException

Reads bytes from the underlying byteChannel into the given ByteBuffer and will send a progress update to the listener that is keeping track of progress

Specified by:

read in interface ReadableByteChannel

Parameters:

bb - The ByteBuffer to be read into

Returns:

The number of bytes read, possibly 0 or -1 if we're at the end of stream

Throws:

IOException - If anything goes wrong in reading bytes