001: /*
002: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
003: *
004: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
005: *
006: * The contents of this file are subject to the terms of either the GNU
007: * General Public License Version 2 only ("GPL") or the Common
008: * Development and Distribution License("CDDL") (collectively, the
009: * "License"). You may not use this file except in compliance with the
010: * License. You can obtain a copy of the License at
011: * http://www.netbeans.org/cddl-gplv2.html
012: * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
013: * specific language governing permissions and limitations under the
014: * License. When distributing the software, include this License Header
015: * Notice in each file and include the License file at
016: * nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
017: * particular file as subject to the "Classpath" exception as provided
018: * by Sun in the GPL Version 2 section of the License file that
019: * accompanied this code. If applicable, add the following below the
020: * License Header, with the fields enclosed by brackets [] replaced by
021: * your own identifying information:
022: * "Portions Copyrighted [year] [name of copyright owner]"
023: *
024: * Contributor(s):
025: *
026: * The Original Software is NetBeans. The Initial Developer of the Original
027: * Software is Sun Microsystems, Inc. Portions Copyright 1997-2007 Sun
028: * Microsystems, Inc. All Rights Reserved.
029: *
030: * If you wish your version of this file to be governed by only the CDDL
031: * or only the GPL Version 2, indicate your decision by adding
032: * "[Contributor] elects to include this software in this distribution
033: * under the [CDDL or GPL Version 2] license." If you do not indicate a
034: * single choice of license, a recipient has the option to distribute
035: * your version of this file under either the CDDL, the GPL Version 2 or
036: * to extend the choice of license to its licensees as provided above.
037: * However, if you add GPL Version 2 code and therefore, elected the GPL
038: * Version 2 license, then the option applies only if the new code is
039: * made subject to such option by the copyright holder.
040: */
041: package org.netbeans.modules.versioning.spi;
042:
043: import java.io.File;
044: import java.io.IOException;
045:
046: /**
047: * Versioning systems that need to intercept or listen to file system operations implement this class.
048: *
049: * @author Maros Sandor
050: */
051: public abstract class VCSInterceptor {
052:
053: /**
054: * Protected constructor, does nothing.
055: */
056: protected VCSInterceptor() {
057: }
058:
059: // ==================================================================================================
060: // DELETE
061: // ==================================================================================================
062:
063: /**
064: * Notifies the interceptor that the file or folder is about to be deleted. The interceptor MUST NOT delete
065: * the file here.
066: *
067: * @param file a file or an empty folder to be deleted
068: * @return true if this interceptor wants to handle this operation (doDelete will be called), false otherwise
069: */
070: public boolean beforeDelete(File file) {
071: return false;
072: }
073:
074: /**
075: * Called if beforeDelete() returns true and delegates the delete operation to this interceptor. The interceptor
076: * may decide to either delete the file or leave it intact. In case it does not want to delete the file, it should
077: * just return without doing anything.
078: *
079: * @param file a file or an empty folder to delete; the interceptor will never be asked to delete a non-empty folder
080: * @throws IOException if the delete operation failed
081: */
082: public void doDelete(File file) throws IOException {
083: }
084:
085: /**
086: * Called after a file or folder is deleted. In case the file was deleted outside IDE, this is the only method called.
087: *
088: * @param file deleted file
089: */
090: public void afterDelete(File file) {
091: }
092:
093: // ==================================================================================================
094: // MOVE
095: // ==================================================================================================
096:
097: /**
098: * Notifies the interceptor that the file or folder is about to be moved. The interceptor MUST NOT move
099: * the file here.
100: *
101: * @param from the file or folder to be moved
102: * @param to destination of the file being moved
103: * @return true if this interceptor wants to handle this operation (doMove will be called), false otherwise
104: */
105: public boolean beforeMove(File from, File to) {
106: return false;
107: }
108:
109: /**
110: * Called if beforeMove() returns true and delegates the move operation to this interceptor.
111: *
112: * @param from the file or folder to be moved
113: * @param to destination of the file being moved
114: * @throws IOException if the move operation failed
115: */
116: public void doMove(File from, File to) throws IOException {
117: }
118:
119: /**
120: * Called after a file or folder has beed moved. In case the file was moved outside IDE, this method is not called but
121: * a pair or afterDelete() / afterCreate() is called instead.
122: *
123: * @param from original location of the file
124: * @param to current location of the file
125: */
126: public void afterMove(File from, File to) {
127: }
128:
129: // ==================================================================================================
130: // CREATE
131: // ==================================================================================================
132:
133: /**
134: * Notifies the interceptor that the file or folder is about to be created. The interceptor MUST NOT create
135: * the file here.
136: *
137: * Beware: It may happen on some filesystems that the file will be ALREADY created.
138: *
139: * @param file file or folder to be created
140: * @return true if this interceptor wants to handle this operation (doCreate will be called), false otherwise
141: */
142: public boolean beforeCreate(File file, boolean isDirectory) {
143: return false;
144: }
145:
146: /**
147: * Called if beforeCreate() returns true and delegates the create operation to this interceptor.
148: *
149: * Beware: It may happen on some filesystems that the file will be ALREADY created.
150: *
151: * @param file the file to create
152: * @param isDirectory true if the new file should be a directory, false otherwise
153: * @throws IOException if the create operation failed
154: */
155: public void doCreate(File file, boolean isDirectory)
156: throws IOException {
157: }
158:
159: /**
160: * Called after a new file or folder has beed created. In case the file was created outside IDE, this is the only
161: * method called.
162: *
163: * @param file the new file
164: */
165: public void afterCreate(File file) {
166: }
167:
168: // ==================================================================================================
169: // CHANGE
170: // ==================================================================================================
171:
172: /**
173: * Called after a file changed.
174: *
175: * @param file changed file
176: */
177: public void afterChange(File file) {
178: }
179:
180: /**
181: * Called before a file is changed.
182: * Each series of beforeChange/afterChange events is preceded by at least one beforeEdit event.
183: *
184: * @param file to be changed file
185: */
186: public void beforeChange(File file) {
187: }
188:
189: /**
190: * Called before a file is about to enter Edit mode. In case the versioning system uses file locking
191: * this is the time when to check-out (edit) the file and make it read/write. CVS would execute 'cvs edit' here. If
192: * you do not (wish to) support automatic file check-out, do nothing here.
193: * Each series of beforeChange/afterChange events is preceded by at least one beforeEdit event.
194: *
195: * @param file file that was just locked and is expected to change
196: */
197: public void beforeEdit(File file) {
198: }
199: }
|