Package org.opendaylight.raft.spi

Interface StreamSource

All Known Subinterfaces:

SizedStreamSource, UnsizedStreamSource

All Known Implementing Classes:

AbstractFileStreamSource, ByteArray, FileStreamSource, TransientFileStreamSource

@NonNullByDefault
public sealed interface StreamSource
permits UnsizedStreamSource, SizedStreamSource

Interface capturing the ability to open InputStreams.

Method Summary

Modifier and Type	Method	Description
default InputStream	openBufferedStream()	Open an InputStream which is reasonably buffered for small accesses.
default DataInputStream	openDataInput()	Open a DataInputStream, performing buffering over openStream() if needed.
InputStream	openStream()	Open an InputStream.
SizedStreamSource	toSizedStreamSource()	Return the SizedStreamSource equivalent of this StreamSource.

Method Details

openStream

InputStream openStream()
                throws IOException

Open an InputStream.

Returns:

an InputStream

Throws:

IOException - if an I/O error occurs

openBufferedStream

default InputStream openBufferedStream()
                                throws IOException

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

Returns:

an InputStream

Throws:

IOException - if an I/O error occurs

toSizedStreamSource

SizedStreamSource toSizedStreamSource()
                               throws IOException

Return the SizedStreamSource equivalent of this StreamSource.

Returns:

the SizedStreamSource equivalent of this StreamSource

Throws:

IOException - if an I/O error occurs

openDataInput

default DataInputStream openDataInput()
                               throws IOException

Open a DataInputStream, performing buffering over openStream() if needed.

Returns:

a DataInputStream

Throws:

IOException - if an I/O error occurs