Module io.xpipe.core

Package io.xpipe.core.store

Interface StreamDataStore

All Superinterfaces:

DataStore

All Known Subinterfaces:

KnownFormatStreamDataStore

All Known Implementing Classes:

InputStreamStore, OutputStreamStore, StdinDataStore, StdoutDataStore

public interface StreamDataStore
extends DataStore

A data store that can be accessed using InputStreams and/or OutputStreams.

Method Summary

Modifier and Type	Method	Description
default boolean	canOpen()	Checks whether this store can be opened.
default DataFlow	getFlow()
default boolean	isContentExclusivelyAccessible()	Indicates whether this data store can only be accessed by the current running application.
default InputStream	openBufferedInput()	Opens an input stream that is guaranteed to be buffered.
default InputStream	openInput()	Opens an input stream that can be used to read its data.
default OutputStream	openOutput()	Opens an output stream that can be used to write data.

Methods inherited from interface io.xpipe.core.store.DataStore

asNeeded, checkComplete, isComplete, isInStorage

Method Details

getFlow

default DataFlow getFlow()

canOpen

default boolean canOpen()

Checks whether this store can be opened. This can be not the case for example if the underlying store does not exist.

isContentExclusivelyAccessible

default boolean isContentExclusivelyAccessible()

Indicates whether this data store can only be accessed by the current running application. One example are standard in and standard out stores.

See Also:

• StdinDataStore
• StdoutDataStore

openInput

default InputStream openInput()

Opens an input stream that can be used to read its data.

openBufferedInput

default InputStream openBufferedInput()
                               throws Exception

Opens an input stream that is guaranteed to be buffered.

Throws:

Exception

openOutput

default OutputStream openOutput()

Opens an output stream that can be used to write data.