KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > netbeans > modules > refactoring > spi > ui > RefactoringUIBypass


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 NetBeans. The Initial Developer of the Original
16  * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
17  * Microsystems, Inc. All Rights Reserved.
18  */

19
20 package org.netbeans.modules.refactoring.spi.ui;
21
22 import java.io.IOException JavaDoc;
23
24 /**
25  * This was historicaly intended to enhance RefactoringUI.
26  * RefactoringUI must support "bypass" of refactoring for common
27  * operations Copy/Move/Rename for users to be able to do
28  * regular operation (Copy/Move/Rename) instead of refactoring operation
29  * (Refactor | Copy, Refactor | Move, Refactor | Rename)
30  *
31  * For instance UI for Java Rename Refactoring has checkbox
32  * [ ] Rename Without Refactoring
33  *
34  * isRefactoringBypassRequired() should return true if and only if
35  * this checkbox is checked.
36  * doRefactoringBypass() implementation does only regular file rename
37  *
38  * @author Jan Becicka
39  *
40  */

41 public interface RefactoringUIBypass {
42     
43     /**
44      * @return true if user want to bypass refactoring
45      */

46     boolean isRefactoringBypassRequired();
47     
48     /**
49      * do regular operation, bypass refactoring
50      */

51     void doRefactoringBypass() throws IOException JavaDoc;
52 }
53
Popular Tags