|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface AdminHandler
Handles the maintaining and reading of administration information on the local machine. The standard CVS client does this by putting various files in a CVS directory underneath each checked-out directory. How the files are laid out and managed is not specified by the protocol document.
Hence it is envisaged that, eventually, a client could add additional files for higher performance or even change the mechanism for storing the information completely.
Method Summary | |
---|---|
boolean |
exists(java.io.File file)
Tests for existence of the given file. |
java.util.Set |
getAllFiles(java.io.File directory)
Get all the files contained within a given directory that are known to CVS. |
java.util.Iterator |
getEntries(java.io.File directory)
Get the entries for a specified directory. |
Entry |
getEntry(java.io.File file)
Get the Entry for the specified file, if one exists |
java.lang.String |
getRepositoryForDirectory(java.lang.String directory,
java.lang.String repository)
Get the repository path for a given directory, for example in the directory /home/project/foo/bar, the repository directory might be /usr/cvs/foo/bar. |
java.lang.String |
getStickyTagForDirectory(java.io.File directory)
Checks for presence of CVS/Tag file and returns it's value. |
void |
removeEntry(java.io.File file)
Remove the Entry for the specified file |
void |
setEntry(java.io.File file,
Entry entry)
Set the Entry for the specified file |
void |
updateAdminData(java.lang.String localDirectory,
java.lang.String repositoryPath,
Entry entry,
GlobalOptions globalOptions)
Create or update the administration files for a particular file. |
Method Detail |
---|
void updateAdminData(java.lang.String localDirectory, java.lang.String repositoryPath, Entry entry, GlobalOptions globalOptions) throws java.io.IOException
localDirectory
- the local directory where the file in question
lives (the absolute path). Must not end with a slash.repositoryPath
- the path of the file in the repositoryentry
- the entry object for that fileglobalOptions
- the global command options
java.io.IOException
Entry getEntry(java.io.File file) throws java.io.IOException
file
- the file
java.io.IOException
- if the Entries file cannot be readjava.util.Iterator getEntries(java.io.File directory) throws java.io.IOException
directory
- the directory for which to get the entries
java.io.IOException
void setEntry(java.io.File file, Entry entry) throws java.io.IOException
file
- the fileentry
- the new entry
java.io.IOException
- if an error occurs writing the detailsjava.lang.String getRepositoryForDirectory(java.lang.String directory, java.lang.String repository) throws java.io.IOException
Repositoryin the CVS directory on the client. (This is the case in the standard CVS command-line tool)
directory
- the directorythe
- repository path on the server, e.g. /home/bob/cvs. Must not
end with a slash.
java.io.IOException
void removeEntry(java.io.File file) throws java.io.IOException
file
- the file whose entry is to be removed
java.io.IOException
- if an error occurs writing the Entries filejava.util.Set getAllFiles(java.io.File directory) throws java.io.IOException
directory
- the directory to look in
java.io.IOException
java.lang.String getStickyTagForDirectory(java.io.File directory)
boolean exists(java.io.File file)
file
- file to test for existence
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |