KickJava   Java API By Example, From Geeks To Geeks.

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


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.file.*;
27
28 /**
29  * Sends the server a copy of a locally modified file.
30  * @author Robert Greig
31  */
32 public class ModifiedRequest extends Request {
33     /**
34      * The file details
35      */
36     private FileDetails fileDetails;
37
38     /**
39      * Construct a new modified request.
40      * @param theFile the file that has been modified
41      */
42     public ModifiedRequest(File file, boolean isBinary) {
43         fileDetails = new FileDetails(file, isBinary);
44     }
45
46     /**
47      * Get the request String that will be passed to the server
48      * @return the request String
49      * @throws UnconfiguredRequestException if the request has not been
50      * properly configured
51      */
52     public String JavaDoc getRequestString() throws UnconfiguredRequestException {
53         if (fileDetails == null) {
54             throw new UnconfiguredRequestException("FileDetails is null in " +
55                                                    "ModifiedRequest");
56         }
57         final FileMode mode = new FileMode(fileDetails.getFile());
58         return "Modified " + fileDetails.getFile().getName() + "\n" + //NOI18N
59 mode.toString() + "\n"; //NOI18N
60 }
61
62     /**
63      * Is a response expected from the server?
64      * @return true if a response is expected, false if no response if
65      * expected
66      */
67     public boolean isResponseExpected() {
68         return false;
69     }
70
71     /**
72      * If a file transmission is required, get the file object representing
73      * the file to transmit after the request string. The default
74      * implementation returns null, indicating no file is to be transmitted
75      * @return the file details object, if one should be transmitted, or null
76      * if no file object is to be transmitted.
77      */
78     public FileDetails getFileForTransmission() {
79         return fileDetails;
80     }
81 }
82
Popular Tags