001: /*
002: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
003: *
004: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
005: *
006: * The contents of this file are subject to the terms of either the GNU
007: * General Public License Version 2 only ("GPL") or the Common
008: * Development and Distribution License("CDDL") (collectively, the
009: * "License"). You may not use this file except in compliance with the
010: * License. You can obtain a copy of the License at
011: * http://www.netbeans.org/cddl-gplv2.html
012: * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
013: * specific language governing permissions and limitations under the
014: * License. When distributing the software, include this License Header
015: * Notice in each file and include the License file at
016: * nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
017: * particular file as subject to the "Classpath" exception as provided
018: * by Sun in the GPL Version 2 section of the License file that
019: * accompanied this code. If applicable, add the following below the
020: * License Header, with the fields enclosed by brackets [] replaced by
021: * your own identifying information:
022: * "Portions Copyrighted [year] [name of copyright owner]"
023: *
024: * Contributor(s):
025: *
026: * The Original Software is NetBeans. The Initial Developer of the Original
027: * Software is Sun Microsystems, Inc. Portions Copyright 1997-2007 Sun
028: * Microsystems, Inc. All Rights Reserved.
029: *
030: * If you wish your version of this file to be governed by only the CDDL
031: * or only the GPL Version 2, indicate your decision by adding
032: * "[Contributor] elects to include this software in this distribution
033: * under the [CDDL or GPL Version 2] license." If you do not indicate a
034: * single choice of license, a recipient has the option to distribute
035: * your version of this file under either the CDDL, the GPL Version 2 or
036: * to extend the choice of license to its licensees as provided above.
037: * However, if you add GPL Version 2 code and therefore, elected the GPL
038: * Version 2 license, then the option applies only if the new code is
039: * made subject to such option by the copyright holder.
040: */
041: package org.netbeans.modules.java.hints.spi;
042:
043: import java.util.prefs.Preferences;
044: import javax.swing.JComponent;
045: import org.netbeans.modules.java.hints.options.HintsSettings;
046: import org.netbeans.modules.java.hints.spi.AbstractHint.HintSeverity;
047: import org.netbeans.spi.editor.hints.Severity;
048: import org.openide.util.NbPreferences;
049:
050: /** Class to be extended by all the Java hints.
051: *
052: * @author Petr Hrebejk
053: */
054: public abstract class AbstractHint implements TreeRule {
055:
056: private boolean enableDefault;
057: private boolean showInTaskListDefault;
058: private HintSeverity severityDefault;
059: private String suppressBy[];
060:
061: static {
062: HintsSettings.HINTS_ACCESSOR = new HintAccessorImpl();
063: }
064:
065: public AbstractHint(boolean enableDefault,
066: boolean showInTaskListDefault,
067: HintSeverity severityDefault, String... suppressBy) {
068: this .enableDefault = enableDefault;
069: this .showInTaskListDefault = showInTaskListDefault;
070: this .severityDefault = severityDefault;
071: this .suppressBy = suppressBy;
072: }
073:
074: /** Gets preferences node, which stores the options for given hint. It is not
075: * necessary to override this method unless you want to create some special
076: * behavior. The default implementation will create the the preferences node
077: * by calling <code>NbPreferences.forModule(this.getClass()).node(profile).node(getId());</code>
078: * @profile Profile to get the node for. May be null for current profile
079: * @return Preferences node for given hint.
080: */
081: public Preferences getPreferences(String profile) {
082: profile = profile == null ? HintsSettings.getCurrentProfileId()
083: : profile;
084: return NbPreferences.forModule(this .getClass()).node(profile)
085: .node(getId());
086: }
087:
088: /** Gets the UI description for this rule. It is fine to return null
089: * to get the default behavior. Notice that the Preferences node is a copy
090: * of the node returned frok {link:getPreferences()}. This is in oder to permit
091: * canceling changes done in the options dialog.<BR>
092: * Default implementation return null, which results in no customizer.
093: * It is fine to return null (as default implementation does)
094: * @param node Preferences node the customizer should work on.
095: * @return Component which will be shown in the options dialog.
096: */
097: public JComponent getCustomizer(Preferences node) {
098: return null;
099: }
100:
101: public abstract String getDescription();
102:
103: /** Finds out whether the rule is currently enabled.
104: * @return true if enabled false otherwise.
105: */
106: public final boolean isEnabled() {
107: return HintsSettings.isEnabled(this ,
108: getPreferences(HintsSettings.getCurrentProfileId()));
109: }
110:
111: /** Gets current severiry of the hint.
112: * @return Hints severity in current profile.
113: */
114: public final HintSeverity getSeverity() {
115: return HintsSettings.getSeverity(this ,
116: getPreferences(HintsSettings.getCurrentProfileId()));
117: }
118:
119: /** Severity of hint
120: * <li><code>ERROR</code> - will show up as error
121: * <li><code>WARNING</code> - will show up as warrnig
122: * <li><code>CURRENT_LINE_WARNING</code> - will only show up when the caret is placed in the errorneous element
123: */
124: public static enum HintSeverity {
125: ERROR, WARNING, CURRENT_LINE_WARNING;
126:
127: public Severity toEditorSeverity() {
128: switch (this ) {
129: case ERROR:
130: return Severity.ERROR;
131: case WARNING:
132: return Severity.VERIFIER;
133: case CURRENT_LINE_WARNING:
134: return Severity.HINT;
135: default:
136: return null;
137: }
138: }
139: }
140:
141: // Private section ---------------------------------------------------------
142:
143: private static class HintAccessorImpl implements
144: HintsSettings.HintsAccessor {
145:
146: public boolean isEnabledDefault(AbstractHint hint) {
147: return hint.enableDefault;
148: }
149:
150: public boolean isShowInTaskListDefault(AbstractHint hint) {
151: return hint.showInTaskListDefault;
152: }
153:
154: public HintSeverity severiryDefault(AbstractHint hint) {
155: return hint.severityDefault;
156: }
157:
158: public String[] getSuppressBy(AbstractHint hint) {
159: return hint.suppressBy;
160: }
161:
162: }
163: }
|