com.google.cloud

Interface ReadChannel

All Superinterfaces:

AutoCloseable, Channel, Closeable, ReadableByteChannel, Restorable<ReadChannel>

public interface ReadChannel
extends ReadableByteChannel, Closeable, Restorable<ReadChannel>

A channel for reading data from a Google Cloud object.

Implementations of this class may buffer data internally to reduce remote calls. This interface implements Restorable to allow saving the reader's state to continue reading afterwards.

Method Summary

Modifier and Type	Method and Description
RestorableState<ReadChannel>	capture() Captures the read channel state so that it can be saved and restored afterwards.
void	close() Overridden to remove IOException.
void	seek(long position)
void	setChunkSize(int chunkSize) Sets the minimum size that will be read by a single RPC.

Methods inherited from interface java.nio.channels.ReadableByteChannel

read

Methods inherited from interface java.nio.channels.Channel

isOpen

Method Detail

close

void close()

Overridden to remove IOException.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Channel

Specified by:

close in interface Closeable

See Also:

Channel.close()

seek

void seek(long position)
   throws IOException

Throws:

IOException

setChunkSize

void setChunkSize(int chunkSize)

Sets the minimum size that will be read by a single RPC. Read data will be locally buffered until consumed.

capture

RestorableState<ReadChannel> capture()

Captures the read channel state so that it can be saved and restored afterwards.

Specified by:

capture in interface Restorable<ReadChannel>

Returns:

a RestorableState object that contains the read channel state and can restore it afterwards.