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: * Portions Copyrighted 2007 Sun Microsystems, Inc.
27: */
28: package org.netbeans.modules.javascript.hints.spi;
29:
30: /**
31: * Wrapper around org.netbeans.spi.editor.hints.Fix
32: *
33: * @author Tor Norbye
34: */
35: public interface Fix {
36: /**
37: * Return the text that is shown in the pop up list for a hint describing each
38: * of the available hints.
39: *
40: * @return a short (one line) description of the fix
41: */
42: String getDescription();
43:
44: /**
45: * Perform the actual hint. Invoked when the user chooses to perform the
46: * fix.
47: *
48: * @throws java.lang.Exception
49: */
50: void implement() throws Exception;
51:
52: /**
53: * Return true if this hint is considered safe (will not change program
54: * semantics.)
55: *
56: * @return true iff the hint is safe
57: */
58: boolean isSafe();
59:
60: /**
61: * Return true if and only if this hint requires user interaction when applied.
62: * For example, the hint may enter synchronized-editing mode to rename a symbol.
63: * (A command-line driver for the hints will for example not offer this hint
64: * as one it can possibly apply automatically.)
65: *
66: * @return true iff this hint requires user interaction.
67: */
68: boolean isInteractive();
69: }
|