fitnesse.wiki.fs

Interface VersionsController

All Known Implementing Classes:

MemoryVersionsController, SimpleFileVersionsController, ZipFileVersionsController

public interface VersionsController

Method Summary

Modifier and Type	Method and Description
VersionInfo	addDirectory(FileVersion filePath) Add a directory.
void	delete(java.io.File... files) Delete a bunch of files.
FileVersion[]	getRevisionData(java.lang.String revision, java.io.File... files) Obtain data for the files requested at a specific revision
java.util.Collection<VersionInfo>	history(java.io.File... files) Get history information for a set of files.
VersionInfo	makeVersion(FileVersion... fileVersion) Store files as one revision.
void	rename(FileVersion fileVersion, java.io.File originalFile) Rename a file.

Method Detail

getRevisionData

FileVersion[] getRevisionData(java.lang.String revision,
                              java.io.File... files)
                       throws java.io.IOException

Obtain data for the files requested at a specific revision

Parameters:

revision - The revision to look for

files - Files to obtain data for

Returns:

An array of FileVersion elements is returned. The size is equal to the number of files requested, although there is no guarantee all files will be found at a specific revision.

Throws:

java.io.IOException

history

java.util.Collection<VersionInfo> history(java.io.File... files)

Get history information for a set of files.

Parameters:

files - Files to look for.

Returns:

history

makeVersion

VersionInfo makeVersion(FileVersion... fileVersion)
                 throws java.io.IOException

Store files as one revision.

Parameters:

fileVersion - The files to store

Returns:

Version information. VersionInfo.label should refer to this revision, so it can be retrieved later.

Throws:

java.io.IOException - IOException

addDirectory

VersionInfo addDirectory(FileVersion filePath)
                  throws java.io.IOException

Add a directory. We only add them one at a time.

Parameters:

filePath - directory to add

Returns:

VersionInfo

Throws:

java.io.IOException - IOException

rename

void rename(FileVersion fileVersion,
            java.io.File originalFile)
     throws java.io.IOException

Rename a file. Used for the files/ section. No author information is stored here.

Parameters:

fileVersion - File to rename to.

originalFile - The original file.

Throws:

java.io.IOException - IOException

delete

void delete(java.io.File... files)
     throws java.io.IOException

Delete a bunch of files.

Parameters:

files - files to delete

Throws:

java.io.IOException