com.atlassian.dc.filestore.api

Interface FileStore.Reader

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.Reader

Represents read operations on a file within a FileStore.

Method Summary

Modifier and Type	Method and Description
default void	consume(FileStore.InputStreamConsumer inputStreamConsumer) Consumes the contents of the file.
default InputStreamAndMeta	getInputStreamAndMeta() Opens an input stream and returns it with extra information such as its length.
InputStream	openInputStream() Opens a new InputStream for the file.
default <T> T	read(FileStore.InputStreamExtractor<T> inputStreamExtractor) Consumes the contents of the file and produces a result.

Method Detail

openInputStream

InputStream openInputStream()
                     throws IOException,
                            FileStoreAccessDeniedException,
                            FileStoreNoSuchFileException

Opens a new InputStream for the file. It is the responsibility of the caller to close the stream when it is no longer required.

Returns:

the new InputStream

Throws:

IOException - if the file cannot be opened for reading.

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

FileStoreNoSuchFileException - if the file does not exist.

consume

default void consume(FileStore.InputStreamConsumer inputStreamConsumer)
              throws IOException,
                     FileStoreAccessDeniedException,
                     FileStoreNoSuchFileException

Consumes the contents of the file.

Parameters:

inputStreamConsumer - An FileStore.InputStreamConsumer which consumes the file contents.

Throws:

IOException - if the file cannot be read

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

FileStoreNoSuchFileException - if the file does not exist.

read

default <T> T read(FileStore.InputStreamExtractor<T> inputStreamExtractor)
            throws IOException,
                   FileStoreAccessDeniedException,
                   FileStoreNoSuchFileException

Consumes the contents of the file and produces a result.

Type Parameters:

T - The type of the result.

Parameters:

inputStreamExtractor - An FileStore.InputStreamExtractor which consumes the file contents and produces the result.

Returns:

The result of the file content extraction.

Throws:

IOException - If the file cannot be read.

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

FileStoreNoSuchFileException - if the file does not exist.

getInputStreamAndMeta

default InputStreamAndMeta getInputStreamAndMeta()
                                          throws IOException,
                                                 FileStoreAccessDeniedException,
                                                 FileStoreNoSuchFileException

Opens an input stream and returns it with extra information such as its length. Must close the InputStream if an exception is thrown after it's opened and before returning.

Returns:

the new InputStreamAndMeta

Throws:

IOException - if the file cannot be opened for reading.

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

FileStoreNoSuchFileException - if the file does not exist.