fixes #1419: Replaced castor with plain JAXB

PMD-Plugin does not work if run with IBM JDK 1.7.0

Author: adangel

ReleaseNotes.md

@@ -7,6 +7,7 @@ Eclipse Update Site: <https://sourceforge.net/projects/pmd/files/pmd-eclipse/upd
 ## ????: 4.0.8.v????
 
 *   Updated PMD to 5.3.4
+*   Fixed PMD-Plugin does not work if run with IBM JDK 1.7.0 ([bug #1419](https://sourceforge.net/p/pmd/bugs/1419/))
 
 **API Changes**:
 

net.sourceforge.pmd.eclipse.plugin/META-INF/MANIFEST.MF

@@ -21,8 +21,6 @@ Bundle-RequiredExecutionEnvironment: JavaSE-1.6
 Bundle-Vendor: %plugin.provider
 Bundle-ClassPath: target/lib/aopalliance.jar,
  target/lib/asm.jar,
- target/lib/castor-core.jar,
- target/lib/castor-xml.jar,
  target/lib/commons-collections.jar,
  target/lib/commons-io.jar,
  target/lib/commons-lang.jar,

net.sourceforge.pmd.eclipse.plugin/pom.xml

@@ -25,11 +25,6 @@
         <artifactId>log4j</artifactId>
         <version>1.2.17</version>
     </dependency>
-    <dependency>
-        <groupId>org.codehaus.castor</groupId>
-        <artifactId>castor-xml</artifactId>
-        <version>1.3.3</version>
-    </dependency>
   </dependencies>
 
   <build>

net.sourceforge.pmd.eclipse.plugin/src/main/java/net/sourceforge/pmd/eclipse/runtime/properties/impl/ProjectPropertiesManagerImpl.java

@@ -38,17 +38,22 @@
 import java.io.ByteArrayInputStream;
 import java.io.File;
 import java.io.IOException;
-import java.io.InputStreamReader;
-import java.io.Reader;
 import java.io.StringReader;
 import java.io.StringWriter;
-import java.net.URL;
 import java.util.ArrayList;
 import java.util.HashMap;
 import java.util.Iterator;
 import java.util.List;
 import java.util.Map;
 
+import javax.xml.bind.DataBindingException;
+import javax.xml.bind.JAXBContext;
+import javax.xml.bind.JAXBElement;
+import javax.xml.bind.JAXBException;
+import javax.xml.bind.Marshaller;
+import javax.xml.transform.Source;
+import javax.xml.transform.stream.StreamSource;
+
 import net.sourceforge.pmd.Rule;
 import net.sourceforge.pmd.RuleSet;
 import net.sourceforge.pmd.RuleSetFactory;
@@ -58,7 +63,6 @@
 import net.sourceforge.pmd.eclipse.runtime.properties.IProjectProperties;
 import net.sourceforge.pmd.eclipse.runtime.properties.IProjectPropertiesManager;
 import net.sourceforge.pmd.eclipse.runtime.properties.PropertiesException;
-import net.sourceforge.pmd.eclipse.util.IOUtil;
 
 import org.apache.commons.io.IOUtils;
 import org.apache.log4j.Logger;
@@ -67,12 +71,6 @@
 import org.eclipse.core.runtime.CoreException;
 import org.eclipse.ui.IWorkingSetManager;
 import org.eclipse.ui.PlatformUI;
-import org.exolab.castor.mapping.Mapping;
-import org.exolab.castor.mapping.MappingException;
-import org.exolab.castor.xml.MarshalException;
-import org.exolab.castor.xml.Marshaller;
-import org.exolab.castor.xml.Unmarshaller;
-import org.exolab.castor.xml.ValidationException;
 
 /**
  * This class manages the persistence of the ProjectProperies information structure
@@ -84,10 +82,18 @@ public class ProjectPropertiesManagerImpl implements IProjectPropertiesManager {
     private static final Logger log = Logger.getLogger(ProjectPropertiesManagerImpl.class);
 
     private static final String PROPERTIES_FILE = ".pmd";
-    private static final String PROPERTIES_MAPPING = "/net/sourceforge/pmd/eclipse/runtime/properties/impl/mapping.xml";
 
     private final Map<IProject, IProjectProperties> projectsProperties = new HashMap<IProject, IProjectProperties>();
 
+    private static final JAXBContext JAXB_CONTEXT = initJaxbContext();
+
+    private static JAXBContext initJaxbContext() {
+        try {
+            return JAXBContext.newInstance(ProjectPropertiesTO.class);
+        } catch (JAXBException e) {
+            throw new RuntimeException(e);
+        }
+    }
     /**
      * Load a project properties
      *
@@ -169,32 +175,16 @@ private void loadRuleSetFromProject(IProjectProperties projectProperties) throws
         }
     }
 
-    public ProjectPropertiesTO convertProjectPropertiesFromString(String properties)
-        throws PropertiesException {
-        ProjectPropertiesTO projectProperties = null;
-        Reader reader = null;
+    public ProjectPropertiesTO convertProjectPropertiesFromString(String properties) {
         try {
-            final Mapping mapping = new Mapping(this.getClass().getClassLoader());
-            final URL mappingSpecUrl = this.getClass().getResource(PROPERTIES_MAPPING);
-            mapping.loadMapping(mappingSpecUrl);
-
-            reader = new StringReader(properties);
-            final Unmarshaller unmarshaller = new Unmarshaller(mapping);
-            projectProperties = (ProjectPropertiesTO) unmarshaller.unmarshal(reader);
-        } catch (MarshalException e) {
-            throw new PropertiesException(e);
-        } catch (ValidationException e) {
-            throw new PropertiesException(e);
-        } catch (IOException e) {
-            throw new PropertiesException(e);
-        } catch (MappingException e) {
-            throw new PropertiesException(e);
-        } finally {
-            IOUtil.closeQuietly(reader);
+            Source source = new StreamSource(new StringReader(properties));
+            JAXBElement<ProjectPropertiesTO> element = JAXB_CONTEXT.createUnmarshaller().unmarshal(source, ProjectPropertiesTO.class);
+            return element.getValue();
+        } catch (JAXBException e) {
+            throw new DataBindingException(e);
         }
-
-        return projectProperties;
     }
+
     /**
      * Read a project properties from properties file
      *
@@ -273,34 +263,21 @@ private void setRuleSetFromProperties(IProjectProperties projectProperties, Rule
         projectProperties.setProjectRuleSet(ruleSet);
     }
 
-    public String convertProjectPropertiesToString(ProjectPropertiesTO projectProperties)
-            throws PropertiesException {
-        StringWriter writer = null;
+    public String convertProjectPropertiesToString(ProjectPropertiesTO projectProperties) {
         try {
-            final Mapping mapping = new Mapping(getClass().getClassLoader());
-            final URL mappingSpecUrl = getClass().getResource(PROPERTIES_MAPPING);
-            mapping.loadMapping(mappingSpecUrl);
-
-            writer = new StringWriter();
-            final Marshaller marshaller = new Marshaller();
-            marshaller.setProperty("org.exolab.castor.indent", "true");
-            marshaller.setWriter(writer);
-            marshaller.setMapping(mapping);
-            marshaller.marshal(projectProperties);
-            writer.flush();
+            Marshaller marshaller = JAXB_CONTEXT.createMarshaller();
+            marshaller.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, true);
+            marshaller.setProperty(Marshaller.JAXB_ENCODING, "UTF-8");
+            marshaller.setProperty(Marshaller.JAXB_FRAGMENT, true);
 
-            return writer.toString();
+            StringWriter writer = new StringWriter();
+            writer.write("<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n");
+            marshaller.marshal(projectProperties, writer);
+            writer.write("\n");
 
-        } catch (MarshalException e) {
-            throw new PropertiesException(e);
-        } catch (ValidationException e) {
-            throw new PropertiesException(e);
-        } catch (IOException e) {
-            throw new PropertiesException(e);
-        } catch (MappingException e) {
-            throw new PropertiesException(e);
-        } finally {
-            IOUtil.closeQuietly(writer);
+            return writer.toString();
+        } catch (JAXBException e) {
+            throw new DataBindingException(e);
         }
     }
 

net.sourceforge.pmd.eclipse.plugin/src/main/java/net/sourceforge/pmd/eclipse/runtime/properties/impl/ProjectPropertiesTO.java

@@ -35,6 +35,13 @@
  */
 package net.sourceforge.pmd.eclipse.runtime.properties.impl;
 
+import javax.xml.bind.annotation.XmlAccessOrder;
+import javax.xml.bind.annotation.XmlAccessorOrder;
+import javax.xml.bind.annotation.XmlElement;
+import javax.xml.bind.annotation.XmlElementWrapper;
+import javax.xml.bind.annotation.XmlRootElement;
+import javax.xml.bind.annotation.XmlType;
+
 
 /**
  * This class is a simple data bean to let simply serialize project properties
@@ -43,6 +50,9 @@
  * @author Philippe Herlin
  *
  */
+@XmlRootElement(name = "pmd")
+@XmlType(propOrder = {"workingSetName", "ruleSetStoredInProject", "ruleSetFile", "excludePatterns",
+        "includePatterns", "rules", "includeDerivedFiles", "violationsAsErrors", "fullBuildEnabled"})
 public class ProjectPropertiesTO {
     private RuleSpecTO[] rules;
     private String[] excludePatterns;
@@ -59,6 +69,8 @@ public class ProjectPropertiesTO {
      * @return rules an array of RuleSpecTO objects that keep information of rules
      * selected for the current project
      */
+    @XmlElementWrapper(name = "rules")
+    @XmlElement(name = "rule")
     public RuleSpecTO[] getRules() {
         return rules;
     }
@@ -76,6 +88,8 @@ public void setRules(final RuleSpecTO[] rules) {
      * @return an array of String objects for exclude patterns
      * for the current project.
      */
+    @XmlElementWrapper(name = "excludePatterns")
+    @XmlElement(name = "excludePattern")
     public String[] getExcludePatterns() {
 		return excludePatterns;
 	}
@@ -93,6 +107,8 @@ public void setExcludePatterns(String[] excludePatterns) {
      * @return an array of String objects for include patterns
      * for the current project.
      */
+	@XmlElementWrapper(name = "includePatterns")
+	@XmlElement(name = "includePattern")
 	public String[] getIncludePatterns() {
 		return includePatterns;
 	}
@@ -110,6 +126,7 @@ public void setIncludePatterns(String[] includePatterns) {
      * @return ruleSetStoredInProject tells whether the project use a ruleset
      * stored in the project or the global plugin ruleset.
      */
+    @XmlElement(name = "useProjectRuleSet")
     public boolean isRuleSetStoredInProject() {
         return ruleSetStoredInProject;
     }
@@ -126,6 +143,7 @@ public void setRuleSetStoredInProject(final boolean ruleSetStoredInProject) {
     /**
      * @return Returns the rule set file.
      */
+    @XmlElement(name = "ruleSetFile")
     public String getRuleSetFile() {
     	return ruleSetFile;
     }
@@ -140,6 +158,7 @@ public void setRuleSetFile(String ruleSetFile) {
     /**
      * @return workingSetName the name of the project workingSet
      */
+    @XmlElement(name = "workingSet")
     public String getWorkingSetName() {
         return workingSetName;
     }
@@ -155,6 +174,7 @@ public void setWorkingSetName(final String workingSetName) {
     /**
      * @return Returns the includeDerivedFiles.
      */
+    @XmlElement(name = "includeDerivedFiles")
     public boolean isIncludeDerivedFiles() {
         return this.includeDerivedFiles;
     }
@@ -166,6 +186,7 @@ public void setIncludeDerivedFiles(boolean includeDerivedFiles) {
         this.includeDerivedFiles = includeDerivedFiles;
     }
 
+    @XmlElement(name = "violationsAsErrors")
     public boolean isViolationsAsErrors() {
         return violationsAsErrors;
     }
@@ -186,6 +207,7 @@ public void setFullBuildEnabled(boolean fullBuildEnabled) {
      * syntactic sugar for accessing this field
 	 * @return true if we should run at full build
 	 */
+	@XmlElement(name = "fullBuildEnabled")
 	public boolean isFullBuildEnabled() {
 		return fullBuildEnabled;
 	}

net.sourceforge.pmd.eclipse.plugin/src/main/java/net/sourceforge/pmd/eclipse/runtime/properties/impl/RuleSpecTO.java

@@ -35,6 +35,9 @@
  */
 package net.sourceforge.pmd.eclipse.runtime.properties.impl;
 
+import javax.xml.bind.annotation.XmlElement;
+import javax.xml.bind.annotation.XmlType;
+
 /**
  * This class is a simple data bean to help serialize project properties. Is
  * used by the ProjectPropertiesTO to handle project selected rules. This
@@ -43,6 +46,7 @@
  * @author Philippe Herlin
  *  
  */
+@XmlType(propOrder = {"name", "ruleSetName"})
 public class RuleSpecTO {
     private String name;
     private String ruleSetName;
@@ -72,6 +76,7 @@ public RuleSpecTO(final String name, final String ruleSetName) {
     /**
      * @return name a rule name
      */
+    @XmlElement(name = "name")
     public String getName() {
         return name;
     }
@@ -89,6 +94,7 @@ public void setName(final String name) {
     /**
      * @return ruleSetName the name of ruleset the rule come from
      */
+    @XmlElement(name = "ruleset")
     public String getRuleSetName() {
         return ruleSetName;
     }