com.atlassian.dc.filestore.api

Interface FileStore.Writer

Enclosing interface:

FileStore

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public static interface FileStore.Writer

Represents write operations on a file in a FileStore.

Method Summary

Modifier and Type	Method and Description
default void	write(byte[] data) Writes the given byte array to the file.
default void	write(FileStore.InputStreamSupplier inputStreamSupplier) Writes the data provided by the given FileStore.InputStreamSupplier to the file.
default void	write(FileStore.OutputStreamWriter bufferWriter) Writes to the file using an FileStore.OutputStreamWriter.
void	write(InputStream source) Writes the data from the given InputStream to the file.

Method Detail

write

void write(@WillNotClose
           InputStream source)
    throws IOException,
           FileStoreAccessDeniedException

Writes the data from the given InputStream to the file. It is the responsibility of the caller to ensure that the source stream is closed when no longer required.

Parameters:

source - The InputStream containing the data to be written.

Throws:

IOException - If the file cannot be written, or if the source cannot be read.

FileStoreAccessDeniedException - if the required permissions to write the file are not present.

write

default void write(FileStore.InputStreamSupplier inputStreamSupplier)
            throws IOException,
                   FileStoreAccessDeniedException

Writes the data provided by the given FileStore.InputStreamSupplier to the file.

Parameters:

inputStreamSupplier - An FileStore.InputStreamSupplier which provides an InputStream.

Throws:

IOException - If the file cannot be written to, or if the source cannot be read.

FileStoreAccessDeniedException - if the required permissions to write the file are not present.

write

default void write(byte[] data)
            throws IOException,
                   FileStoreAccessDeniedException

Writes the given byte array to the file.

Parameters:

data - The bytes to be written.

Throws:

IOException - If the file cannot be writen to.

FileStoreAccessDeniedException - if the required permissions to write the file are not present.

write

default void write(FileStore.OutputStreamWriter bufferWriter)
            throws IOException,
                   FileStoreAccessDeniedException

Writes to the file using an FileStore.OutputStreamWriter. The default implementation will write the contents into a memory buffer, then the buffer will written to the file. Implementing classes may change this behaviour.

Parameters:

bufferWriter - The FileStore.OutputStreamWriter which will write the file contents.

Throws:

IOException - If the file cannot be written to.

FileStoreAccessDeniedException - if the required permissions to write the file are not present.