org.netbeans.lib.cvsclient.request

Class Request

java.lang.Object

org.netbeans.lib.cvsclient.request.Request

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

ArgumentRequest, ArgumentxRequest, CaseRequest, CommandRequest, DirectoryRequest, EntryRequest, ExpandModulesRequest, GlobalOptionRequest, GzipFileContentsRequest, GzipStreamRequest, IsModifiedRequest, KoptRequest, ModifiedRequest, NotifyRequest, QuestionableRequest, RootRequest, SetRequest, StickyRequest, UnchangedRequest, UseUnchangedRequest, ValidRequestsRequest, ValidResponsesRequest, WrapperSendRequest

public abstract class Request
extends Object
implements Serializable

The superclass of all requests made to the CVS server

Author:

Robert Greig

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Request()

Method Summary

Methods

Modifier and Type	Method and Description
FileDetails	getFileForTransmission() If a file transmission is required, get the file object representing the file to transmit after the request string.
abstract String	getRequestString() Get the request String that will be passed to the server
abstract boolean	isResponseExpected() Is a response expected from the server?
boolean	modifiesInputStream() Does this request modify the input stream?
void	modifyInputStream(Connection connection) Modify streams on the connection if necessary
void	modifyOutputStream(Connection connection) Modify streams on the connection if necessary

Methods inherited from class java.lang.Object

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

Constructor Detail

Request

public Request()

Method Detail

getRequestString

public abstract String getRequestString()
                                 throws UnconfiguredRequestException

Get the request String that will be passed to the server

Returns:

the request String

Throws:

UnconfiguredRequestException - if the request has not been properly configured

isResponseExpected

public abstract boolean isResponseExpected()

Is a response expected from the server?

Returns:

true if a response is expected, false if no response if expected

getFileForTransmission

public FileDetails getFileForTransmission()

If a file transmission is required, get the file object representing the file to transmit after the request string. The default implementation returns null, indicating no file is to be transmitted

Returns:

the file object, if one should be transmitted, or null if no file object is to be transmitted.

modifyOutputStream

public void modifyOutputStream(Connection connection)
                        throws IOException

Modify streams on the connection if necessary

Throws:

IOException

modifyInputStream

public void modifyInputStream(Connection connection)
                       throws IOException

Modify streams on the connection if necessary

Throws:

IOException

modifiesInputStream

public boolean modifiesInputStream()

Does this request modify the input stream?

Returns:

true if it does, false otherwise