-
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.
#55 Report null-assignment to an Optional + updated version to 1.6.0
- Loading branch information
Showing
5 changed files
with
157 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
87 changes: 87 additions & 0 deletions
87
src/main/java/de/markiewb/netbeans/plugins/hints/optional/AssignNullToOptional.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,87 @@ | ||
| /* | ||
| * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. | ||
| * | ||
| * Copyright 2014 Oracle and/or its affiliates. All rights reserved. | ||
| * | ||
| * Oracle and Java are registered trademarks of Oracle and/or its affiliates. | ||
| * Other names may be trademarks of their respective owners. | ||
| * | ||
| * 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. Oracle designates this | ||
| * particular file as subject to the "Classpath" exception as provided | ||
| * by Oracle 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]" | ||
| * | ||
| * 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. | ||
| * | ||
| * Contributor(s): | ||
| * | ||
| * Portions Copyrighted 2014 Sun Microsystems, Inc. | ||
| * Portions Copyrighted 2014 [email protected] | ||
| */ | ||
| package de.markiewb.netbeans.plugins.hints.optional; | ||
|
|
||
| import java.util.Optional; | ||
| 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.ConstraintVariableType; | ||
| 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.TriggerPattern; | ||
| import org.netbeans.spi.java.hints.TriggerPatterns; | ||
| import org.openide.util.NbBundle; | ||
|
|
||
| /** | ||
| * | ||
| * @author markiewb | ||
| */ | ||
| @NbBundle.Messages({ | ||
| "DN_AssignNull=Replace with Optional.empty()", | ||
| "DESC_AssignNull=<tt>java.util.Optional</tt> should not be null, so replace null-assignment with <tt>Optional.empty()</tt>. <p>For example: <tt>Optional<T> o = null;</tt> will be transformed to <tt>Optional<T> o = Optional.empty();</tt></p><p>Provided by <a href=\"https://github.com/markiewb/nb-additional-hints\">nb-additional-hints</a> plugin</p>",}) | ||
| public class AssignNullToOptional { | ||
|
|
||
| @TriggerPatterns({ | ||
| @TriggerPattern(value = "$var1 = null", constraints = @ConstraintVariableType(variable = "$var1", type = "java.util.Optional")), | ||
| @TriggerPattern(value = "$class $var2 = null", constraints = @ConstraintVariableType(variable = "$var2", type = "java.util.Optional")), | ||
| }) | ||
| @Hint(displayName = "#DN_AssignNull", description = "#DESC_AssignNull", category = "bugs", hintKind = Hint.Kind.INSPECTION, severity = Severity.ERROR) | ||
| @NbBundle.Messages("ERR_AssignNull=Replace with Optional.isPresent()") | ||
| public static ErrorDescription convertToOptional(HintContext ctx) { | ||
| String result = null; | ||
| if (ctx.getVariables().containsKey("$var1")) { | ||
| result = "$var1 = Optional.empty()"; | ||
| } | ||
| if (ctx.getVariables().containsKey("$var2")) { | ||
| result = "$class $var2 = Optional.empty()"; | ||
| } | ||
| if (result != null) { | ||
| Fix fix = org.netbeans.spi.java.hints.JavaFixUtilities.rewriteFix(ctx, Bundle.ERR_AssignNull(), ctx.getPath(), result); | ||
| return ErrorDescriptionFactory.forName(ctx, ctx.getPath(), Bundle.ERR_AssignNull(), fix); | ||
| } | ||
| return null; | ||
| } | ||
|
|
||
| } |
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
66 changes: 66 additions & 0 deletions
66
src/test/java/de/markiewb/netbeans/plugins/hints/optional/AssingNullToOptionalTest.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,66 @@ | ||
| /* | ||
| * To change this license header, choose License Headers in Project Properties. | ||
| * To change this template file, choose Tools | Templates | ||
| * and open the template in the editor. | ||
| */ | ||
| package de.markiewb.netbeans.plugins.hints.optional; | ||
|
|
||
| import org.junit.Test; | ||
| import org.netbeans.modules.java.hints.test.api.HintTest; | ||
|
|
||
| /** | ||
| * | ||
| * @author markiewb | ||
| */ | ||
| public class AssingNullToOptionalTest { | ||
|
|
||
| @Test | ||
| public void testCaseAssignmentToExisting() throws Exception { | ||
| HintTest.create() | ||
| .input("package test;\n" | ||
| + "import java.util.Optional;\n" | ||
| + "public class Test {\n" | ||
| + " public void method() {\n" | ||
| + " Optional o;\n" | ||
| + " o = null;\n" | ||
| + " }\n" | ||
| + "}") | ||
| .sourceLevel("1.8") | ||
| .run(AssignNullToOptional.class) | ||
| .findWarning("5:8-5:16:error:" + de.markiewb.netbeans.plugins.hints.optional.Bundle.ERR_AssignNull()) | ||
| .applyFix() | ||
| .assertOutput("package test;\n" | ||
| + "import java.util.Optional;\n" | ||
| + "public class Test {\n" | ||
| + " public void method() {\n" | ||
| + " Optional o;\n" | ||
| + " o = Optional.empty();\n" | ||
| + " }\n" | ||
| + "}"); | ||
|
|
||
| } | ||
| @Test | ||
| public void testCaseAssignmentToNewVariable() throws Exception { | ||
| HintTest.create() | ||
| .input("package test;\n" | ||
| + "import java.util.Optional;\n" | ||
| + "public class Test {\n" | ||
| + " public void method() {\n" | ||
| + " Optional o = null;\n" | ||
| + " }\n" | ||
| + "}") | ||
| .sourceLevel("1.8") | ||
| .run(AssignNullToOptional.class) | ||
| .findWarning("4:17-4:18:error:" + de.markiewb.netbeans.plugins.hints.optional.Bundle.ERR_AssignNull()) | ||
| .applyFix() | ||
| .assertOutput("package test;\n" | ||
| + "import java.util.Optional;\n" | ||
| + "public class Test {\n" | ||
| + " public void method() {\n" | ||
| + " Optional o = Optional.empty();\n" | ||
| + " }\n" | ||
| + "}"); | ||
|
|
||
| } | ||
|
|
||
| } |
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