Merge pull request #8886 from NicolaIsotta/jakarta-bv

Handle jakarta package in bean validation constraint template

Author: matthiasblaesing

enterprise/javaee.beanvalidation/nbproject/project.properties

@@ -14,5 +14,5 @@
 # KIND, either express or implied.  See the License for the
 # specific language governing permissions and limitations
 # under the License.
-javac.source=1.8
+javac.release=17
 javac.compilerargs=-Xlint -Xlint:-serial

enterprise/javaee.beanvalidation/nbproject/project.xml

@@ -25,6 +25,15 @@
         <data xmlns="http://www.netbeans.org/ns/nb-module-project/3">
             <code-name-base>org.netbeans.modules.javaee.beanvalidation</code-name-base>
             <module-dependencies>
+                <dependency>
+                    <code-name-base>org.netbeans.api.java.classpath</code-name-base>
+                    <build-prerequisite/>
+                    <compile-dependency/>
+                    <run-dependency>
+                        <release-version>1</release-version>
+                        <specification-version>1.27</specification-version>
+                    </run-dependency>
+                </dependency>
                 <dependency>
                     <code-name-base>org.netbeans.api.web.webmodule</code-name-base>
                     <build-prerequisite/>

enterprise/javaee.beanvalidation/src/org/netbeans/modules/javaee/beanvalidation/ConstraintIterator.java

@@ -22,19 +22,23 @@
 import java.awt.Component;
 import java.io.IOException;
 import java.util.ArrayList;
-import java.util.Arrays;
 import java.util.Collections;
 import java.util.HashMap;
-import java.util.HashSet;
 import java.util.List;
+import java.util.Map;
 import java.util.NoSuchElementException;
 import java.util.Set;
 import javax.swing.JComponent;
 import javax.swing.event.ChangeListener;
+import org.netbeans.api.j2ee.core.Profile;
+import org.netbeans.api.java.classpath.ClassPath;
 import org.netbeans.api.java.project.JavaProjectConstants;
 import org.netbeans.api.project.Project;
 import org.netbeans.api.project.ProjectUtils;
 import org.netbeans.api.project.SourceGroup;
+import org.netbeans.api.project.Sources;
+import org.netbeans.modules.javaee.project.api.JavaEEProjectSettings;
+import org.netbeans.spi.java.classpath.ClassPathProvider;
 import org.netbeans.spi.java.project.support.ui.templates.JavaTemplates;
 import org.netbeans.spi.project.ui.templates.support.Templates;
 import org.openide.WizardDescriptor;
@@ -50,8 +54,10 @@
  *
  * @author alexeybutenko
  */
-public class ConstraintIterator implements TemplateWizard.Iterator{
-    
+public class ConstraintIterator implements TemplateWizard.Iterator {
+
+    private static final String JAVAX_CONSTRAINT_CLASS = "javax/validation/Constraint.class";
+
     private transient WizardDescriptor.Panel<WizardDescriptor>[] panels;
     private int index;
     private final String VALIDATOR_TEMPLATE = "Validator.java"; //NOI18N
@@ -61,30 +67,32 @@ public Set<DataObject> instantiate(TemplateWizard wizard) throws IOException {
         FileObject dir = Templates.getTargetFolder( wizard );
         DataFolder df = DataFolder.findFolder( dir );
         FileObject template = Templates.getTemplate( wizard );
+        Project project = Templates.getProject(wizard);
+        boolean jakartaPackage = isJakartaPackage(project);
 
         DataObject dTemplate = DataObject.find( template );
         List<String> targetElements = (List<String>) wizard.getProperty(WizardProperties.TARGET_ELEMENTS);
         if (targetElements == null) {
-            targetElements = new ArrayList<String>();
+            targetElements = new ArrayList<>();
         }
         String validatorClassName = (String) wizard.getProperty(WizardProperties.VALIDATOR_CLASS_NAME);
         String validatorType = (String)wizard.getProperty(WizardProperties.VALIDATOR_TYPE);
         boolean generateValidator = validatorClassName !=null;
 
-        HashMap<String, Object> templateProperties = new HashMap<String, Object>();
+        Map<String, Object> templateProperties = new HashMap<>();
         templateProperties.put(WizardProperties.TARGET_ELEMENTS, targetElements);
+        templateProperties.put(WizardProperties.JAKARTA_PACKAGE, jakartaPackage);
         if (generateValidator) {
             templateProperties.put(WizardProperties.VALIDATOR_CLASS_NAME, validatorClassName);
             templateProperties.put(WizardProperties.VALIDATOR_TYPE, validatorType);
         }
-        DataObject dobj = null;
         String constraintClass = wizard.getTargetName();
-        dobj = dTemplate.createFromTemplate(df, constraintClass, templateProperties);
+        DataObject dobj = dTemplate.createFromTemplate(df, constraintClass, templateProperties);
         if (generateValidator) {
             FileObject validatorTemplate = template.getParent().getFileObject(VALIDATOR_TEMPLATE);
-            DataObject validatorDataObject = createValidator(df, validatorTemplate, validatorClassName, validatorType, constraintClass);
-            if (validatorDataObject !=null) {
-                return new HashSet<DataObject>(Arrays.asList(new DataObject[]{dobj, validatorDataObject}));
+            DataObject validatorDataObject = createValidator(df, validatorTemplate, validatorClassName, validatorType, constraintClass, jakartaPackage);
+            if (validatorDataObject != null) {
+                return Set.of(dobj, validatorDataObject);
             }
         }
         return Collections.singleton(dobj);
@@ -110,8 +118,8 @@ public void initialize(TemplateWizard wizard) {
         // Creating steps.
         Object prop = wizard.getProperty(WizardDescriptor.PROP_CONTENT_DATA); // NOI18N
         String[] beforeSteps = null;
-        if (prop instanceof String[]) {
-            beforeSteps = (String[])prop;
+        if (prop instanceof String[] strings) {
+            beforeSteps = strings;
         }
         String[] steps = createSteps(beforeSteps, panels);
 
@@ -123,8 +131,7 @@ public void initialize(TemplateWizard wizard) {
                 // chooser to appear in the list of steps.
                 steps[i] = c.getName();
             }
-            if (c instanceof JComponent) { // assume Swing components
-                JComponent jc = (JComponent) c;
+            if (c instanceof JComponent jc) { // assume Swing components
                 // Step #.
                 jc.putClientProperty(WizardDescriptor.PROP_CONTENT_SELECTED_INDEX, i);
                 // Step name (actually the whole list for reference).
@@ -196,24 +203,48 @@ public void addChangeListener(ChangeListener l) {
     public void removeChangeListener(ChangeListener l) {
     }
 
-    private static DataObject createValidator(DataFolder df, FileObject template, String className, String type, String constraintClass) {
+    private static DataObject createValidator(DataFolder df, FileObject template, String className, String type, String constraintClass, boolean jakartaPackage) {
         try {
             DataObject dTemplate = DataObject.find(template);
-            HashMap<String, Object> templateProperties = new HashMap<String, Object>();
+            Map<String, Object> templateProperties = new HashMap<>();
             templateProperties.put(WizardProperties.VALIDATOR_TYPE, type);
             templateProperties.put(WizardProperties.CONSTRAINT_CLASS_NAME, constraintClass);
+            templateProperties.put(WizardProperties.JAKARTA_PACKAGE, jakartaPackage);
             return dTemplate.createFromTemplate(df, className,templateProperties);
 
         } catch (IOException ex) {
             Exceptions.printStackTrace(ex);
         }
         return null;
     }
+    
+    private static boolean isJakartaPackage(Project project) {
+        Profile profile = JavaEEProjectSettings.getProfile(project);
+        if (profile != null) {
+            return profile.isAtLeast(Profile.JAKARTA_EE_9_WEB);
+        }
+
+        Sources sources = ProjectUtils.getSources(project);
+        if (sources == null) {
+            return true;
+        }
+
+        SourceGroup[] sourceGroups = sources.getSourceGroups("java");
+        if (sourceGroups.length > 0) {
+            ClassPathProvider cpp = project.getLookup().lookup(ClassPathProvider.class);
+            ClassPath classPath = cpp.findClassPath(sourceGroups[0].getRootFolder(), ClassPath.COMPILE);
+            if (classPath != null && classPath.findResource(JAVAX_CONSTRAINT_CLASS) != null) {
+                return false;
+            }
+        }
+        return true;
+    }
 
     static class WizardProperties {
         public static final String CONSTRAINT_CLASS_NAME = "constraint";    //NOI18N
         public static final String VALIDATOR_CLASS_NAME = "validator";    //NOI18N
         public static final String VALIDATOR_TYPE = "validatorType";    //NOI18N
         public static final String TARGET_ELEMENTS = "targetElements";    //NOI18N
+        public static final String JAKARTA_PACKAGE = "jakartaPackage";
     }
 }

enterprise/javaee.beanvalidation/src/org/netbeans/modules/javaee/beanvalidation/resources/Bundle.properties

@@ -17,5 +17,6 @@
 OpenIDE-Module-Name=Bean Validation
 Templates/Bean_Validation=Bean Validation
 Templates/Bean_Validation/Constraint.java=Validation Constraint
+Templates/Bean_Validation/Validator.java=Constraint Validator
 Templates/Bean_Validation/validation.xml=Bean Validation Configuration
 Templates/Bean_Validation/constraint.xml=Constraint Mappings

enterprise/javaee.beanvalidation/src/org/netbeans/modules/javaee/beanvalidation/resources/Constraint.template

@@ -12,10 +12,17 @@ import java.lang.annotation.ElementType;
 import java.lang.annotation.Retention;
 import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
+<#if jakartaPackage?? && jakartaPackage==true>
+<#if validator?? && validator != "">
+import jakarta.validation.Constraint;
+</#if>
+import jakarta.validation.Payload;
+<#else>
 <#if validator?? && validator != "">
 import javax.validation.Constraint;
 </#if>
 import javax.validation.Payload;
+</#if>
 
 /**
  *
@@ -31,4 +38,4 @@ public @interface ${name} {
     String message() default "{${package}.${name}}";
     Class<?>[] groups() default {};
     Class<? extends Payload>[] payload() default {};
-}
+}

enterprise/javaee.beanvalidation/src/org/netbeans/modules/javaee/beanvalidation/resources/Validator.template

@@ -7,8 +7,13 @@
 package ${package};
 </#if>
 
+<#if jakartaPackage?? && jakartaPackage==true>
+import jakarta.validation.ConstraintValidator;
+import jakarta.validation.ConstraintValidatorContext;
+<#else>
 import javax.validation.ConstraintValidator;
 import javax.validation.ConstraintValidatorContext;
+</#if>
 
 /**
  *
@@ -25,4 +30,4 @@ public class ${name} implements ConstraintValidator<${constraint}, ${validatorTy
     public boolean isValid(${validatorType} value, ConstraintValidatorContext context) {
         throw new UnsupportedOperationException("Not supported yet.");
     }
-}
+}

enterprise/javaee.beanvalidation/src/org/netbeans/modules/javaee/beanvalidation/resources/layer.xml

@@ -19,11 +19,11 @@
     under the License.
 
 -->
-<!DOCTYPE filesystem PUBLIC "-//NetBeans//DTD Filesystem 1.1//EN" "http://www.netbeans.org/dtds/filesystem-1_1.dtd">
+<!DOCTYPE filesystem PUBLIC "-//NetBeans//DTD Filesystem 1.2//EN" "http://www.netbeans.org/dtds/filesystem-1_2.dtd">
 <filesystem>
     <folder name="Templates">
         <folder name="Bean_Validation">
-             <attr name="position" intvalue="701"/>
+            <attr name="position" intvalue="701"/>
             <attr name="SystemFileSystem.localizingBundle" stringvalue="org.netbeans.modules.javaee.beanvalidation.resources.Bundle"/>
             <attr name="templateWizardURL" urlvalue="nbresloc:/org/netbeans/modules/javaee/beanvalidation/resources/WebInfo.html"/>
 
@@ -38,11 +38,15 @@
                 <attr name="SystemFileSystem.icon" urlvalue="nbresloc:/org/netbeans/modules/java/resources/class.gif"/>
             </file>
             <file name="Validator.java" url="Validator.template">
-                <attr name="position" intvalue="0"/>
+                <attr name="position" intvalue="1004"/>
+                <attr name="template" boolvalue="true"/>
                 <attr name="javax.script.ScriptEngine" stringvalue="freemarker"/>
+                <attr name="SystemFileSystem.localizingBundle" stringvalue="org.netbeans.modules.javaee.beanvalidation.resources.Bundle"/>
+                <attr name="templateCategory" stringvalue="web-types,j2ee-types"/>
+                <attr name="SystemFileSystem.icon" urlvalue="nbresloc:/org/netbeans/modules/java/resources/class.gif"/>
             </file>
             <file name="validation.xml" url="validation.xml">
-                <attr name="position" intvalue="1004"/>
+                <attr name="position" intvalue="1005"/>
                 <attr name="template" boolvalue="true"/>
                 <attr name="javax.script.ScriptEngine" stringvalue="freemarker"/>
                 <attr name="templateWizardURL" urlvalue="nbresloc:/org/netbeans/modules/javaee/beanvalidation/resources/ValidationConfiguration.html"/>
@@ -51,7 +55,7 @@
                 <attr name="templateCategory" stringvalue="web-types,j2ee-types"/>
             </file>
             <file name="constraint.xml" url="constraint.xml">
-                <attr name="position" intvalue="1005"/>
+                <attr name="position" intvalue="1006"/>
                 <attr name="template" boolvalue="true"/>
                 <attr name="javax.script.ScriptEngine" stringvalue="freemarker"/>
                 <attr name="templateWizardURL" urlvalue="nbresloc:/org/netbeans/modules/javaee/beanvalidation/resources/ValidationMapping.html"/>