org.hkijena.jipipe.api.data.storage

Interface JIPipeWriteDataStorage

All Superinterfaces:

AutoCloseable, Closeable, JIPipeDataStorage

All Known Implementing Classes:

JIPipeFileSystemWriteDataStorage, JIPipeZIPWriteDataStorage

public interface JIPipeWriteDataStorage
extends JIPipeDataStorage

JIPipeDataStorage that is used for writing a JIPipeData.

Method Summary

Modifier and Type	Method and Description
JIPipeWriteDataStorage	resolve(Path path) Returns a new storage that resolves to a path inside this storage
default JIPipeWriteDataStorage	resolve(String name) Returns a new storage that resolves to a path inside this storage
OutputStream	write(Path path) Creates an output stream that writes the specified file element.
default OutputStream	write(String name) Creates an output stream that writes the specified file element.
default void	writeBytes(Path path, byte[] arr) Writes a byte array
default void	writeJSON(Path path, Object obj) Writes an object as JSON
default void	writeText(Path path, String text) Writes an object as JSON

Methods inherited from interface org.hkijena.jipipe.api.data.storage.JIPipeDataStorage

getFileSystemPath, getInternalPath, getProgressInfo, isFileSystemPathInitialized, relativeToAbsolute

Methods inherited from interface java.io.Closeable

close

Method Detail

resolve

default JIPipeWriteDataStorage resolve(String name)

Returns a new storage that resolves to a path inside this storage

Parameters:

name - the path name

Returns:

the sub-storage

resolve

JIPipeWriteDataStorage resolve(Path path)

Returns a new storage that resolves to a path inside this storage

Parameters:

path - the path

Returns:

the sub-storage

write

default OutputStream write(String name)

Creates an output stream that writes the specified file element. Please do not forget to close the stream.

Parameters:

name - the file name

Returns:

the file stream

write

OutputStream write(Path path)

Creates an output stream that writes the specified file element. Please do not forget to close the stream.

Parameters:

path - the file path. relative to the current store.

Returns:

the file stream

writeJSON

default void writeJSON(Path path,
                       Object obj)

Writes an object as JSON

Parameters:

path - the relative path

obj - the object

writeText

default void writeText(Path path,
                       String text)

Writes an object as JSON

Parameters:

path - the relative path

text - the text

writeBytes

default void writeBytes(Path path,
                        byte[] arr)

Writes a byte array

Parameters:

path - the relative path

arr - the byte array