ome.smuggler.core.service.file

Interface TaskFileStore<T extends util.object.Identifiable>

All Known Implementing Classes:

TaskIdPathStore

public interface TaskFileStore<T extends util.object.Identifiable>

Manages a directory containing files associated to Identifiable task ID's.

Method Summary

Modifier and Type	Method and Description
void	add(T taskId, util.lambda.ConsumerE<java.io.OutputStream> contentWriter) Writes a file associated to the specified task.
void	add(T taskId, java.nio.file.Path contentSource) Writes a file associated to the specified task by taking the contents from a source file.
default void	add(T taskId, java.lang.String content) Writes a file associated to the specified task.
java.util.stream.Stream<T>	listTaskIds()
java.nio.file.Path	pathFor(T taskId) Builds the path to the file associated to the given task ID.
void	remove(T taskId) Deletes the file associated to the specified task ID.
default void	replace(T taskId, util.lambda.FunctionE<java.lang.String,java.lang.String> setter) Uses a setter function to replace the content of the file associated to the specified task.
void	replace(T taskId, StreamFilter filter) Uses a filter function to replace the content of the file associated to the specified task.

Method Detail

pathFor

java.nio.file.Path pathFor(T taskId)

Builds the path to the file associated to the given task ID.

Parameters:

taskId - the task ID.

Returns:

the path associated to the ID.

Throws:

java.lang.NullPointerException - if the argument is null.

listTaskIds

java.util.stream.Stream<T> listTaskIds()

Returns:

the task ID's of all files currently stored in the directory.

The following checked exceptions are rethrown as unchecked (i.e. the exception is masked as a runtime exception and thrown as is without wrapping it in a RuntimeException):
IOException if an I/O occurs.

remove

void remove(T taskId)

Deletes the file associated to the specified task ID.

Parameters:

taskId - the task ID.

Throws:

java.lang.NullPointerException - if the argument is null.

The following checked exceptions are rethrown as unchecked (i.e. the exception is masked as a runtime exception and thrown as is without wrapping it in a RuntimeException):
IOException if an I/O occurs.

add

void add(T taskId,
         util.lambda.ConsumerE<java.io.OutputStream> contentWriter)

Writes a file associated to the specified task. If the file already exists, it will be overwritten.

Parameters:

taskId - identifies the task.

contentWriter - writes the file contents into an output stream.

Throws:

java.lang.NullPointerException - if any argument is null.

The following checked exceptions are rethrown as unchecked (i.e. the exception is masked as a runtime exception and thrown as is without wrapping it in a RuntimeException):
IOException if an I/O occurs.

add

default void add(T taskId,
                 java.lang.String content)

Writes a file associated to the specified task. If the file already exists, it will be overwritten.

Parameters:

taskId - identifies the task.

content - the file contents.

Throws:

java.lang.NullPointerException - if any argument is null.

The following checked exceptions are rethrown as unchecked (i.e. the exception is masked as a runtime exception and thrown as is without wrapping it in a RuntimeException):
IOException if an I/O occurs.

add

void add(T taskId,
         java.nio.file.Path contentSource)

Writes a file associated to the specified task by taking the contents from a source file. If the file already exists in the store, it will be overwritten. (The source file is never modified though.)

Parameters:

taskId - identifies the task.

contentSource - the file contents to use.

Throws:

java.lang.NullPointerException - if any argument is null.

The following checked exceptions are rethrown as unchecked (i.e. the exception is masked as a runtime exception and thrown as is without wrapping it in a RuntimeException):
IOException if an I/O occurs.

replace

void replace(T taskId,
             StreamFilter filter)

Uses a filter function to replace the content of the file associated to the specified task.

Parameters:

taskId - identifies the task.

filter - gets passed the current content of the file and produces the new file content.

Throws:

java.lang.NullPointerException - if any argument is null.

java.lang.IllegalArgumentException - if there's no file associated to the specified task.

The following checked exceptions are rethrown as unchecked (i.e. the exception is masked as a runtime exception and thrown as is without wrapping it in a RuntimeException):
Exception if any other kind of error occurs.

See Also:

replace(Identifiable, FunctionE)

replace

default void replace(T taskId,
                     util.lambda.FunctionE<java.lang.String,java.lang.String> setter)

Uses a setter function to replace the content of the file associated to the specified task. This method reads the entire file content into memory as a string s using the default character encoding, calls setter with s as an argument, and overrides the old file contents with the returned string.

Parameters:

taskId - identifies the task.

setter - gets passed the current content of the file and produces the new file content.

Throws:

java.lang.NullPointerException - if any argument is null.

java.lang.IllegalArgumentException - if there's no file associated to the specified task.

The following checked exceptions are rethrown as unchecked (i.e. the exception is masked as a runtime exception and thrown as is without wrapping it in a RuntimeException):
Exception if any other kind of error occurs.

See Also:

replace(Identifiable, StreamFilter)