com.atlassian.dc.filestore.api

Interface FileStore.Path

All Known Subinterfaces:

FilesystemPath

Enclosing interface:

FileStore

public static interface FileStore.Path

Represents a Path within a FileStore.

Method Summary

Modifier and Type	Method and Description
FileStore.Path	clonePath() Creates a deep copy of the path that does not share any mutable state with the original.
default void	copyFile(FileStore.Path toFile) Copies the file at this path to a new path.
default void	copyFiles(FileStore.Path toPath) Copies all files from under the current path, to a new root path, maintaining the relative path structure of all copied files.
void	deleteFile() Deletes the file at this path.
boolean	exists()
boolean	fileExists()
FileStore.Reader	fileReader()
FileStore.Writer	fileWriter()
Stream<? extends FileStore.Path>	getFileDescendents() Finds all files that are descendents of the current path and returns them as a stream.
default DataSize	getFileSize() Determines the exact size of the file at the given path.
Optional<String>	getLeafName()
Optional<? extends FileStore.Path>	getParent()
String	getPathName()
default void	moveFile(FileStore.Path toFile) Moves the file at this path to a new path.
FileStore.Path	path(String... pathComponents)
default Snapshot	snapshot() Creates a new snapshot of all files under the current path.
default boolean	tryDeleteFile() Attempts to delete the file at this path, if it exists.
default boolean	tryFileExists() Determines if a file exists at the current path.
default void	unpack(Snapshot snapshot) Unpacks the contents of the given snapshot at the current path.

Method Detail

path

FileStore.Path path(String... pathComponents)

Returns:

a FileStore.Path relative to the current path.

fileExists

boolean fileExists()
            throws IOException

Returns:

true if a file exists at this path, otherwise false

Throws:

IOException - if the existence of the file cannot be established

exists

boolean exists()
        throws IOException

Returns:

For standard file system returns true if file or directory exists, otherwise false For other storage (e.g. object storage) returns true if file exists or this is a prefix, otherwise false

Throws:

IOException - if the existence of the file cannot be established

tryFileExists

default boolean tryFileExists()

Determines if a file exists at the current path. If this cannot be determined due to an exception, then it assumes it does not exist.

Returns:

true if a file exists at this path, otherwise false

fileReader

FileStore.Reader fileReader()

Returns:

a FileStore.Reader for the file at this path

fileWriter

FileStore.Writer fileWriter()

Returns:

a FileStore.Writer for the file at this path

deleteFile

void deleteFile()
         throws IOException

Deletes the file at this path.

Throws:

FileNotFoundException - If no file exists at this path

IOException - if the file could not be deleted

clonePath

FileStore.Path clonePath()

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

Returns:

a deep copy of the path

tryDeleteFile

default boolean tryDeleteFile()

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

Returns:

true if the file was deleted, false if it does not exist, or it otherwise could not be deleted.

moveFile

default void moveFile(FileStore.Path toFile)
               throws IOException

Moves the file at this path to a new path. If a file already exists at the new path, it will be overwritten.

The default implementation of this method first copies the data from the source file to the target, and then deletes the source file, but concrete implementations may provide a more efficient solution.

Throws:

IOException - If the move fails

copyFile

default void copyFile(FileStore.Path toFile)
               throws IOException

Copies the file at this path to a new path. If a file already exists at the new path, it will be overwritten.

The default implementation of this method streams the data from the source to the target, but concrete impementations may provide a more efficient solution.

Throws:

IOException - If the move fails

copyFiles

default void copyFiles(FileStore.Path toPath)
                throws IOException

Copies all files from under the current path, to a new root path, maintaining the relative path structure of all copied files. The default implementation of this method takes a snapshot() of the current path, then unpack(Snapshot)s that snapshot at the new path. Concrete implementations may perform a more optimised copy.

Throws:

IOException

Since:

0.7.0

getFileSize

default DataSize getFileSize()
                      throws IOException

Determines the exact size of the file at the given path. The default implementation streams and counts the file contents, but implementators should provide a more efficient implementation.

Returns:

The file size

Throws:

IOException - if the file size cannot be determined

getPathName

String getPathName()

Returns:

the string representation of this path, relative to FileStore.root().

getLeafName

Optional<String> getLeafName()

Returns:

the string representation of the last component of this path, or empty if this path has no components

getParent

Optional<? extends FileStore.Path> getParent()

Returns:

the parent path for this path, or empty if this path is the FileStore.root().

getFileDescendents

Stream<? extends FileStore.Path> getFileDescendents()
                                             throws IOException

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.

Throws:

IOException - if the descents cannot be determined.

snapshot

default Snapshot snapshot()
                   throws IOException

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

Throws:

IOException

Since:

0.7.0

unpack

default void unpack(Snapshot snapshot)
             throws IOException

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

Throws:

IOException

Since:

0.7.0