mbien commented on code in PR #4802: URL: https://github.com/apache/netbeans/pull/4802#discussion_r998575349
########## java/maven.hints/src/org/netbeans/modules/maven/hints/pom/UseReleaseOptionHint.java: ########## @@ -0,0 +1,241 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ +package org.netbeans.modules.maven.hints.pom; + +import java.util.ArrayList; +import java.util.Collections; +import java.util.List; +import java.util.prefs.Preferences; +import javax.swing.JComponent; +import javax.xml.namespace.QName; +import org.netbeans.api.project.Project; +import org.netbeans.modules.editor.NbEditorUtilities; +import org.netbeans.modules.maven.hints.pom.spi.Configuration; +import org.netbeans.modules.maven.hints.pom.spi.POMErrorFixProvider; +import org.netbeans.modules.maven.model.pom.Build; +import org.netbeans.modules.maven.model.pom.POMComponent; +import org.netbeans.modules.maven.model.pom.POMExtensibilityElement; +import org.netbeans.modules.maven.model.pom.POMModel; +import org.netbeans.modules.maven.model.pom.POMQName; +import org.netbeans.modules.maven.model.pom.Plugin; +import org.netbeans.modules.maven.model.pom.PluginExecution; +import org.netbeans.modules.maven.model.pom.Properties; +import org.netbeans.spi.editor.hints.ChangeInfo; +import org.netbeans.spi.editor.hints.ErrorDescription; +import org.netbeans.spi.editor.hints.ErrorDescriptionFactory; +import org.netbeans.spi.editor.hints.Fix; +import org.netbeans.spi.editor.hints.Severity; +import org.openide.text.Line; +import org.openide.util.NbBundle; + +import static org.netbeans.modules.maven.hints.pom.Bundle.*; + +/** + * Converts source/target javac options to the release option where possible (JEP 247). + * @author mbien + */ [email protected]({ + "TIT_UseReleaseVersionHint=Convert matching source/target javac options to the release option.", + "DESC_UseReleaseVersionHint=Matching source/target options can be replaced with a single release option (JEP 247). This enforces API compatibility with the chosen Java release.", + "FIX_UseReleaseVersionHint=Convert to release option for strict compatibility checks."}) +public class UseReleaseOptionHint implements POMErrorFixProvider { + + private static final String TARGET_TAG = "target"; + private static final String SOURCE_TAG = "source"; + private static final String RELEASE_TAG = "release"; + + private static final Configuration config = new Configuration(UseReleaseOptionHint.class.getName(), + TIT_UseReleaseVersionHint(), DESC_UseReleaseVersionHint(), true, Configuration.HintSeverity.WARNING); + + @Override + public List<ErrorDescription> getErrorsForDocument(POMModel model, Project prj) { + + List<ErrorDescription> hints = new ArrayList<>(); + + Build build = model.getProject().getBuild(); + if (build != null) { + for (Plugin plugin : build.getPlugins()) { + if ("maven-compiler-plugin".equals(plugin.getArtifactId())) { + if (!isPluginCompatible(plugin)) { + return Collections.emptyList(); + } + if (plugin.getConfiguration() != null) { + hints.addAll(createHintsForParent("", plugin.getConfiguration())); + } + if (plugin.getExecutions() != null) { + for (PluginExecution execution : plugin.getExecutions()) { + if (execution.getConfiguration() != null) { + hints.addAll(createHintsForParent("", execution.getConfiguration())); + } + } + } + break; + } + } + } + + Properties properties = model.getProject().getProperties(); + if (properties != null) { + hints.addAll(createHintsForParent("maven.compiler.", properties)); + } + + return hints; + } + + private List<ErrorDescription> createHintsForParent(String prefix, POMComponent parent) { + + int source; + int target; + + // property name or an int value + String release = null; + + try { + String sourceText = parent.getChildElementText(POMQName.createQName(prefix+SOURCE_TAG, true)); + if (isProperty(sourceText)) { Review Comment: the hint will only show up if there the pom has both, source and target defined and both are set to the same value. It should simply give up if one of the two is not valid or missing. The main motivation behind this hint was because I met many who still didn't know that the release option exists and why it is better. I personally never set one without the other. Haven't thought about converting a single option into release - you think this would be save in all cases? -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected] For further information about the NetBeans mailing lists, visit: https://cwiki.apache.org/confluence/display/NETBEANS/Mailing+lists
