de.espirit.firstspirit.io

Interface FileSystem<T extends FileHandle>

All Superinterfaces:

AutoCloseable, Closeable

public interface FileSystem<T extends FileHandle>
extends Closeable

Interface represanting a filesystem and providing means to operate on file handles.

Since:

4.0

Field Summary

Fields

Modifier and Type	Field and Description
static String	SEPARATOR Path separator String.
static char	SEPARATOR_CHAR Path separator char.

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Close file system.
T	obtain(String path) Obtain a handle to the file or directory with the given path.

Field Detail

SEPARATOR

static final String SEPARATOR

Path separator String.

Since:

4.0

See Also:

Constant Field Values

SEPARATOR_CHAR

static final char SEPARATOR_CHAR

Path separator char.

Since:

4.0

Method Detail

obtain

@NotNull
T obtain(@Nullable
               String path)
                            throws IOException

Obtain a handle to the file or directory with the given path.

If the given path is null or empty, the handle of the current working directory is returned.

Parameters:

path - The path to the file or directory.

Returns:

A FileHandle.

Throws:

IOException

Since:

4.0

close

void close()
           throws IOException

Close file system.
Releases any resources associated with this file system. Do not use the file system after calling this method.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException

Since:

4.0