com.atlassian.dc.filestore.api

Interface FileStore

@ExperimentalApi
 @ExperimentalSpi
public interface FileStore

A high-level representation of a store of files.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	FileStore.InputStreamConsumer
static interface	FileStore.InputStreamExtractor<T>
static interface	FileStore.InputStreamSupplier
static interface	FileStore.OutputStreamWriter
static interface	FileStore.Path Represents a Path within a FileStore.
static interface	FileStore.Reader Represents read operations on a file within a FileStore.
static interface	FileStore.Writer Represents write operations on a file in a FileStore.

Method Summary

Modifier and Type	Method and Description
default Optional<DataSize>	getAvailableSpace()
default Optional<DataSize>	getTotalSpace()
default FileStore.Path	path(String... pathComponents)
FileStore.Path	root()

Method Detail

root

FileStore.Path root()

Returns:

The root path of this FileStore.

path

default FileStore.Path path(String... pathComponents)

Returns:

a FileStore.Path within this FileStore relative to the root().

getAvailableSpace

default Optional<DataSize> getAvailableSpace()

Returns:

The amount of available space for this FileStore. If the available space cannot be determined or is undefined, an empty value is returned.

getTotalSpace

default Optional<DataSize> getTotalSpace()

Returns:

The amount of total space for this FileStore. If the available space cannot be determined or is undefined, an empty value is returned.