A C D E F G H I M O P R S T U W

A

AccessDenied(Path) - Constructor for exception com.atlassian.dc.filestore.api.compat.FilesystemAccess.AccessDenied

asJavaFile() - Method in interface com.atlassian.dc.filestore.api.compat.FilesystemAccess

asJavaPath() - Method in interface com.atlassian.dc.filestore.api.compat.FilesystemAccess

C

clonePath() - Method in interface com.atlassian.dc.filestore.api.FileStore.Path

Creates a deep copy of the path that does not share any mutable state with the original.

com.atlassian.dc.filestore.api - package com.atlassian.dc.filestore.api

com.atlassian.dc.filestore.api.compat - package com.atlassian.dc.filestore.api.compat

com.atlassian.dc.filestore.api.exception - package com.atlassian.dc.filestore.api.exception

compareTo(DataSize) - Method in class com.atlassian.dc.filestore.api.DataSize

consume(InputStream) - Method in interface com.atlassian.dc.filestore.api.FileStore.InputStreamConsumer

Consumes the given InputStream.

consume(FileStore.InputStreamConsumer) - Method in interface com.atlassian.dc.filestore.api.FileStore.Reader

Consumes the contents of the file.

copyFile(FileStore.Path) - Method in interface com.atlassian.dc.filestore.api.FileStore.Path

Copies the file at this path to a new path.

copyFiles(FileStore.Path) - Method in interface com.atlassian.dc.filestore.api.FileStore.Path

Copies all files from under the current path, to a new root path, maintaining the relative path structure of all copied files.

D

DataSize - Class in com.atlassian.dc.filestore.api

A representation of data quantity.

deleteFile() - Method in interface com.atlassian.dc.filestore.api.FileStore.Path

Deletes the file at this path.

deleteFileAndPrune() - Method in interface com.atlassian.dc.filestore.api.compat.FilesystemPath

Deletes the file at the given path, and prunes any empty directories.

E

equals(Object) - Method in class com.atlassian.dc.filestore.api.DataSize

exists() - Method in interface com.atlassian.dc.filestore.api.FileStore.Path

extract(InputStream) - Method in interface com.atlassian.dc.filestore.api.FileStore.InputStreamExtractor

Consumes the given InputStream, and extracts a result.

F

file - Variable in exception com.atlassian.dc.filestore.api.exception.FileStoreException

fileExists() - Method in interface com.atlassian.dc.filestore.api.FileStore.Path

fileReader() - Method in interface com.atlassian.dc.filestore.api.FileStore.Path

FileStore - Interface in com.atlassian.dc.filestore.api

A high-level representation of a store of files.

FileStore.InputStreamConsumer - Interface in com.atlassian.dc.filestore.api

FileStore.InputStreamExtractor<T> - Interface in com.atlassian.dc.filestore.api

FileStore.InputStreamSupplier - Interface in com.atlassian.dc.filestore.api

FileStore.OutputStreamWriter - Interface in com.atlassian.dc.filestore.api

FileStore.Path - Interface in com.atlassian.dc.filestore.api

Represents a Path within a FileStore.

FileStore.Reader - Interface in com.atlassian.dc.filestore.api

Represents read operations on a file within a FileStore.

FileStore.Writer - Interface in com.atlassian.dc.filestore.api

Represents write operations on a file in a FileStore.

FileStoreAccessDeniedException - Exception in com.atlassian.dc.filestore.api.exception

Thrown when user doesn't have sufficient permissions to perform the operation on the object.

FileStoreAccessDeniedException(String, String, Throwable) - Constructor for exception com.atlassian.dc.filestore.api.exception.FileStoreAccessDeniedException

FileStoreAccessDeniedException(String, Throwable) - Constructor for exception com.atlassian.dc.filestore.api.exception.FileStoreAccessDeniedException

FileStoreException - Exception in com.atlassian.dc.filestore.api.exception

General File Store Exception.

FileStoreException(String, String, Throwable) - Constructor for exception com.atlassian.dc.filestore.api.exception.FileStoreException

FileStoreException(String, Throwable) - Constructor for exception com.atlassian.dc.filestore.api.exception.FileStoreException

FileStoreNoSuchFileException - Exception in com.atlassian.dc.filestore.api.exception

Thrown when searched object can't be found.

FileStoreNoSuchFileException(String, String, Throwable) - Constructor for exception com.atlassian.dc.filestore.api.exception.FileStoreNoSuchFileException

FileStoreNoSuchFileException(String, Throwable) - Constructor for exception com.atlassian.dc.filestore.api.exception.FileStoreNoSuchFileException

FilesystemAccess - Interface in com.atlassian.dc.filestore.api.compat

Provides operation to provide access to the underlying filesystem.

FilesystemAccess.AccessDenied - Exception in com.atlassian.dc.filestore.api.compat

FilesystemPath - Interface in com.atlassian.dc.filestore.api.compat

An extension of FileStore.Path which provides visibility on the local filesystem's underlying path structure.

FilesystemPath.Pruner - Interface in com.atlassian.dc.filestore.api.compat

fileWriter() - Method in interface com.atlassian.dc.filestore.api.FileStore.Path

fileWriter() - Method in interface com.atlassian.dc.filestore.api.WriteOnlyPath

G

get() - Method in interface com.atlassian.dc.filestore.api.FileStore.InputStreamSupplier

Provides an InputStream for reading from.

getAvailableSpace() - Method in interface com.atlassian.dc.filestore.api.FileStore

getBytes() - Method in class com.atlassian.dc.filestore.api.DataSize

getFileDescendents() - Method in interface com.atlassian.dc.filestore.api.compat.FilesystemPath

getFileDescendents() - Method in interface com.atlassian.dc.filestore.api.FileStore.Path

Finds all files that are descendents of the current path and returns them as a stream.

getFileSize() - Method in interface com.atlassian.dc.filestore.api.FileStore.Path

Determines the exact size of the file at the given path.

getFilesystemPath() - Method in interface com.atlassian.dc.filestore.api.compat.FilesystemAccess

Deprecated.

use FilesystemAccess.asJavaPath()

getInputStream() - Method in class com.atlassian.dc.filestore.api.InputStreamAndMeta

getInputStreamAndMeta() - Method in interface com.atlassian.dc.filestore.api.FileStore.Reader

Opens an input stream and returns it with extra information such as its length.

getLeafName() - Method in interface com.atlassian.dc.filestore.api.FileStore.Path

getLength() - Method in class com.atlassian.dc.filestore.api.InputStreamAndMeta

getParent() - Method in interface com.atlassian.dc.filestore.api.compat.FilesystemPath

getParent() - Method in interface com.atlassian.dc.filestore.api.FileStore.Path

getPathName() - Method in interface com.atlassian.dc.filestore.api.FileStore.Path

getTotalSpace() - Method in interface com.atlassian.dc.filestore.api.FileStore

H

hashCode() - Method in class com.atlassian.dc.filestore.api.DataSize

I

InputStreamAndMeta - Class in com.atlassian.dc.filestore.api

An aggregate of an InputStream and additional metadata.

InputStreamAndMeta(InputStream, Long) - Constructor for class com.atlassian.dc.filestore.api.InputStreamAndMeta

An aggregate of an InputStream and its length.

M

moveFile(FileStore.Path) - Method in interface com.atlassian.dc.filestore.api.FileStore.Path

Moves the file at this path to a new path.

O

ofBytes(long) - Static method in class com.atlassian.dc.filestore.api.DataSize

openInputStream() - Method in interface com.atlassian.dc.filestore.api.FileStore.Reader

Opens a new InputStream for the file.

P

path(String...) - Method in interface com.atlassian.dc.filestore.api.compat.FilesystemPath

path(String...) - Method in interface com.atlassian.dc.filestore.api.FileStore

path(String...) - Method in interface com.atlassian.dc.filestore.api.FileStore.Path

path(String...) - Method in interface com.atlassian.dc.filestore.api.WriteOnlyPath

R

read(FileStore.InputStreamExtractor<T>) - Method in interface com.atlassian.dc.filestore.api.FileStore.Reader

Consumes the contents of the file and produces a result.

root() - Method in interface com.atlassian.dc.filestore.api.FileStore

S

snapshot() - Method in interface com.atlassian.dc.filestore.api.FileStore.Path

Creates a new snapshot of all files under the current path.

Snapshot - Interface in com.atlassian.dc.filestore.api

Represents a snapshot of a FileStore.Path.

T

toString() - Method in class com.atlassian.dc.filestore.api.DataSize

tryDeleteFile() - Method in interface com.atlassian.dc.filestore.api.FileStore.Path

Attempts to delete the file at this path, if it exists.

tryFileExists() - Method in interface com.atlassian.dc.filestore.api.FileStore.Path

Determines if a file exists at the current path.

U

unpack(Snapshot) - Method in interface com.atlassian.dc.filestore.api.FileStore.Path

Unpacks the contents of the given snapshot at the current path.

unpack(Path) - Method in interface com.atlassian.dc.filestore.api.Snapshot

Unpacks the snapshot at the given filesstem path.

untilReach(FilesystemPath) - Method in interface com.atlassian.dc.filestore.api.compat.FilesystemPath.Pruner

Prunes empty parent directories until the given directory is reached.

W

write(InputStream) - Method in interface com.atlassian.dc.filestore.api.FileStore.Writer

Writes the data from the given InputStream to the file.

write(FileStore.InputStreamSupplier) - Method in interface com.atlassian.dc.filestore.api.FileStore.Writer

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

write(byte[]) - Method in interface com.atlassian.dc.filestore.api.FileStore.Writer

Writes the given byte array to the file.

write(FileStore.OutputStreamWriter) - Method in interface com.atlassian.dc.filestore.api.FileStore.Writer

Writes to the file using an FileStore.OutputStreamWriter.

WriteOnlyPath - Interface in com.atlassian.dc.filestore.api

Represents write operations on a file.

writeTo(OutputStream) - Method in interface com.atlassian.dc.filestore.api.FileStore.OutputStreamWriter

Write to the given OutputStream.

A C D E F G H I M O P R S T U W