-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
issue #24: Remove redundant modifiers from fields within inner classes
- Loading branch information
Showing
4 changed files
with
308 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
154 changes: 154 additions & 0 deletions
154
src/main/java/de/markiewb/netbeans/plugins/hints/structure/RemoveFieldModsFromIntf.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,154 @@ | ||
| /* | ||
| * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. | ||
| * | ||
| * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved. | ||
| * | ||
| * The contents of this file are subject to the terms of either the GNU | ||
| * General Public License Version 2 only ("GPL") or the Common | ||
| * Development and Distribution License("CDDL") (collectively, the | ||
| * "License"). You may not use this file except in compliance with the | ||
| * License. You can obtain a copy of the License at | ||
| * http://www.netbeans.org/cddl-gplv2.html | ||
| * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the | ||
| * specific language governing permissions and limitations under the | ||
| * License. When distributing the software, include this License Header | ||
| * Notice in each file and include the License file at | ||
| * nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this | ||
| * particular file as subject to the "Classpath" exception as provided | ||
| * by Sun in the GPL Version 2 section of the License file that | ||
| * accompanied this code. If applicable, add the following below the | ||
| * License Header, with the fields enclosed by brackets [] replaced by | ||
| * your own identifying information: | ||
| * "Portions Copyrighted [year] [name of copyright owner]" | ||
| * | ||
| * Contributor(s): | ||
| * | ||
| * The Original Software is NetBeans. The Initial Developer of the Original | ||
| * Software is Sun Microsystems, Inc. Portions Copyright 1997-2007 Sun | ||
| * Microsystems, Inc. All Rights Reserved. | ||
| * | ||
| * If you wish your version of this file to be governed by only the CDDL | ||
| * or only the GPL Version 2, indicate your decision by adding | ||
| * "[Contributor] elects to include this software in this distribution | ||
| * under the [CDDL or GPL Version 2] license." If you do not indicate a | ||
| * single choice of license, a recipient has the option to distribute | ||
| * your version of this file under either the CDDL, the GPL Version 2 or | ||
| * to extend the choice of license to its licensees as provided above. | ||
| * However, if you add GPL Version 2 code and therefore, elected the GPL | ||
| * Version 2 license, then the option applies only if the new code is | ||
| * made subject to such option by the copyright holder. | ||
| * | ||
| * "Portions Copyrighted 2013 Benno Markiewicz" | ||
| */ | ||
| package de.markiewb.netbeans.plugins.hints.structure; | ||
|
|
||
| import com.sun.source.tree.MethodTree; | ||
| import com.sun.source.tree.ModifiersTree; | ||
| import com.sun.source.tree.Tree; | ||
| import com.sun.source.tree.VariableTree; | ||
| import com.sun.source.util.TreePath; | ||
| import de.markiewb.netbeans.plugins.hints.common.StringUtils; | ||
| import java.util.ArrayList; | ||
| import java.util.HashSet; | ||
| import java.util.List; | ||
| import java.util.Set; | ||
| import javax.lang.model.element.Modifier; | ||
| import org.netbeans.api.java.source.TreeMaker; | ||
| import org.netbeans.api.java.source.TreePathHandle; | ||
| import org.netbeans.api.java.source.WorkingCopy; | ||
| import org.netbeans.spi.editor.hints.ErrorDescription; | ||
| import org.netbeans.spi.editor.hints.Fix; | ||
| import org.netbeans.spi.editor.hints.Severity; | ||
| import org.netbeans.spi.java.hints.ErrorDescriptionFactory; | ||
| import org.netbeans.spi.java.hints.Hint; | ||
| import org.netbeans.spi.java.hints.HintContext; | ||
| import org.netbeans.spi.java.hints.JavaFix; | ||
| import org.netbeans.spi.java.hints.TriggerTreeKind; | ||
| import org.openide.util.NbBundle; | ||
|
|
||
| /** | ||
| * Removes superfluous modifiers (public, abstract, final) from field declarations within interfaces. | ||
| * | ||
| * @author markiewb | ||
| */ | ||
| @NbBundle.Messages({ | ||
| "# {0} - modifiers ", | ||
| "# {1} - number of modifiers", | ||
| "ERR_RemoveModsFromFieldParam=Remove {0} {1,choice,0#modifiers|1#modifier|1<modifiers}", | ||
| "ERR_RemoveModsFromField=Remove public/abstract/final modifiers", | ||
| "DN_RemoveModsFromField=Remove public/abstract/final modifiers from field declarations within interfaces", | ||
| "DESC_RemoveModsFromField=Remove public/abstract/final modifiers from field declarations within interfaces. <p>Provided by <a href=\"https://github.com/markiewb/nb-additional-hints\">nb-additional-hints</a> plugin</p>",}) | ||
| public class RemoveFieldModsFromIntf { | ||
|
|
||
| @Hint(displayName = "#DN_RemoveModsFromField", description = "#DESC_RemoveModsFromField", category = "suggestions", hintKind = Hint.Kind.INSPECTION, severity = Severity.HINT) | ||
| @TriggerTreeKind(Tree.Kind.VARIABLE) | ||
| public static ErrorDescription convert(HintContext ctx) { | ||
|
|
||
| TreePath path = ctx.getPath(); | ||
|
|
||
| if (path.getLeaf().getKind() != Tree.Kind.VARIABLE) { | ||
| return null; | ||
| } | ||
| if (path.getParentPath().getLeaf().getKind() != Tree.Kind.INTERFACE) { | ||
| return null; | ||
| } | ||
|
|
||
| ModifiersTree modifiers = ((VariableTree) path.getLeaf()).getModifiers(); | ||
|
|
||
| Set<Modifier> toBeRemoved = new HashSet<Modifier>(); | ||
| final Set<Modifier> flags = modifiers.getFlags(); | ||
| if (flags.contains(Modifier.PUBLIC)) { | ||
| toBeRemoved.add(Modifier.PUBLIC); | ||
| } | ||
| if (flags.contains(Modifier.STATIC)) { | ||
| toBeRemoved.add(Modifier.STATIC); | ||
| } | ||
| if (flags.contains(Modifier.FINAL)) { | ||
| toBeRemoved.add(Modifier.FINAL); | ||
| } | ||
| Fix fix; | ||
| if (!toBeRemoved.isEmpty()) { | ||
| fix = new RemoveFieldModsFromIntfFix(TreePathHandle.create(ctx.getPath(), ctx.getInfo()), toBeRemoved).toEditorFix(); | ||
| return ErrorDescriptionFactory.forTree(ctx, ctx.getPath(), Bundle.ERR_RemoveModsFromField(), fix); | ||
| } else { | ||
| return null; | ||
| } | ||
| } | ||
|
|
||
| } | ||
|
|
||
| class RemoveFieldModsFromIntfFix extends JavaFix { | ||
|
|
||
| private final Set<Modifier> modifiers; | ||
|
|
||
| RemoveFieldModsFromIntfFix(TreePathHandle handle, Set<Modifier> modifiers) { | ||
| super(handle); | ||
| this.modifiers = modifiers; | ||
| } | ||
|
|
||
| @Override | ||
| protected String getText() { | ||
| List<String> list = new ArrayList<String>(); | ||
| for (Modifier modifier : modifiers) { | ||
| list.add(modifier.toString()); | ||
| } | ||
|
|
||
| return Bundle.ERR_RemoveModsFromFieldParam(StringUtils.join(list, ", "), modifiers.size()); | ||
| } | ||
|
|
||
| @Override | ||
| protected void performRewrite(JavaFix.TransformationContext ctx) throws Exception { | ||
| TreePath path = ctx.getPath(); | ||
|
|
||
| WorkingCopy copy = ctx.getWorkingCopy(); | ||
| TreeMaker make = ctx.getWorkingCopy().getTreeMaker(); | ||
| ModifiersTree oldModifiersTree = ((VariableTree) path.getLeaf()).getModifiers(); | ||
|
|
||
| ModifiersTree newModifiersTree = oldModifiersTree; | ||
| for (Modifier modifier : modifiers) { | ||
| newModifiersTree = make.removeModifiersModifier(newModifiersTree, modifier); | ||
| } | ||
|
|
||
| copy.rewrite(oldModifiersTree, newModifiersTree); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters