org.netbeans.lib.cvsclient.admin

Interface AdminHandler

All Superinterfaces:

Serializable

All Known Implementing Classes:

StandardAdminHandler

public interface AdminHandler
extends Serializable

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.

Author:

Robert Greig

Method Summary

Methods

Modifier and Type	Method and Description
boolean	exists(File file) Tests for existence of the given file.
Set<File>	getAllFiles(File directory) Get all the files contained within a given directory that are known to CVS.
Iterator<Entry>	getEntries(File directory) Get the entries for a specified directory.
Entry	getEntry(File file) Get the Entry for the specified file, if one exists
String	getRepositoryForDirectory(String directory, 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.
String	getStickyTagForDirectory(File directory) Checks for presence of CVS/Tag file and returns it's value.
void	removeEntry(File file) Remove the Entry for the specified file
void	setEntry(File file, Entry entry) Set the Entry for the specified file
void	updateAdminData(String localDirectory, String repositoryPath, Entry entry, GlobalOptions globalOptions) Create or update the administration files for a particular file.

Method Detail

updateAdminData

void updateAdminData(String localDirectory,
                   String repositoryPath,
                   Entry entry,
                   GlobalOptions globalOptions)
                     throws IOException

Create or update the administration files for a particular file. This will create the CVS directory if necessary, and the Root and Repository files if necessary. It will also update the Entries file with the new entry

Parameters:

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 repository

entry - the entry object for that file

globalOptions - the global command options

Throws:

IOException

getEntry

Entry getEntry(File file)
               throws IOException

Get the Entry for the specified file, if one exists

Parameters:

file - the file

Throws:

IOException - if the Entries file cannot be read

getEntries

Iterator<Entry> getEntries(File directory)
                           throws IOException

Get the entries for a specified directory.

Parameters:

directory - the directory for which to get the entries

Returns:

an iterator of Entry objects

Throws:

IOException

setEntry

void setEntry(File file,
            Entry entry)
              throws IOException

Set the Entry for the specified file

Parameters:

file - the file

entry - the new entry

Throws:

IOException - if an error occurs writing the details

getRepositoryForDirectory

String getRepositoryForDirectory(String directory,
                               String repository)
                                 throws IOException

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. The repository directory is commonly stored in the file

 Repository
 

in the CVS directory on the client. (This is the case in the standard CVS command-line tool)

Parameters:

directory - the directory

the - repository path on the server, e.g. /home/bob/cvs. Must not end with a slash.

Throws:

IOException

removeEntry

void removeEntry(File file)
                 throws IOException

Remove the Entry for the specified file

Parameters:

file - the file whose entry is to be removed

Throws:

IOException - if an error occurs writing the Entries file

getAllFiles

Set<File> getAllFiles(File directory)
                      throws IOException

Get all the files contained within a given directory that are known to CVS.

Parameters:

directory - the directory to look in

Returns:

a set of all files.

Throws:

IOException

getStickyTagForDirectory

String getStickyTagForDirectory(File directory)

Checks for presence of CVS/Tag file and returns it's value.

Returns:

the value of CVS/Tag file for the specified directory (including leading "T") null if file doesn't exist

exists

boolean exists(File file)

Tests for existence of the given file. Normally this method delegates to File.exists() but it may also return true for files that exists only virtually (in memory). Is such case the file/directory will not exist on disk but its metadata will be available via getEntries() methods.

Parameters:

file - file to test for existence

Returns:

true if the file exists, false otherwise