Merge remote-tracking branch 'upstream/master' into standaloneNoPrese…

…ntAttributeMaster
FasterXML · Jul 9, 2018 · e965081 · e965081
2 parents d9fb214 + dcb21d7
commit e965081
Show file tree

Hide file tree

Showing 70 changed files with 1,731 additions and 958 deletions.
diff --git a/.travis.yml b/.travis.yml
@@ -0,0 +1,5 @@
+language: java
+
+jdk:
+  - openjdk7
+  - openjdk8
diff --git a/README.md b/README.md
@@ -3,12 +3,17 @@
 Stax2 API is an extension to standard [Stax](http://en.wikipedia.org/wiki/StAX) API ("STandard Api for Xml procesing"),
 pull-parser API of JDK, added in JDK 6.
 
+## Status
+
+[![Build Status](https://travis-ci.org/FasterXML/stax2-api.svg)](https://travis-ci.org/FasterXML/stax2-api)
+
+
 ## Support
 
 Stax2 API is implemented natively by following Stax XML implementations:
 
- * [Woodstox](http://wiki.fasterxml.com/WoodstoxHome)
- * [Aalto](https://github.com/FasterXML/aalto-xml)
+ * [Aalto](../../../aalto-xml) (performance-oriented, also non-blocking/async)
+ * [Woodstox](../../../woodstox) (full-featured, most compliant XML package on Java platform)
 
 In addition, Stax2 API contains wrapper implementations that can be used to support most of API on
 regular Stax implementations like Sun SJSXP (default Stax implementation bundled with JDK 1.6 and 1.7).
@@ -32,7 +37,7 @@ Maven dependency is defined as:
     <dependency>
       <groupId>org.codehaus.woodstox</groupId>
       <artifactId>stax2-api</artifactId>
-      <version>3.1.2</version>
+      <version>3.1.4</version>
     </dependency>
 
 Jars can be found from [Central Maven repo](http://repo1.maven.org/maven2/org/codehaus/woodstox/stax2-api/).
diff --git a/pom.xml b/pom.xml
@@ -2,30 +2,28 @@
 <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
   <modelVersion>4.0.0</modelVersion> 
   <parent>
-    <groupId>org.sonatype.oss</groupId>
-    <artifactId>oss-parent</artifactId>
-    <version>7</version>
+      <groupId>com.fasterxml</groupId>
+      <artifactId>oss-parent</artifactId>
+      <version>32</version>
   </parent>
   <groupId>org.codehaus.woodstox</groupId>
   <artifactId>stax2-api</artifactId>
   <name>Stax2 API</name>
-  <version>3.1.5-SNAPSHOT</version>
+  <version>4.2-SNAPSHOT</version>
   <packaging>bundle</packaging>
   <description>tax2 API is an extension to basic Stax 1.0 API that adds significant new functionality, such as full-featured bi-direction validation interface and high-performance Typed Access API.
   </description>
-  <url>http://wiki.fasterxml.com/WoodstoxStax2</url>
-  <scm>
-    <connection>scm:git:git@github.com:FasterXML/stax2-api.git</connection>
-    <developerConnection>scm:git:git@github.com:FasterXML/stax2-api.git</developerConnection>
-    <url>http://github.com/FasterXML/stax2-api</url>    
-    <tag>HEAD</tag>
-  </scm>
+  <url>http://github.com/FasterXML/stax2-api</url>
+  <organization>
+    <name>fasterxml.com</name>
+    <url>http://fasterxml.com</url>
+  </organization>
   <developers>
-        <developer>
-            <id>tatu</id>
-            <name>Tatu Saloranta</name>
-            <email>tatu@fasterxml.com</email>
-        </developer>
+     <developer>
+       <id>tatu</id>
+       <name>Tatu Saloranta</name>
+       <email>tatu@fasterxml.com</email>
+     </developer>
   </developers>
   <licenses>
     <license>
@@ -34,75 +32,51 @@
       <distribution>repo</distribution>
     </license>
   </licenses>
-  <organization>
-    <name>fasterxml.com</name>
-    <url>http://fasterxml.com</url>
-  </organization>
+  <scm>
+    <connection>scm:git:git@github.com:FasterXML/stax2-api.git</connection>
+    <developerConnection>scm:git:git@github.com:FasterXML/stax2-api.git</developerConnection>
+    <url>http://github.com/FasterXML/stax2-api</url>    
+    <tag>HEAD</tag>
+  </scm>
+
+  <properties>
+      <!-- 1.6 baseline for 4.0 (earlier only required 1.5) -->
+      <javac.src.version>1.6</javac.src.version>
+      <javac.target.version>1.6</javac.target.version>
+
+      <!-- 4.1 adds "Automatic-Module-Name" for JDK 9 -->
+      <jdk.module.name>org.codehaus.stax2</jdk.module.name>
+  </properties>
 
   <dependencies>
-    <!-- Stax API jar is needed; 1.0-2 seems to be the last "official"
-         version prior to JDK 6 that bundles API
-      -->
+    <!-- With Java 6, already included: skip dependency
     <dependency>
       <groupId>javax.xml.stream</groupId>
       <artifactId>stax-api</artifactId>
       <version>1.0-2</version>
-      <!-- at this point, with inclusion in JDK 1.6, this should be given -->
       <scope>provided</scope>
     </dependency>
+    -->
   </dependencies>
 
   <build>
     <plugins>
-      <plugin>
-        <artifactId>maven-compiler-plugin</artifactId>
-        <version>2.5.1</version>
-        <configuration>
-          <source>1.5</source>
-          <target>1.5</target>
-          <showDeprecation>true</showDeprecation>
-          <showWarnings>true</showWarnings>
-          <optimize>true</optimize>
-          <!-- 16-Apr-2013, tatu: As per Nick W's suggestions, let's
-              use these to reduce jar size
-            -->
-          <debug>true</debug>
-          <debuglevel>lines,source</debuglevel>
-        </configuration>
-      </plugin>
         <plugin>
             <groupId>org.apache.maven.plugins</groupId>
             <artifactId>maven-release-plugin</artifactId>
-            <version>2.4.1</version>
             <configuration>
                 <mavenExecutorId>forked-path</mavenExecutorId>
             </configuration>
         </plugin>
-        <plugin><!-- plug-in to attach source bundle in repo -->
-          <groupId>org.apache.maven.plugins</groupId>
-          <artifactId>maven-source-plugin</artifactId>
-          <version>2.1.2</version>
-          <executions>
-            <execution>
-              <id>attach-sources</id>
-              <goals>
-                <goal>jar</goal>
-              </goals>
-            </execution>
-          </executions>
-        </plugin>
         <plugin>
           <groupId>org.apache.maven.plugins</groupId>
           <artifactId>maven-javadoc-plugin</artifactId>
-          <version>2.6.1</version>
-          <!-- 06-Jul-2013, tatu: When can we switch to 1.6?
-            -->
           <configuration>
-            <source>1.5</source>
-            <target>1.5</target>
+            <source>1.6</source>
+            <target>1.6</target>
             <encoding>UTF-8</encoding>
             <links>
-              <link>http://java.sun.com/javase/6/docs/api/</link>
+              <link>https://docs.oracle.com/javase/8/docs/api/</link>
             </links>
           </configuration>
           <executions>
@@ -119,10 +93,10 @@
         <plugin>
           <groupId>org.apache.felix</groupId>
           <artifactId>maven-bundle-plugin</artifactId>
-          <version>2.3.7</version>
           <extensions>true</extensions>
           <configuration>
             <instructions>
+              <Automatic-Module-Name>${jdk.module.name}</Automatic-Module-Name>
               <Bundle-SymbolicName>${project.artifactId}</Bundle-SymbolicName>
               <Bundle-Vendor>fasterml.com</Bundle-Vendor>
               <Import-Package>

diff --git a/release-notes/VERSION b/release-notes/VERSION
@@ -4,8 +4,15 @@ Project: Stax2 API
 = Releases
 ------------------------------------------------------------------------
 
-3.1.5:
+4.1 (not yet released)
 
+- Add `Automatic-Module-Name` for Java 9
+- Upgrade JDK baseline requirement Java 6 (from Java 5);
+  remove `stax-api` dependency (since bundled on Java 6)
+
+4.0.0: (01-Feb-2015)
+
+- Update codebase to Java5 (add generics); minor related cleanup.
 #3: Add LICENSE file that indicates BSD (2-clause) as the license
 
 3.1.4 (28-Feb-2014)

diff --git a/src/main/java/org/codehaus/stax2/LocationInfo.java b/src/main/java/org/codehaus/stax2/LocationInfo.java
@@ -19,9 +19,9 @@
 public interface LocationInfo
 {
     /*
-    /////////////////////////////////////////////////////
-    // Low-level extended "raw" location access methods
-    /////////////////////////////////////////////////////
+    /**********************************************************************
+    /* Low-level extended "raw" location access methods
+    /**********************************************************************
      */
 
     /**
@@ -105,9 +105,9 @@ public long getEndingCharOffset()
         throws XMLStreamException;
 
     /*
-    /////////////////////////////////////////////////////
-    // Object-oriented location access methods
-    /////////////////////////////////////////////////////
+    /**********************************************************************
+    /* Object-oriented location access methods
+    /**********************************************************************
      */
 
     // // // Existing method from XMLStreamReader:

diff --git a/src/main/java/org/codehaus/stax2/XMLEventReader2.java b/src/main/java/org/codehaus/stax2/XMLEventReader2.java
@@ -25,10 +25,10 @@ public interface XMLEventReader2
     public boolean hasNextEvent() throws XMLStreamException;
 
     /*
-    ///////////////////////////////////////////////////////////
-    // Configuration
-    ///////////////////////////////////////////////////////////
-    */
+    /**********************************************************************
+    /* Configuration
+    /**********************************************************************
+     */
 
     /**
      * Method similar to {@link javax.xml.stream.XMLInputFactory#isPropertySupported}, used
@@ -56,7 +56,7 @@ public interface XMLEventReader2
      * @return True, if the specified property was <b>succesfully</b>
      *    set to specified value; false if its value was not changed
      *
-     * @throws InvalidArgumentException if the property is not supported
+     * @throws IllegalArgumentException if the property is not supported
      *   (or recognized) by the stream reader implementation
      *
      * @since 3.0

diff --git a/src/main/java/org/codehaus/stax2/XMLInputFactory2.java b/src/main/java/org/codehaus/stax2/XMLInputFactory2.java
@@ -14,7 +14,7 @@
  * recognize, and preferably support. There are also some profile-based
  * configuration methods which allow implementations to set proper goal-based
  * values for custom properties.
- *<br />
+ *<br>
  * NOTE: although actual values for the property names are
  * visible, implementations should try to use the symbolic constants
  * defined here instead, to avoid typos.
@@ -27,9 +27,9 @@ public abstract class XMLInputFactory2
     implements XMLStreamProperties
 {
     /*
-    ///////////////////////////////////////////////////////////
-    // We share some options with other factories
-    ///////////////////////////////////////////////////////////
+    /**********************************************************************
+    /* We share some options with other factories
+    /**********************************************************************
      */
 
     //public final static String XSP_IMPLEMENTATION_NAME
@@ -41,9 +41,9 @@ public abstract class XMLInputFactory2
     //public final static String XSP_SUPPORT_XMLID
 
     /*
-    ///////////////////////////////////////////////////////////
-    // Additional standard configuration properties
-    ///////////////////////////////////////////////////////////
+    /**********************************************************************
+    /* Additional standard configuration properties
+    /**********************************************************************
      */
 
     // // // Parsing settings
@@ -169,9 +169,9 @@ public abstract class XMLInputFactory2
     public final static String P_DTD_OVERRIDE = "org.codehaus.stax2.propDtdOverride";
 
     /*
-    ///////////////////////////////////////////////////////////
-    // Life-cycle
-    ///////////////////////////////////////////////////////////
+    /**********************************************************************
+    /* Life-cycle
+    /**********************************************************************
      */
 
     protected XMLInputFactory2() {
@@ -214,9 +214,9 @@ public abstract XMLStreamReader2 createXMLStreamReader(File f)
         throws XMLStreamException;
 
     /*
-    ///////////////////////////////////////////////////////////
-    // Configuring using profiles
-    ///////////////////////////////////////////////////////////
+    /**********************************************************************
+    /* Configuring using profiles
+    /**********************************************************************
      */
 
     /**

diff --git a/src/main/java/org/codehaus/stax2/XMLOutputFactory2.java b/src/main/java/org/codehaus/stax2/XMLOutputFactory2.java
@@ -16,7 +16,7 @@
  * Also contains extended standard properties that conforming stream
  * writer factory and instance implementations should at least
  * recognize, and preferably support.
- *<br />
+ *<br>
  * NOTE: although actual values for the property names are
  * visible, implementations should try to use the symbolic constants
  * defined here instead, to avoid typos.
@@ -27,15 +27,15 @@
  * Whether output classes should keep track of and output namespace
  * information provided via write methods.
  * When enabled (set to Boolean.TRUE), will use all namespace information
- * provided, and does not allow colons in names (local name, prefix).<br />
+ * provided, and does not allow colons in names (local name, prefix).<br>
  * What exactly is kept track
  * of depends on other settings, specifically whether
  * writer is in "repairing" mode or not.
  * When disabled, will only make use of local name part, which
  * may contain colons, and ignore prefix and namespace URI if any
- * are passed.<br />
+ * are passed.<br>
  * Turning this option off may improve performance if no namespace
- * handling is needed.<br />
+ * handling is needed.<br>
  * Default value for implementations should be 'true'; implementations
  * are not required to implement 'false'.
  *  </li>
@@ -51,9 +51,9 @@ public abstract class XMLOutputFactory2
     implements XMLStreamProperties
 {
     /*
-    ///////////////////////////////////////////////////////////
-    // We share some options with other factories
-    ///////////////////////////////////////////////////////////
+    /**********************************************************************
+    /* We share some options with other factories
+    /**********************************************************************
      */
 
     //public final static String XSP_IMPLEMENTATION_NAME
@@ -62,9 +62,9 @@ public abstract class XMLOutputFactory2
     //public final static String XSP_PROBLEM_REPORTER
 
     /*
-    ///////////////////////////////////////////////////////////
-    // Additional standard configuration properties
-    ///////////////////////////////////////////////////////////
+    /**********************************************************************
+    /* Additional standard configuration properties
+    /**********************************************************************
      */
 
     // // General output options:
@@ -138,9 +138,9 @@ public abstract class XMLOutputFactory2
     public final static String P_ATTR_VALUE_ESCAPER = "org.codehaus.stax2.attrValueEscaper";
 
     /*
-    ///////////////////////////////////////////////////////////
-    // Life-cycle
-    ///////////////////////////////////////////////////////////
+    /**********************************************************************
+    /* Life-cycle
+    /**********************************************************************
      */
 
     protected XMLOutputFactory2() {
@@ -158,9 +158,9 @@ public abstract XMLStreamWriter2 createXMLStreamWriter(Writer w, String encoding
         throws XMLStreamException;
 
     /*
-    ///////////////////////////////////////////////////////////
-    // Configuring using profiles
-    ///////////////////////////////////////////////////////////
+    /**********************************************************************
+    /* Configuring using profiles
+    /**********************************************************************
      */
 
     /**