public interface

DirectoryBrowser

com.atlassian.crucible.scm.DirectoryBrowser

Summary

Public Methods
abstract FileHistory	getFileHistory(Principal principal, String path, String pegRevision) Get the change history of the given file or directory (history of directory changes may not be supported by all SCMs).
abstract List<DirectorySummary>	listDirectories(Principal principal, String path) Get a summary of each directory directly under a given path
abstract List<FileSummary>	listFiles(Principal principal, String path) Get a summary of each file directly under a given path.

Get the change history of the given file or directory (history of directory changes may not be supported by all SCMs).

principal	the principal performing this operation
path	the path to the file or directory in question
pegRevision	for those SCMs which support it, this is the peg revision to identify which particular version of the file on the path is required.

NotFoundException	when the specified path cannot be found.

Get a summary of each directory directly under a given path

principal	the principal performing this operation
path	the path to the directory whose directories are required

a list of DirectorySummary objects, each being a directory directly at the given path

NotFoundException	when the specified path cannot be found.

Get a summary of each file directly under a given path. If the specified path refers to a file instead of a directory, an empty is returned.

principal	the principal performing this operation
path	the path to the directory whose files are required

a list of FileSummary objects, each being a file directly at the given path (directories excluded)

NotFoundException	when the specified path cannot be found.