org.cloudbees.literate.api.v1.vfs

Interface ProjectRepository

All Known Implementing Classes:

FilesystemRepository

public interface ProjectRepository

Represents a virtual file system that contains a project.

Method Summary

Methods

Modifier and Type	Method and Description
InputStream	get(String filePath) Returns the contents of the specified file
Set<String>	getPaths(String path) Returns the immediate child paths of the specified path.
boolean	isDirectory(String path) Returns true if and only if the specified path corresponds to a directory.
boolean	isFile(String path) Returns true if and only if the specified path corresponds to a file.

Method Detail

get

InputStream get(String filePath)
                throws PathNotFoundException,
                       IOException

Returns the contents of the specified file

Parameters:

filePath - the file path.

Returns:

the contents.

Throws:

PathNotFoundException - if the specified path does not exist.

IOException - if there was a problem retrieving the contents.

isFile

boolean isFile(String path)
               throws IOException

Returns true if and only if the specified path corresponds to a file.

Parameters:

path - the path.

Returns:

the contents.

Throws:

IOException - if there was a problem retrieving the contents.

isDirectory

boolean isDirectory(String path)
                    throws IOException

Returns true if and only if the specified path corresponds to a directory.

Parameters:

path - the file path.

Returns:

the contents.

Throws:

IOException - if there was a problem retrieving the contents.

getPaths

Set<String> getPaths(String path)
                     throws PathNotFoundException,
                            IOException

Returns the immediate child paths of the specified path.

Parameters:

path - the path to get child paths of. null is equivalent to the empty string or /

Returns:

the set of immediate child paths, fully qualified relative to the repository root. Paths ending in / indicate directories.

Throws:

PathNotFoundException - if the specified path does not exist.

IOException - if there was a problem retrieving the list of child paths.