com.atlassian.dc.filestore.api.compat

Interface FilesystemPath

All Superinterfaces:

FileStore.Path, FilesystemAccess

public interface FilesystemPath
extends FileStore.Path, FilesystemAccess

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

Use of this interface should be considered a stop-gap measure to provide backward-compatibility with code that requires access to the underlying files.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	FilesystemPath.Pruner

Nested classes/interfaces inherited from interface com.atlassian.dc.filestore.api.compat.FilesystemAccess

FilesystemAccess.AccessDenied

Method Summary

Modifier and Type	Method and Description
FilesystemPath.Pruner	deleteFileAndPrune() Deletes the file at the given path, and prunes any empty directories.
Stream<FilesystemPath>	getFileDescendents() Finds all files that are descendents of the current path and returns them as a stream.
Optional<FilesystemPath>	getParent()
FilesystemPath	path(String... pathComponents)

Methods inherited from interface com.atlassian.dc.filestore.api.FileStore.Path

clonePath, copyFile, copyFiles, deleteFile, exists, fileExists, fileReader, fileWriter, getFileSize, getLeafName, getPathName, moveFile, snapshot, tryDeleteFile, tryFileExists, unpack

Methods inherited from interface com.atlassian.dc.filestore.api.compat.FilesystemAccess

asJavaFile, asJavaPath, getFilesystemPath

Method Detail

deleteFileAndPrune

@CheckReturnValue
FilesystemPath.Pruner deleteFileAndPrune()
                                                    throws IOException

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

Returns:

a FilesystemPath.Pruner

Throws:

IOException

Since:

0.6.0

path

FilesystemPath path(String... pathComponents)

Specified by:

path in interface FileStore.Path

Returns:

a FileStore.Path relative to the current path.

getFileDescendents

Stream<FilesystemPath> getFileDescendents()
                                   throws IOException

Description copied from interface: FileStore.Path

Finds all files that are descendents of the current path and returns them as a stream. Be very careful with this method, as it may return a very large number of files.

The files returned by this method will always be ordered lexicographically by their path name, sorted as if any path components are separated by the "/" character, rather than the platform-specific file separator.

Specified by:

getFileDescendents in interface FileStore.Path

Throws:

IOException - if the descents cannot be determined.

getParent

Optional<FilesystemPath> getParent()

Specified by:

getParent in interface FileStore.Path

Returns:

The path representing the parent directory of this FilesystemPath

Since:

0.8