Author: hboutemy
Date: Mon Jun 13 14:53:55 2011
New Revision: 1135120
URL: http://svn.apache.org/viewvc?rev=1135120&view=rev
Log:
added WriterFactory and XmlStreamWriter
Added:
maven/sandbox/trunk/plexus-utils-commons-bridge/plexus-utils-commons-bridge/src/main/java/org/codehaus/plexus/util/WriterFactory.java
(with props)
maven/sandbox/trunk/plexus-utils-commons-bridge/plexus-utils-commons-bridge/src/main/java/org/codehaus/plexus/util/xml/
maven/sandbox/trunk/plexus-utils-commons-bridge/plexus-utils-commons-bridge/src/main/java/org/codehaus/plexus/util/xml/XmlStreamWriter.java
(with props)
maven/sandbox/trunk/plexus-utils-commons-bridge/plexus-utils-tck/src/test/java/org/codehaus/plexus/util/xml/
maven/sandbox/trunk/plexus-utils-commons-bridge/plexus-utils-tck/src/test/java/org/codehaus/plexus/util/xml/XmlStreamWriterTest.java
(with props)
Added:
maven/sandbox/trunk/plexus-utils-commons-bridge/plexus-utils-commons-bridge/src/main/java/org/codehaus/plexus/util/WriterFactory.java
URL:
http://svn.apache.org/viewvc/maven/sandbox/trunk/plexus-utils-commons-bridge/plexus-utils-commons-bridge/src/main/java/org/codehaus/plexus/util/WriterFactory.java?rev=1135120&view=auto
==============================================================================
---
maven/sandbox/trunk/plexus-utils-commons-bridge/plexus-utils-commons-bridge/src/main/java/org/codehaus/plexus/util/WriterFactory.java
(added)
+++
maven/sandbox/trunk/plexus-utils-commons-bridge/plexus-utils-commons-bridge/src/main/java/org/codehaus/plexus/util/WriterFactory.java
Mon Jun 13 14:53:55 2011
@@ -0,0 +1,179 @@
+package org.codehaus.plexus.util;
+
+/*
+ * 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.
+ */
+
+import java.io.File;
+import java.io.FileNotFoundException;
+import java.io.FileOutputStream;
+import java.io.FileWriter;
+import java.io.IOException;
+import java.io.OutputStream;
+import java.io.OutputStreamWriter;
+import java.io.UnsupportedEncodingException;
+import java.io.Writer;
+import java.nio.charset.Charset;
+
+import org.codehaus.plexus.util.xml.XmlStreamWriter;
+
+/**
+ * Utility to create Writers, with explicit encoding choice: platform default,
+ * XML, or specified.
+ *
+ * @author <a href="mailto:hbout...@apache.org";>Hervé 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
+ */
+public class WriterFactory
+{
+ /**
+ * ISO Latin Alphabet #1, also known as ISO-LATIN-1.
+ * Every implementation of the Java platform is required to support this
character encoding.
+ * @see Charset
+ */
+ public static final String ISO_8859_1 = "ISO-8859-1";
+
+ /**
+ * Seven-bit ASCII, also known as ISO646-US, also known as the Basic Latin
block of the Unicode character set.
+ * Every implementation of the Java platform is required to support this
character encoding.
+ * @see Charset
+ */
+ public static final String US_ASCII = "US-ASCII";
+
+ /**
+ * Sixteen-bit Unicode Transformation Format, byte order specified by a
mandatory initial byte-order mark (either
+ * order accepted on input, big-endian used on output).
+ * Every implementation of the Java platform is required to support this
character encoding.
+ * @see Charset
+ */
+ public static final String UTF_16 = "UTF-16";
+
+ /**
+ * Sixteen-bit Unicode Transformation Format, big-endian byte order.
+ * Every implementation of the Java platform is required to support this
character encoding.
+ * @see Charset
+ */
+ public static final String UTF_16BE = "UTF-16BE";
+
+ /**
+ * Sixteen-bit Unicode Transformation Format, little-endian byte order.
+ * Every implementation of the Java platform is required to support this
character encoding.
+ * @see Charset
+ */
+ public static final String UTF_16LE = "UTF-16LE";
+
+ /**
+ * Eight-bit Unicode Transformation Format.
+ * Every implementation of the Java platform is required to support this
character encoding.
+ * @see Charset
+ */
+ public static final String UTF_8 = "UTF-8";
+
+ /**
+ * The <code>file.encoding</code> System Property.
+ */
+ 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.
+ *
+ * @param out not null output stream.
+ * @return a writer instance for the output stream using the default
platform charset.
+ * @throws IOException if any.
+ * @see Charset#defaultCharset()
+ */
+ public static Writer newPlatformWriter( OutputStream out )
+ {
+ return new OutputStreamWriter( out );
+ }
+
+ /**
+ * Create a new Writer with default platform encoding.
+ *
+ * @param file not null file.
+ * @return a writer instance for the output file using the default
platform charset.
+ * @throws IOException if any.
+ * @see Charset#defaultCharset()
+ */
+ public static Writer newPlatformWriter( File file )
+ throws IOException
+ {
+ return new FileWriter( file );
+ }
+
+ /**
+ * Create a new Writer with specified encoding.
+ *
+ * @param out not null output stream.
+ * @param encoding not null supported encoding.
+ * @return a writer instance for the output stream using the given
encoding.
+ * @throws UnsupportedEncodingException if any.
+ * @see <a
href="http://java.sun.com/j2se/1.4.2/docs/guide/intl/encoding.doc.html";>Supported
encodings</a>
+ */
+ public static Writer newWriter( OutputStream out, String encoding )
+ throws UnsupportedEncodingException
+ {
+ return new OutputStreamWriter( out, encoding );
+ }
+
+ /**
+ * Create a new Writer with specified encoding.
+ *
+ * @param file not null file.
+ * @param encoding not null supported encoding.
+ * @return a writer instance for the output file using the given encoding.
+ * @throws UnsupportedEncodingException if any.
+ * @throws FileNotFoundException if any.
+ * @see <a
href="http://java.sun.com/j2se/1.4.2/docs/guide/intl/encoding.doc.html";>Supported
encodings</a>
+ */
+ public static Writer newWriter( File file, String encoding )
+ throws UnsupportedEncodingException, FileNotFoundException
+ {
+ return newWriter( new FileOutputStream( file ), encoding );
+ }
+}
Propchange:
maven/sandbox/trunk/plexus-utils-commons-bridge/plexus-utils-commons-bridge/src/main/java/org/codehaus/plexus/util/WriterFactory.java
------------------------------------------------------------------------------
svn:eol-style = native
Propchange:
maven/sandbox/trunk/plexus-utils-commons-bridge/plexus-utils-commons-bridge/src/main/java/org/codehaus/plexus/util/WriterFactory.java
------------------------------------------------------------------------------
svn:keywords = Author Date Id Revision
Propchange:
maven/sandbox/trunk/plexus-utils-commons-bridge/plexus-utils-commons-bridge/src/main/java/org/codehaus/plexus/util/WriterFactory.java
------------------------------------------------------------------------------
svn:mime-type = text/plain
Added:
maven/sandbox/trunk/plexus-utils-commons-bridge/plexus-utils-commons-bridge/src/main/java/org/codehaus/plexus/util/xml/XmlStreamWriter.java
URL:
http://svn.apache.org/viewvc/maven/sandbox/trunk/plexus-utils-commons-bridge/plexus-utils-commons-bridge/src/main/java/org/codehaus/plexus/util/xml/XmlStreamWriter.java?rev=1135120&view=auto
==============================================================================
---
maven/sandbox/trunk/plexus-utils-commons-bridge/plexus-utils-commons-bridge/src/main/java/org/codehaus/plexus/util/xml/XmlStreamWriter.java
(added)
+++
maven/sandbox/trunk/plexus-utils-commons-bridge/plexus-utils-commons-bridge/src/main/java/org/codehaus/plexus/util/xml/XmlStreamWriter.java
Mon Jun 13 14:53:55 2011
@@ -0,0 +1,40 @@
+package org.codehaus.plexus.util.xml;
+
+/*
+ * 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.
+ */
+
+import java.io.File;
+import java.io.FileNotFoundException;
+import java.io.OutputStream;
+
+@Deprecated
+public class XmlStreamWriter
+ extends org.apache.commons.io.output.XmlStreamWriter
+{
+ public XmlStreamWriter( OutputStream out )
+ {
+ super( out );
+ }
+
+ public XmlStreamWriter( File file )
+ throws FileNotFoundException
+ {
+ super( file );
+ }
+}
Propchange:
maven/sandbox/trunk/plexus-utils-commons-bridge/plexus-utils-commons-bridge/src/main/java/org/codehaus/plexus/util/xml/XmlStreamWriter.java
------------------------------------------------------------------------------
svn:eol-style = native
Propchange:
maven/sandbox/trunk/plexus-utils-commons-bridge/plexus-utils-commons-bridge/src/main/java/org/codehaus/plexus/util/xml/XmlStreamWriter.java
------------------------------------------------------------------------------
svn:keywords = Author Date Id Revision
Propchange:
maven/sandbox/trunk/plexus-utils-commons-bridge/plexus-utils-commons-bridge/src/main/java/org/codehaus/plexus/util/xml/XmlStreamWriter.java
------------------------------------------------------------------------------
svn:mime-type = text/plain
Added:
maven/sandbox/trunk/plexus-utils-commons-bridge/plexus-utils-tck/src/test/java/org/codehaus/plexus/util/xml/XmlStreamWriterTest.java
URL:
http://svn.apache.org/viewvc/maven/sandbox/trunk/plexus-utils-commons-bridge/plexus-utils-tck/src/test/java/org/codehaus/plexus/util/xml/XmlStreamWriterTest.java?rev=1135120&view=auto
==============================================================================
---
maven/sandbox/trunk/plexus-utils-commons-bridge/plexus-utils-tck/src/test/java/org/codehaus/plexus/util/xml/XmlStreamWriterTest.java
(added)
+++
maven/sandbox/trunk/plexus-utils-commons-bridge/plexus-utils-tck/src/test/java/org/codehaus/plexus/util/xml/XmlStreamWriterTest.java
Mon Jun 13 14:53:55 2011
@@ -0,0 +1,159 @@
+package org.codehaus.plexus.util.xml;
+
+/*
+ * 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.
+ */
+
+import java.io.ByteArrayOutputStream;
+import java.io.IOException;
+
+import junit.framework.TestCase;
+
+/**
+ *
+ * @author <a href="mailto:hbout...@apache.org";>Hervé Boutemy</a>
+ */
+public class XmlStreamWriterTest
+ extends TestCase
+{
+ /** french */
+ private static final String TEXT_LATIN1 = "eacute: \u00E9";
+ /** greek */
+ private static final String TEXT_LATIN7 = "alpha: \u03B1";
+ /** euro support */
+ private static final String TEXT_LATIN15 = "euro: \u20AC";
+ /** japanese */
+ private static final String TEXT_EUC_JP = "hiragana A: \u3042";
+ /** Unicode: support everything */
+ private static final String TEXT_UNICODE =
+ TEXT_LATIN1 + ", " +
+ TEXT_LATIN7 + ", " +
+ TEXT_LATIN15 + ", " +
+ TEXT_EUC_JP;
+
+ private static String createXmlContent( String text, String encoding )
+ {
+ String xmlDecl = "<?xml version=\"1.0\"?>";
+ if ( encoding != null )
+ {
+ xmlDecl = "<?xml version=\"1.0\" encoding=\"" + encoding + "\"?>";
+ }
+ String xml = xmlDecl + "\n<text>" + text + "</text>";
+ return xml;
+ }
+
+ private static void checkXmlContent( String xml, String encoding )
+ throws IOException
+ {
+ ByteArrayOutputStream out = new ByteArrayOutputStream();
+ XmlStreamWriter writer = new XmlStreamWriter( out );
+ writer.write( xml );
+ writer.close();
+ byte[] xmlContent = out.toByteArray();
+ String result = new String( xmlContent, encoding );
+ assertEquals( xml, result );
+ }
+
+ private static void checkXmlWriter( String text, String encoding )
+ throws IOException
+ {
+ String xml = createXmlContent( text, encoding );
+ String effectiveEncoding = ( encoding == null ) ? "UTF-8" : encoding;
+ checkXmlContent( xml, effectiveEncoding );
+ }
+
+ public void testNoXmlHeader()
+ throws IOException
+ {
+ String xml = "<text>text with no XML header</text>";
+ checkXmlContent( xml, "UTF-8" );
+ }
+
+ public void testEmpty()
+ throws IOException
+ {
+ ByteArrayOutputStream out = new ByteArrayOutputStream();
+ XmlStreamWriter writer = new XmlStreamWriter( out );
+ writer.flush();
+ writer.write( "" );
+ writer.flush();
+ writer.write( "." );
+ writer.flush();
+ writer.close();
+ }
+
+ public void testDefaultEncoding()
+ throws IOException
+ {
+ checkXmlWriter( TEXT_UNICODE, null );
+ }
+
+ public void testUTF8Encoding()
+ throws IOException
+ {
+ checkXmlWriter( TEXT_UNICODE, "UTF-8" );
+ }
+
+ public void testUTF16Encoding()
+ throws IOException
+ {
+ checkXmlWriter( TEXT_UNICODE, "UTF-16" );
+ }
+
+ public void testUTF16BEEncoding()
+ throws IOException
+ {
+ checkXmlWriter( TEXT_UNICODE, "UTF-16BE" );
+ }
+
+ public void testUTF16LEEncoding()
+ throws IOException
+ {
+ checkXmlWriter( TEXT_UNICODE, "UTF-16LE" );
+ }
+
+ public void testLatin1Encoding()
+ throws IOException
+ {
+ checkXmlWriter( TEXT_LATIN1, "ISO-8859-1" );
+ }
+
+ public void testLatin7Encoding()
+ throws IOException
+ {
+ checkXmlWriter( TEXT_LATIN7, "ISO-8859-7" );
+ }
+
+ public void testLatin15Encoding()
+ throws IOException
+ {
+ checkXmlWriter( TEXT_LATIN15, "ISO-8859-15" );
+ }
+
+ public void testEUC_JPEncoding()
+ throws IOException
+ {
+ checkXmlWriter( TEXT_EUC_JP, "EUC-JP" );
+ }
+
+ public void testEBCDICEncoding()
+ throws IOException
+ {
+ checkXmlWriter( "simple text in EBCDIC", "CP1047" );
+ }
+}
Propchange:
maven/sandbox/trunk/plexus-utils-commons-bridge/plexus-utils-tck/src/test/java/org/codehaus/plexus/util/xml/XmlStreamWriterTest.java
------------------------------------------------------------------------------
svn:eol-style = native
Propchange:
maven/sandbox/trunk/plexus-utils-commons-bridge/plexus-utils-tck/src/test/java/org/codehaus/plexus/util/xml/XmlStreamWriterTest.java
------------------------------------------------------------------------------
svn:keywords = Author Date Id Revision
Propchange:
maven/sandbox/trunk/plexus-utils-commons-bridge/plexus-utils-tck/src/test/java/org/codehaus/plexus/util/xml/XmlStreamWriterTest.java
------------------------------------------------------------------------------
svn:mime-type = text/plain
