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-2006 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.refactoring.spi;
42:
43: import java.util.Collection;
44: import org.netbeans.modules.refactoring.api.Problem;
45: import org.netbeans.modules.refactoring.spi.RefactoringElementsBag;
46:
47: /** Interface implemented by refactoring plugins. Contains callback methods which a particular refactoring
48: * calls to check pre-conditions, validity of parameters and collect refactoring elements.
49: * It is expected that the refactoring that this plugin operates on is passed to the plugin
50: * in its constructor by a corresponding implementation of {@link RefactoringPluginFactory}.
51: *
52: * @author Martin Matula
53: */
54: public interface RefactoringPlugin {
55: /** Checks pre-conditions of the refactoring and returns problems.
56: * @return Problems found or null (if no problems were identified)
57: */
58: Problem preCheck();
59:
60: /** Checks parameters of the refactoring.
61: * @return Problems found or null (if no problems were identified)
62: */
63: Problem checkParameters();
64:
65: /** Fast checks parameters of the refactoring. This method will be used for
66: * online error checking.
67: * @return Problems found or null (if no problems were identified)
68: */
69: Problem fastCheckParameters();
70:
71: /**
72: * Asynchronous request to cancel ongoing long-term request (such as preCheck(), checkParameters() or prepare())
73: */
74: void cancelRequest();
75:
76: /** Collects refactoring elements for a given refactoring.
77: * @param refactoringElements RefactoringElementsBag of refactoring elements - the implementation of this method
78: * should add refactoring elements to this collections. It should make no assumptions about the collection
79: * content.
80: * @return Problems found or null (if no problems were identified)
81: */
82: Problem prepare(RefactoringElementsBag refactoringElements);
83: }
|