01: /*
02: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
03: *
04: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
05: *
06: * The contents of this file are subject to the terms of either the GNU
07: * General Public License Version 2 only ("GPL") or the Common
08: * Development and Distribution License("CDDL") (collectively, the
09: * "License"). You may not use this file except in compliance with the
10: * License. You can obtain a copy of the License at
11: * http://www.netbeans.org/cddl-gplv2.html
12: * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
13: * specific language governing permissions and limitations under the
14: * License. When distributing the software, include this License Header
15: * Notice in each file and include the License file at
16: * nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
17: * particular file as subject to the "Classpath" exception as provided
18: * by Sun in the GPL Version 2 section of the License file that
19: * accompanied this code. If applicable, add the following below the
20: * License Header, with the fields enclosed by brackets [] replaced by
21: * your own identifying information:
22: * "Portions Copyrighted [year] [name of copyright owner]"
23: *
24: * Contributor(s):
25: *
26: * The Original Software is NetBeans. The Initial Developer of the Original
27: * Software is Sun Microsystems, Inc. Portions Copyright 1997-2007 Sun
28: * Microsystems, Inc. All Rights Reserved.
29: *
30: * If you wish your version of this file to be governed by only the CDDL
31: * or only the GPL Version 2, indicate your decision by adding
32: * "[Contributor] elects to include this software in this distribution
33: * under the [CDDL or GPL Version 2] license." If you do not indicate a
34: * single choice of license, a recipient has the option to distribute
35: * your version of this file under either the CDDL, the GPL Version 2 or
36: * to extend the choice of license to its licensees as provided above.
37: * However, if you add GPL Version 2 code and therefore, elected the GPL
38: * Version 2 license, then the option applies only if the new code is
39: * made subject to such option by the copyright holder.
40: */
41: package org.netbeans.modules.xml.refactoring.spi;
42:
43: import java.io.IOException;
44: import org.netbeans.modules.refactoring.api.AbstractRefactoring;
45: import org.netbeans.modules.xml.refactoring.spi.RefactoringUtil;
46: import org.netbeans.modules.xml.xam.Referenceable;
47:
48: /**
49: * Executor of a refactor target change.
50: * A refactoring request processing consist of 2 steps:
51: * (1) making the change on the target component,
52: * (2) refactoring selected the usage components.
53: * The implementation of this class is reponsible for the first step.
54: *
55: * @author Nam Nguyen
56: */
57: public abstract class ChangeExecutor {
58:
59: public abstract <T extends AbstractRefactoring> boolean canChange(
60: Class<T> changeType, Referenceable target);
61:
62: /**
63: * Perform a pre-change checking on the refactor request.
64: * Implementation should quietly ignore unsupported refactoring type.
65: */
66: public void precheck(AbstractRefactoring request) {
67: }
68:
69: /**
70: * Perform the change specified by the refactor request. Any errors that would
71: * fail the overall refactoring should be reported throught #RefactoringRequest.addError
72: * Implementation should quietly ignore unsupported refactoring type.
73: */
74: public void doChange(AbstractRefactoring request)
75: throws IOException {
76: }
77:
78: /**
79: * Returns UI helper in displaying the usages. Implementation could override
80: * the default UI to help display usages in a more intuitive way than the
81: * generic helper.
82: */
83: public UIHelper getUIHelper() {
84: return new UIHelper();
85: }
86:
87: }
|