allensoft.javacvs.client
Class UpdateRequest

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

public class UpdateRequest

extends MultiFileCVSRequest

Defines a request to update some client side files/directories from a CVS repository. This is equivalent to the cvs update command line request.

Constructor Summary

UpdateRequest()
Creates a new UpdateRequest using default options.

UpdateRequest(CheckoutOptions options)

UpdateRequest(java.io.File file)

UpdateRequest(java.io.File[] files)

UpdateRequest(java.io.File[] files, CheckoutOptions options)

UpdateRequest(java.io.File file, CheckoutOptions options)

Method Summary

CheckoutOptions	getOptions()
protected void	sendRequest() Sends this request to the server.
void	setOptions(CheckoutOptions options)
protected boolean	validateRequest() Validates this request.

Methods inherited from class allensoft.javacvs.client.MultiFileCVSRequest

addFile, 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

UpdateRequest

public UpdateRequest()

Creates a new UpdateRequest using default options. Files should be specified with the addFile method.

UpdateRequest

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

UpdateRequest

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

UpdateRequest

public UpdateRequest(CheckoutOptions options)

UpdateRequest

public UpdateRequest(java.io.File[] files,
                     CheckoutOptions options)
              throws CVSException,
                     java.io.IOException

UpdateRequest

public UpdateRequest(java.io.File file,
                     CheckoutOptions options)
              throws CVSException,
                     java.io.IOException

Method Detail

getOptions

public CheckoutOptions getOptions()

setOptions

public void setOptions(CheckoutOptions options)

validateRequest

protected boolean validateRequest()
                           throws 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