Package org.opendaylight.raft.spi

Class AbstractFileStreamSource

java.lang.Object

org.opendaylight.raft.spi.AbstractFileStreamSource

All Implemented Interfaces:

SizedStreamSource, StreamSource

Direct Known Subclasses:

FileStreamSource, TransientFileStreamSource

@NonNullByDefault
public abstract sealed class AbstractFileStreamSource
extends Object
implements SizedStreamSource
permits TransientFileStreamSource, FileStreamSource

A SizedStreamSource providing access to a slice of a regular file, similar to a ByteBuffer.

Method Summary

Modifier and Type	Method	Description
abstract Path	file()	Returns this source's file path.
final long	limit()	Returns the limit.
final InputStream	openBufferedStream()	Open an InputStream which is reasonably buffered for small accesses.
final InputStream	openStream()	Open an InputStream.
final long	position()	Returns the starting position.
final long	size()	Returns the size of this data source, which is to say the number of bytes available for reading from the stream returned by StreamSource.openStream().
final String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opendaylight.raft.spi.SizedStreamSource

toSizedStreamSource

Methods inherited from interface org.opendaylight.raft.spi.StreamSource

openDataInput

Method Details

file

public abstract Path file()

Returns this source's file path.

Returns:

this source's file path

position

public final long position()

Returns the starting position.

Returns:

the starting position

limit

public final long limit()

Returns the limit.

Returns:

the limit

openStream

public final InputStream openStream()
                             throws IOException

Description copied from interface: StreamSource

Open an InputStream.

Specified by:

openStream in interface StreamSource

Returns:

an InputStream

Throws:

IOException - if an I/O error occurs

openBufferedStream

public final InputStream openBufferedStream()
                                     throws IOException

Description copied from interface: StreamSource

Open an InputStream which is reasonably buffered for small accesses. Default implementation defers to StreamSource.openStream().

Specified by:

openBufferedStream in interface StreamSource

Returns:

an InputStream

Throws:

IOException - if an I/O error occurs

size

public final long size()

Description copied from interface: SizedStreamSource

Returns the size of this data source, which is to say the number of bytes available for reading from the stream returned by StreamSource.openStream().

Specified by:

size in interface SizedStreamSource

Returns:

the size of this data source

toString

public final String toString()

Overrides:

toString in class Object