From: PJ Fanning <fanningpj@apache.org>
Date: Sat, 24 Jun 2017 13:53:47 +0000 (+0000)
Subject: expand StaxHelper
X-Git-Url: https://source.dussan.org/?a=commitdiff_plain;h=03d4e52bc0ca2ea939745fd8ace5b78ca1c4c811;p=poi.git

expand StaxHelper

git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@1799772 13f79535-47bb-0310-9956-ffa450edef68
---

diff --git a/src/java/org/apache/poi/util/StaxHelper.java b/src/java/org/apache/poi/util/StaxHelper.java
index ae526d73b7..8c0d284304 100644
--- a/src/java/org/apache/poi/util/StaxHelper.java
+++ b/src/java/org/apache/poi/util/StaxHelper.java
@@ -17,7 +17,9 @@
 
 package org.apache.poi.util;
 
+import javax.xml.stream.XMLEventFactory;
 import javax.xml.stream.XMLInputFactory;
+import javax.xml.stream.XMLOutputFactory;
 
 
 /**
@@ -39,6 +41,22 @@ public final class StaxHelper {
         trySetProperty(factory, XMLInputFactory.IS_SUPPORTING_EXTERNAL_ENTITIES, false);
         return factory;
     }
+
+    /**
+     * Creates a new StAX XMLOutputFactory, with sensible defaults
+     */
+    public static XMLOutputFactory newXMLOutputFactory() {
+        XMLOutputFactory factory = XMLOutputFactory.newFactory();
+        trySetProperty(factory, XMLOutputFactory.IS_REPAIRING_NAMESPACES, true);
+        return factory;
+    }
+
+    /**
+     * Creates a new StAX XMLEventFactory, with sensible defaults
+     */
+    public static XMLEventFactory newXMLEventFactory() {
+        return XMLEventFactory.newFactory();
+    }
             
     private static void trySetProperty(XMLInputFactory factory, String feature, boolean flag) {
         try {
@@ -49,4 +67,14 @@ public final class StaxHelper {
             logger.log(POILogger.WARN, "Cannot set StAX property because outdated StAX parser in classpath", feature, ame);
         }
     }
+
+    private static void trySetProperty(XMLOutputFactory factory, String feature, boolean flag) {
+        try {
+            factory.setProperty(feature, flag);
+        } catch (Exception e) {
+            logger.log(POILogger.WARN, "StAX Property unsupported", feature, e);
+        } catch (AbstractMethodError ame) {
+            logger.log(POILogger.WARN, "Cannot set StAX property because outdated StAX parser in classpath", feature, ame);
+        }
+    }
 }
diff --git a/src/testcases/org/apache/poi/util/TestStaxHelper.java b/src/testcases/org/apache/poi/util/TestStaxHelper.java
new file mode 100644
index 0000000000..9b781fd6fb
--- /dev/null
+++ b/src/testcases/org/apache/poi/util/TestStaxHelper.java
@@ -0,0 +1,64 @@
+/* ====================================================================
+   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.
+==================================================================== */
+
+package org.apache.poi.util;
+
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertNotNull;
+
+import javax.xml.stream.XMLInputFactory;
+import javax.xml.stream.XMLOutputFactory;
+import javax.xml.stream.XMLStreamException;
+
+import org.junit.Test;
+
+/**
+ * Unit test for StaxHelper
+ */
+public class TestStaxHelper {
+
+    /**
+     * test that newXMLInputFactory returns a factory with sensible defaults
+     */
+    @Test
+    public void testNewXMLInputFactory() throws XMLStreamException {
+        XMLInputFactory factory = StaxHelper.newXMLInputFactory();
+        assertEquals(true, factory.getProperty(XMLInputFactory.IS_NAMESPACE_AWARE));
+        assertEquals(false, factory.getProperty(XMLInputFactory.IS_VALIDATING));
+        assertEquals(false, factory.getProperty(XMLInputFactory.SUPPORT_DTD));
+        assertEquals(false, factory.getProperty(XMLInputFactory.IS_SUPPORTING_EXTERNAL_ENTITIES));
+    }
+
+    /**
+     * test that newXMLOutputFactory returns a factory with sensible defaults
+     */
+    @Test
+    public void testNewXMLOutputFactory() {
+        XMLOutputFactory factory = StaxHelper.newXMLOutputFactory();
+        assertEquals(true, factory.getProperty(XMLOutputFactory.IS_REPAIRING_NAMESPACES));
+    }
+
+    /**
+     * test that newXMLEventFactory returns a factory
+     */
+    @Test
+    public void testNewXMLEventFactory() {
+        assertNotNull(StaxHelper.newXMLEventFactory());
+    }
+
+}
+