Module io.xpipe.core

Package io.xpipe.core.impl

Class FileStore

java.lang.Object

io.xpipe.core.util.JacksonizedValue

io.xpipe.core.impl.FileStore

All Implemented Interfaces:

DataStore, FilenameStore, StreamDataStore

public class FileStore
extends JacksonizedValue
implements FilenameStore, StreamDataStore

Represents a file located on a file system.

Constructor Summary

Constructors

Constructor	Description
FileStore(FileSystemStore fileSystem, String path)

Method Summary

Modifier and Type	Method	Description
boolean	canOpen()	Checks whether this store can be opened.
void	checkComplete()
String	getFileName()
String	getParent()
final boolean	isLocal()
static FileStore	local(String p)	Creates a file store for a file that is local to the callers machine.
static FileStore	local(Path p)
InputStream	openInput()	Opens an input stream that can be used to read its data.
OutputStream	openOutput()	Opens an output stream that can be used to write data.

Methods inherited from class io.xpipe.core.util.JacksonizedValue

equals, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

asNeeded, delete, determineLastModified, getFlow, isComplete, isContentExclusivelyAccessible, shouldPersist, shouldSave, validate

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

determineDefaultName, getFileExtension

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

openBufferedInput

Constructor Details

FileStore

public FileStore(FileSystemStore fileSystem,
 String path)

Method Details

local

public static FileStore local(Path p)

local

public static FileStore local(String p)

Creates a file store for a file that is local to the callers machine.

getParent

public String getParent()

isLocal

public final boolean isLocal()

checkComplete

public void checkComplete()
                   throws Exception

Specified by:

checkComplete in interface DataStore

Throws:

Exception

openInput

public InputStream openInput()
                      throws Exception

Description copied from interface: StreamDataStore

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

Specified by:

openInput in interface StreamDataStore

Throws:

Exception

openOutput

public OutputStream openOutput()
                        throws Exception

Description copied from interface: StreamDataStore

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

Specified by:

openOutput in interface StreamDataStore

Throws:

Exception

canOpen

public boolean canOpen()
                throws Exception

Description copied from interface: DataStore

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

Specified by:

canOpen in interface DataStore

Throws:

Exception

getFileName

public String getFileName()

Specified by:

getFileName in interface FilenameStore