| org.netbeans.lib.cvsclient.ClientServices
All known Subclasses: org.netbeans.lib.cvsclient.Client,
| ClientServices | | public interface ClientServices (Code) | | Clients that provide the ability to execute commands must implement this
interface. All commands use this interface to get details about the
environment in which it is being run, and to perform administrative
functions such as obtaining Entry lines for specified files.
author:
Robert Greig |
| exists | | boolean exists(File file)(Code) | | 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 true if the file exists, false otherwise |
| getAllFiles | | Set getAllFiles(File directory) throws IOException(Code) | | Get all the files contained within a given
directory that are known to CVS.
Parameters:
directory - the directory to look in a set of all files. |
| getEntries | | Iterator getEntries(File directory) throws IOException(Code) | | Get the entries for a specified directory.
Parameters:
directory - the directory for which to get the entries an iterator of Entry objects |
| getEntry | | Entry getEntry(File file) throws IOException(Code) | | Get the Entry for the specified file, if one exists.
Parameters:
file - the file
throws:
IOException - if the Entries file cannot be read |
| getGlobalOptions | | GlobalOptions getGlobalOptions()(Code) | | Get the global options that are set to this client.
Individual commands can get the global options via this method.
|
| getIgnoreFileFilter | | IgnoreFileFilter getIgnoreFileFilter()(Code) | | Returns the IgnoreFileFilter used to ignore non-cvs files.
TS, 2001-11-23: really needed in the interface (it's never used)?
|
| getLocalPath | | String getLocalPath()(Code) | | Get the local path that the command is executing in.
the local path |
| getRepository | | String getRepository()(Code) | | Get the repository used for this connection.
the repository, for example /home/bob/cvs |
| getRepositoryForDirectory | | String getRepositoryForDirectory(String directory) throws IOException(Code) | | 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 |
| getRepositoryForDirectory | | String getRepositoryForDirectory(File directory) throws IOException(Code) | | Semantically equivalent to
ClientServices.getRepositoryForDirectory(String) but does not try to recover from
missing CVS/Repository file.
Parameters:
directory - the directory to get repository for repository path that corresponds to the given local working directory or null if local directoryis not versioned or does not exist
throws:
IOException - if the repository cannot be determined by reading CVS/Repository file |
| getStickyTagForDirectory | | String getStickyTagForDirectory(File directory)(Code) | | Checks for presence of CVS/Tag file and returns it's value.
the value of CVS/Tag file for the specified directorynull if file doesn't exist |
| getWrappersMap | | Map getWrappersMap() throws CommandException(Code) | | Returns the wrappers map associated with the CVS server
The map is valid only after the connection is established
|
| isAborted | | boolean isAborted()(Code) | | Tests whether command execution should be aborted. Commands are encouraged to regulary
poll this value if they expect to block for a long time in their code.
true if currently running command should abort, false otherwise |
| isFirstCommand | | boolean isFirstCommand()(Code) | | Returns true if no command was sent before.
This is used, because the server rejects some doubled commands.
|
| removeEntry | | void removeEntry(File file) throws IOException(Code) | | Removes the Entry for the specified file.
|
| setGzipFileHandler | | void setGzipFileHandler(FileHandler handler)(Code) | | Set the handler for Gzip data.
|
| setIgnoreFileFilter | | void setIgnoreFileFilter(IgnoreFileFilter filter)(Code) | | Sets the specified IgnoreFileFilter to use to ignore non-cvs files.
TS, 2001-11-23: really needed in the interface (it's never used)?
|
| setIsFirstCommand | | void setIsFirstCommand(boolean first)(Code) | | Set whether this is the first command. Normally you do not need to set
this yourself - after execution the first command will have set this to
false.
|
| setUncompressedFileHandler | | void setUncompressedFileHandler(FileHandler handler)(Code) | | Set the uncompressed file handler.
|
| shouldBeIgnored | | boolean shouldBeIgnored(File directory, String nonCvsFile)(Code) | | Returnes true to indicate, that the file specified by directory and nonCvsFile
should be ignored.
|
| updateAdminData | | void updateAdminData(String localDirectory, String repositoryPath, Entry entry) throws IOException(Code) | | 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, relative to the directoryin which the command was given, where the file inquestion lives
Parameters:
entry - the entry object for that file
throws:
IOException - if there is an error writing the files |
|
|