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.gsf.api;
29:
30: import java.util.List;
31: import org.netbeans.spi.editor.hints.ErrorDescription;
32:
33: /**
34: * Interface implemented by plugins that wish to provide quickfixes and hints.
35: *
36: * @author Tor Norbye
37: */
38: public interface HintsProvider {
39:
40: /**
41: * Compute hints applicable to the given compilation info and add to the given result list.
42: */
43: void computeHints(CompilationInfo info, List<ErrorDescription> hints);
44:
45: /**
46: * Compute any suggestions applicable to the given caret offset, and add to
47: * the given suggestion list.
48: */
49: void computeSuggestions(CompilationInfo info,
50: List<ErrorDescription> suggestions, int caretOffset);
51:
52: /**
53: * Compute any suggestions applicable to the given caret offset, and add to
54: * the given suggestion list.
55: */
56: void computeSelectionHints(CompilationInfo info,
57: List<ErrorDescription> suggestions, int start, int end);
58:
59: /**
60: * Process the errors for the given compilation info, and add errors and
61: * warning descriptions into the provided hint list. Return any errors
62: * that were not added as error descriptions (e.g. had no applicable error rule)
63: */
64: List<Error> computeErrors(CompilationInfo info,
65: List<ErrorDescription> hints);
66:
67: /**
68: * Cancel in-progress processing of hints.
69: */
70: void cancel();
71: }
|