allensoft.javacvs.client
Class CommitRequest

java.lang.Object
  |
  +--allensoft.javacvs.client.CVSCommunicationsObject
        |
        +--allensoft.javacvs.client.CVSRequest
              |
              +--allensoft.javacvs.client.MultiFileCVSRequest
                    |
                    +--allensoft.javacvs.client.CommitRequest

public class CommitRequest

extends MultiFileCVSRequest

Defines a request to the server to commit some files.

Constructor Summary

CommitRequest()

CommitRequest(CommitOptions options)

CommitRequest(java.io.File file)

CommitRequest(java.io.File[] files)

CommitRequest(java.io.File[] files, CommitOptions options)
Creates a commit request to commit the suppled files from the working directory.

CommitRequest(java.io.File file, CommitOptions options)

Method Summary

void	addFile(java.io.File file) Adds the supplied file/directory to the list of files this request operates on.
CommitOptions	getOptions()
protected void	sendRequest() Sends this request to the server.
void	setOptions(CommitOptions options)
protected boolean	validateRequest() Validates this request.

Methods inherited from class allensoft.javacvs.client.MultiFileCVSRequest

getCurrentDirectory, getFile, getFileCount, getRepositoryLocation, getWorkingDirectoryForFile, validateFile

Methods inherited from class allensoft.javacvs.client.CVSRequest

canSendIsModified, createResponse, fireStatusUpdate, getClient, getDescription, getException, getRequest, getResourceString, getResponse, getSendQuestionableCommands, hasCompletedSuccessfully, performRequest, waitForSuccessfulCompletion

Methods inherited from class allensoft.javacvs.client.CVSCommunicationsObject

expandModules, flush, getFileFromRelativePath, getRelativePath, getRelativePath, getRelativePath, getWrapperRCSOptions, performSubRequest, receiveFile, receiveFile, receiveLine, sendArgument, sendArgument, sendArgument, sendArgument, sendCheckinProg, sendCurrentDirectory, sendDateOption, sendDirectory, sendDirectory, sendEntry, sendFileDetails, sendFileDetails, sendFileDetails, sendGlobalOption, sendKopt, sendLine, sendModified, sendOptions, sendStaticDirectory, sendSticky, sendText, sendUnchanged, sendUpdateProg, sendWorkingDirectoryDetails, sendWorkingDirectoryDetails, sendWorkingDirectoryDetails, validRequests

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CommitRequest

public CommitRequest(java.io.File[] files,
                     CommitOptions options)
              throws CVSException,
                     java.io.IOException

Creates a commit request to commit the suppled files from the working directory.

CommitRequest

public CommitRequest(java.io.File[] files)
              throws CVSException,
                     java.io.IOException

CommitRequest

public CommitRequest(java.io.File file,
                     CommitOptions options)
              throws CVSException,
                     java.io.IOException

CommitRequest

public CommitRequest(java.io.File file)
              throws CVSException,
                     java.io.IOException

CommitRequest

public CommitRequest(CommitOptions options)

CommitRequest

public CommitRequest()

Method Detail

getOptions

public CommitOptions getOptions()

setOptions

public void setOptions(CommitOptions options)

addFile

public void addFile(java.io.File file)
             throws CVSException,
                    java.io.IOException

Description copied from class: MultiFileCVSRequest

Adds the supplied file/directory to the list of files this request operates on. The repository location to connect to is taken from the working directory for the file.

Overrides:

addFile in class MultiFileCVSRequest

Following copied from class: allensoft.javacvs.client.MultiFileCVSRequest

Throws:

CannotAddFileException - if the file is incompatiable with the files already added to this request. For example, has a different repository location or does not share a common parent with the existing files.

CVSException - if something goes wrong.

java.io.IOException - if something goes wrong.

validateRequest

protected boolean validateRequest()
                           throws java.io.IOException,
                                  CVSException

Description copied from class: CVSRequest

Validates this request. This is called before sending the request or attempting to make a connection to the server. It can be overridden to validate the settings in this request to ensure it is valid before attempting to connect and send this reqesuest. If this request is invalid then a CVSException is thrown describing why the request is invalid.

Overrides:

validateRequest in class CVSRequest

Following copied from class: allensoft.javacvs.client.CVSRequest

Returns:

true if the request needs to be sent (i.e. there is something to be done or false if the request does not need to be sent.

sendRequest

protected void sendRequest()
                    throws java.io.IOException,
                           CVSException

Description copied from class: CVSRequest

Sends this request to the server.

Overrides:

sendRequest in class CVSRequest