org.netbeans.lib.cvsclient.request
Class Request

java.lang.Object
  extended by org.netbeans.lib.cvsclient.request.Request
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 java.lang.Object

The superclass of all requests made to the CVS server


Constructor Summary
Request()
           
 
Method Summary
 FileDetails getFileForTransmission()
          If a file transmission is required, get the file object representing the file to transmit after the request string.
abstract  java.lang.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 java.lang.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 java.io.IOException
Modify streams on the connection if necessary

Throws:
java.io.IOException

modifyInputStream

public void modifyInputStream(Connection connection)
                       throws java.io.IOException
Modify streams on the connection if necessary

Throws:
java.io.IOException

modifiesInputStream

public boolean modifiesInputStream()
Does this request modify the input stream?

Returns:
true if it does, false otherwise

 

Built on October 26 2010.  |  Portions Copyright 1997-2005 Sun Microsystems, Inc. All rights reserved.