org.cloudbees.literate.api.v1.vfs

Class FilesystemRepository

java.lang.Object

org.cloudbees.literate.api.v1.vfs.FilesystemRepository

All Implemented Interfaces:

ProjectRepository

public class FilesystemRepository
extends Object
implements ProjectRepository

A ProjectRepository hosted on the local file system.

Constructor Summary

Constructors

Constructor and Description
FilesystemRepository(File root) Constructor.

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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FilesystemRepository

public FilesystemRepository(File root)

Constructor.

Parameters:

root - The root of the ProjectRepository.

Method Detail

get

public InputStream get(String filePath)
                throws PathNotFoundException,
                       IOException

Returns the contents of the specified file

Specified by:

get in interface ProjectRepository

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.

isDirectory

public boolean isDirectory(String path)
                    throws IOException

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

Specified by:

isDirectory in interface ProjectRepository

Parameters:

path - the file path.

Returns:

the contents.

Throws:

IOException - if there was a problem retrieving the contents.

isFile

public boolean isFile(String path)
               throws IOException

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

Specified by:

isFile in interface ProjectRepository

Parameters:

path - the path.

Returns:

the contents.

Throws:

IOException - if there was a problem retrieving the contents.

getPaths

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

Returns the immediate child paths of the specified path.

Specified by:

getPaths in interface ProjectRepository

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.