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: * If you wish your version of this file to be governed by only the CDDL
25: * or only the GPL Version 2, indicate your decision by adding
26: * "[Contributor] elects to include this software in this distribution
27: * under the [CDDL or GPL Version 2] license." If you do not indicate a
28: * single choice of license, a recipient has the option to distribute
29: * your version of this file under either the CDDL, the GPL Version 2 or
30: * to extend the choice of license to its licensees as provided above.
31: * However, if you add GPL Version 2 code and therefore, elected the GPL
32: * Version 2 license, then the option applies only if the new code is
33: * made subject to such option by the copyright holder.
34: *
35: * Contributor(s):
36: *
37: * Portions Copyrighted 2007 Sun Microsystems, Inc.
38: */
39:
40: package org.netbeans.modules.javascript.hints.spi;
41:
42: /**
43: * This interface is implemented by Fix implementations that are also "previewable";
44: * these fixes can provide their implementation as a list of edit operations that
45: * can be used to compute diff views etc.
46: *
47: * @todo Don't make this extend fix; perhaps I can use previewable elsewhere as well?
48: *
49: * @author Tor Norbye
50: */
51: public interface PreviewableFix extends Fix {
52: /**
53: * Return true if this fix can provide a fix.
54: * (This isn't determined only by implementing fix, since some fix implementations
55: * may be previewable in some cases and not in others. For example, the CamelCaseNames
56: * fix can preview name fixes for local variables, but not for global renames.)
57: *
58: * @return true iff this fix can generate a preview.
59: */
60: boolean canPreview();
61:
62: /**
63: * Return a list of edits which the {@link #implement} method will
64: * perform. You can return null (or an empty list) here, but if you
65: * provide a list of edits, the IDE will use the edit list to offer
66: * a preview of the hint.
67: * <p>
68: * This method will not be called for interactive hints (hints which
69: * return true from {@link #isInteractive}.)
70: *
71: * @return an EditList containing edits that can preview
72: */
73: EditList getEditList() throws Exception;
74: }
|