| Home >> All >> allensoft >> javacvs >> [ client Javadoc ] |
• allensoft.javacvs.client: Javadoc index of package allensoft.javacvs.client.
Package Samples:
• allensoft.javacvs.client.event
• allensoft.javacvs.client.ui.command.event
• allensoft.javacvs.client.ui.command
• allensoft.javacvs.client.ui.swing
Classes:
• CVSClient: This is the main class that implements the CVS client/server protocol. It is used to send requests to the server and process the server's responses. Typical usage is to create a batch of requests to perform and then perform them using the perfromRequestBatch method. For example, to perform a request that commits changes to a file with the log message "Added some new features" you could do this: // Create a request batch to add requests to CVSRequestBatch batch = new CVSRequestBatch(); // Add a request to the batch batch.addRequest (new CommitRequest (file, new CommitOptions ("Added some new features"))); ...
• TextFileFormatter: Defines a text file formatter. This converts from one text format to another. This could be used to change the indentation of a source file, for example. The user can configure any number of these. The RepositoryDetails class can then be used to associate various formatters for a repository location. This is quite powerful and allows one to, for example, always ensure that C files in one repository location are indented so as to conform to coding standards. It also allows the user to check the file out in their preffered style. This allows individual developers to have different indentation styles ...
• RepositoryDetails: Defines details about how to connect to a repository given its location. A CVS repository location does not fully define how to connect to a repository for the ext or server connection methods. For example, what is the external command that should be executed? Should RSH or SSH be used? Because of this, this class defines these extra details when the ext or server is used. It also allows a name to be associated with the connection details thus allowing the user to refer to the settings by a simpler, or more obvious, name. This is much more flexible than the standard CVS way of doing it where the ...
• WorkingDirectory: Represents a working directory for a CVS client. A working directory contains a "CVS" sub directory that contains files such as "Entries", "Root" and "Repository". This class provides a high level view of these files and the entries that the working directory conatins. For efficiency purposes one cannot construct objects of this class directly but instead one uses the getWorkingDirectory static method to construct them. This allows a cache to be maintained so that the files are not constantly reopened and parsed every time they are needed.
• CVSIgnoreFileFilter: A file filter that decides if a file should be accepted based on rules for CVS ignoring files. The patterns in this filter are the default patterns to ignore. When determining if it should accept a file it will check these patterns as well as looking for .cvsignore files in the user's home directory or the parent directory of the file in question. The default patterns to ignore are retrieved from a setting called "defaultIgnoreFiles". If this has not been set then a hard coded set of patterns will be used instead which are common files for CVS to ignore.
• CVSIgnoreFile: Defines a pattern based file filter whose patterns are taken from a file. The patterns are separated by white space. Typically, these will be .cvsignore files in the user's home directory or directories being recursed by an import or add command. The file is automatically reparsed when it is modified externally. The patterns in this filter reqpresent the patterns in the file. Note that this filter accepts files only if a pattern does not match the file. This is because the patterns specify files to be ignored.
• DefaultKeywordSubstitutionModeClassifier: Classifies the keyword substitution modes for files. It is possible to explicitly set the keyword mode for a particular file. If this has not been done then it will determine if the file is binary by comparing it's name against a set of patterns for binary files. These patterns are stored in the "binaryFiles" setting. If this has not been set then default patterns will be used for binary files.
• CVSRequestBatch: Defines a sequential list of requests that should be performed. This allows a client to open only one connection to the server and perform all the requests for that server in a batch. This reduces the number of times that the user has to authenticate theirself to the server. For example, you could add requests to add new files, remove files and commit the changes all in one connection.
• LoginManager: Responsible for obtaining login details from the user. Implementators of this interface can request login details in whatever manner they wish. For example, one implementation may be to get the login details by using a swing based dialog and another may ask the user to type it in on System.in. This allows the client package to be abstracted from the user interface.
• CVSRequest: The base class for all requests to a CVS server. A request is perofrmed by a CVSClient object using the CVSClient.performRequest method. Sub classes of this class can use the helper methods sendXXX to send specific commands and data to the server. These methods forward the request to the client to actually send it over the current server connection.
• TextFileContainsBinaryException: Exception thrown when a file is not marked as binary but contains binary. JavaCVS is tricter than cvs and won't allow a file that contains binary characters to be sent to the server if it is not pure text. This is beacuse the \r\n sequence gets changed to \n and this could corrupt a file if it is really a binary file.
• RepositoryDetailsDialog: Dialog used to edit repository details. If no repository details are supplied then this dialog will assume it is editing a new one to be added which will be added to the details when the user clicks Ok. Otherwise it will allow the user to edit the details of the supplied repository.
• SelectFilesToAddDialog: A dislog which displays a selection of files that the user can select to add and detrmine whether the file is binary or not. The supplied classifier is setup with the choices the user made if the dialog is not cancelled. It can then be used as the classifier for any add requests.
• AnnotatedEditorPane: A sub class of JEditorPane that displays annotated text from a cvs server response. Both an AnnotateResponse and a LogResponse are used so that the user is given a tooltip for each annotation showing the date, time and commit message as well as the revision.
• CVSCommunicationsObject: The base class for any object that wants to do communications with a CVS server. This provides many protected methods for sending common requests and receiving input from the server. They are forawrded on to the client to actually send to the server.
• ClientFunctionality: This interface is used to provide the features and functionality of a graphical client (ie what requests are available and how these requests are performed). Features are defined using actions. Actions are added to a pool of actions.
• WorkingDirectoryView: A component that displays a working directory in a table with a toolbar that has the ability to change what is displayed in the working directory table (for example, showing only files with conflicts).
• DefaultClientFunctionality: Provides the features and implementation for the default behaviour of operations. This class could be extended to provide new features for the browser or change the implementation of a particular feature.
• RevisionOrTagSelector: Lets the user select a revision or tag. The user can type this into a text field. This component can also fetch a list of possible tags if supplied with the file to list tags for.
• CVSResponse: The base class for all responses from the server. Sub-classes usually override the processXXXXResponse methods to extract data from a response they are interested in.
• AnnotatedEditorKit: EditorKit to be used with a JEditorPane for viewing annotated text files. This lets us use the copy and paste facilities provided by the standard swing editor.
• ExternalProcessServerConnection: Defines a server connection to the local machine. This is done by executiong the server on the local machine and redirecting the input and output of the server.
| Home | Contact Us | Privacy Policy | Terms of Service |