KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > netbeans > lib > cvsclient > request > Request


1 /*****************************************************************************
2  * The contents of this file are subject to the terms of the Common Development
3  * and Distribution License (the License). You may not use this file except in
4  * compliance with the License.
5  *
6  * You can obtain a copy of the License at http://www.netbeans.org/cddl.html
7  * or http://www.netbeans.org/cddl.txt.
8  *
9  * When distributing Covered Code, include this CDDL Header Notice in each file
10  * and include the License file at http://www.netbeans.org/cddl.txt.
11  * If applicable, add the following below the CDDL Header, with the fields
12  * enclosed by brackets [] replaced by your own identifying information:
13  * "Portions Copyrighted [year] [name of copyright owner]"
14
15  * The Original Software is the CVS Client Library.
16  * The Initial Developer of the Original Software is Robert Greig.
17  * Portions created by Robert Greig are Copyright (C) 2000.
18  * All Rights Reserved.
19
20  * Contributor(s): Robert Greig.
21  *****************************************************************************/
22 package org.netbeans.lib.cvsclient.request;
23
24 import java.io.*;
25
26 import org.netbeans.lib.cvsclient.connection.*;
27 import org.netbeans.lib.cvsclient.file.*;
28
29 /**
30  * The superclass of all requests made to the CVS server
31  * @author Robert Greig
32  */
33 public abstract class Request {
34     /**
35      * Get the request String that will be passed to the server
36      * @return the request String
37      * @throws UnconfiguredRequestException if the request has not been
38      * properly configured
39      */
40     public abstract String JavaDoc getRequestString()
41             throws UnconfiguredRequestException;
42
43     /**
44      * Is a response expected from the server?
45      * @return true if a response is expected, false if no response if
46      * expected
47      */
48     public abstract boolean isResponseExpected();
49
50     /**
51      * If a file transmission is required, get the file object representing
52      * the file to transmit after the request string. The default
53      * implementation returns null, indicating no file is to be transmitted
54      * @return the file object, if one should be transmitted, or null if
55      * no file object is to be transmitted.
56      */
57     public FileDetails getFileForTransmission() {
58         return null;
59     }
60
61     /**
62      * Modify streams on the connection if necessary
63      */
64     public void modifyOutputStream(Connection connection) throws IOException {
65         // DO NOTHING
66 }
67
68     /**
69      * Modify streams on the connection if necessary
70      */
71     public void modifyInputStream(Connection connection) throws IOException {
72         // DO NOTHING
73 }
74
75     /**
76      * Does this request modify the input stream?
77      * @return true if it does, false otherwise
78      */
79     public boolean modifiesInputStream() {
80         return false;
81     }
82 }
Popular Tags