Add dependency on plexus-xml to keep compatibility and deprecate the reader/writer factories with no direct replacement

Author: gnodet

pom.xml

@@ -55,6 +55,12 @@ limitations under the License.
   </properties>
 
   <dependencies>
+    <dependency>
+      <groupId>org.codehaus.plexus</groupId>
+      <artifactId>plexus-xml</artifactId>
+      <version>4.0.0-SNAPSHOT</version>
+      <optional>true</optional>
+    </dependency>
     <dependency>
       <groupId>junit</groupId>
       <artifactId>junit</artifactId>

src/main/java/org/codehaus/plexus/util/ReaderFactory.java

@@ -16,6 +16,8 @@
  * limitations under the License.
  */
 
+import org.codehaus.plexus.util.xml.XmlStreamReader;
+
 import java.io.File;
 import java.io.IOException;
 import java.io.InputStream;
@@ -29,13 +31,18 @@
 /**
  * Utility to create Readers from streams, with explicit encoding choice: platform default, XML, or specified.
  *
+ * @deprecated This class has been deprecated. When reading XML, users are encouraged to pass the {@code InputStream}
+ *             directory to the {@link org.codehaus.plexus.util.xml.pull.MXParser#setInput(InputStream, String)},
+ *             giving a {@code null} encoding to let the parser figure it out. For non xml usages, use the JDK
+ *             {@link Files} utility methods.
+ *
  * @author <a href="mailto:[email protected]">Herve Boutemy</a>
  * @see Charset
  * @see <a href="http://java.sun.com/j2se/1.4.2/docs/guide/intl/encoding.doc.html">Supported encodings</a>
  *
  * @since 1.4.3
- * @deprecated use org.codehaus.plexus.util.xml.ReaderFactory from plexus-xml 4
  */
+@Deprecated
 public class ReaderFactory
 {
     /**
@@ -92,6 +99,48 @@ public class ReaderFactory
      */
     public static final String FILE_ENCODING = System.getProperty( "file.encoding" );
 
+    /**
+     * Create a new Reader with XML encoding detection rules.
+     *
+     * @param in not null input stream.
+     * @return an XML reader instance for the input stream.
+     * @throws IOException if any.
+     * @see XmlStreamReader
+     */
+    public static XmlStreamReader newXmlReader( InputStream in )
+        throws IOException
+    {
+        return new XmlStreamReader( in );
+    }
+
+    /**
+     * Create a new Reader with XML encoding detection rules.
+     *
+     * @param file not null file.
+     * @return an XML reader instance for the input file.
+     * @throws IOException if any.
+     * @see XmlStreamReader
+     */
+    public static XmlStreamReader newXmlReader( File file )
+        throws IOException
+    {
+        return new XmlStreamReader( file );
+    }
+
+    /**
+     * Create a new Reader with XML encoding detection rules.
+     *
+     * @param url not null url.
+     * @return an XML reader instance for the input url.
+     * @throws IOException if any.
+     * @see XmlStreamReader
+     */
+    public static XmlStreamReader newXmlReader( URL url )
+        throws IOException
+    {
+        return new XmlStreamReader( url );
+    }
+
     /**
      * Create a new Reader with default platform encoding.
      *

src/main/java/org/codehaus/plexus/util/WriterFactory.java

@@ -16,6 +16,8 @@
  * limitations under the License.
  */
 
+import org.codehaus.plexus.util.xml.XmlStreamWriter;
+
 import java.io.File;
 import java.io.IOException;
 import java.io.OutputStream;
@@ -28,13 +30,16 @@
 /**
  * Utility to create Writers, with explicit encoding choice: platform default, XML, or specified.
  *
+ * @deprecated This class has been deprecated. When writing XML, users can create the {@link XmlStreamWriter} instance
+ *             directly. For other usages, using {@link Files} helper methods is recommended.
+ *
  * @author <a href="mailto:[email protected]">Herve Boutemy</a>
  * @see Charset
  * @see <a href="http://java.sun.com/j2se/1.4.2/docs/guide/intl/encoding.doc.html">Supported encodings</a>
  *
  * @since 1.4.4
- * @deprecated use org.codehaus.plexus.util.xml.WriterFactory from plexus-xml 4
  */
+@Deprecated
 public class WriterFactory
 {
     /**
@@ -91,6 +96,34 @@ public class WriterFactory
      */
     public static final String FILE_ENCODING = System.getProperty( "file.encoding" );
 
+    /**
+     * Create a new Writer with XML encoding detection rules.
+     *
+     * @param out not null output stream.
+     * @return an XML writer instance for the output stream.
+     * @throws IOException if any.
+     * @see XmlStreamWriter
+     */
+    public static XmlStreamWriter newXmlWriter( OutputStream out )
+        throws IOException
+    {
+        return new XmlStreamWriter( out );
+    }
+
+    /**
+     * Create a new Writer with XML encoding detection rules.
+     *
+     * @param file not null file.
+     * @return an XML writer instance for the output file.
+     * @throws IOException if any.
+     * @see XmlStreamWriter
+     */
+    public static XmlStreamWriter newXmlWriter(File file )
+        throws IOException
+    {
+        return new XmlStreamWriter( file );
+    }
+
     /**
      * Create a new Writer with default platform encoding.
      *