jaxws/src/java.xml.soap/share/classes/javax/xml/soap/SOAPElementFactory.java
changeset 25871 b80b84e87032
parent 25840 c2002453eec3
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/jaxws/src/java.xml.soap/share/classes/javax/xml/soap/SOAPElementFactory.java	Sun Aug 17 15:52:15 2014 +0100
@@ -0,0 +1,138 @@
+/*
+ * Copyright (c) 2004, 2013, Oracle and/or its affiliates. All rights reserved.
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * This code is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 2 only, as
+ * published by the Free Software Foundation.  Oracle designates this
+ * particular file as subject to the "Classpath" exception as provided
+ * by Oracle in the LICENSE file that accompanied this code.
+ *
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+ * or visit www.oracle.com if you need additional information or have any
+ * questions.
+ */
+
+package javax.xml.soap;
+
+/**
+ * <code>SOAPElementFactory</code> is a factory for XML fragments that
+ * will eventually end up in the SOAP part. These fragments
+ * can be inserted as children of the <code>SOAPHeader</code> or
+ * <code>SOAPBody</code> or <code>SOAPEnvelope</code>.
+ *
+ * <p>Elements created using this factory do not have the properties
+ * of an element that lives inside a SOAP header document. These
+ * elements are copied into the XML document tree when they are
+ * inserted.
+ * @deprecated - Use <code>javax.xml.soap.SOAPFactory</code> for creating SOAPElements.
+ * @see javax.xml.soap.SOAPFactory
+ * @since 1.6
+ */
+public class SOAPElementFactory {
+
+    private SOAPFactory soapFactory;
+
+    private SOAPElementFactory(SOAPFactory soapFactory) {
+        this.soapFactory = soapFactory;
+    }
+
+    /**
+     * Create a <code>SOAPElement</code> object initialized with the
+     * given <code>Name</code> object.
+     *
+     * @param name a <code>Name</code> object with the XML name for
+     *             the new element
+     *
+     * @return the new <code>SOAPElement</code> object that was
+     *         created
+     *
+     * @exception SOAPException if there is an error in creating the
+     *            <code>SOAPElement</code> object
+     *
+     * @deprecated Use
+     * javax.xml.soap.SOAPFactory.createElement(javax.xml.soap.Name)
+     * instead
+     *
+     * @see javax.xml.soap.SOAPFactory#createElement(javax.xml.soap.Name)
+     * @see javax.xml.soap.SOAPFactory#createElement(javax.xml.namespace.QName)
+     */
+    public SOAPElement create(Name name) throws SOAPException {
+        return soapFactory.createElement(name);
+    }
+
+    /**
+     * Create a <code>SOAPElement</code> object initialized with the
+     * given local name.
+     *
+     * @param localName a <code>String</code> giving the local name for
+     *             the new element
+     *
+     * @return the new <code>SOAPElement</code> object that was
+     *         created
+     *
+     * @exception SOAPException if there is an error in creating the
+     *            <code>SOAPElement</code> object
+     *
+     * @deprecated Use
+     * javax.xml.soap.SOAPFactory.createElement(String localName) instead
+     *
+     * @see javax.xml.soap.SOAPFactory#createElement(java.lang.String)
+     */
+    public SOAPElement create(String localName) throws SOAPException {
+        return soapFactory.createElement(localName);
+    }
+
+    /**
+     * Create a new <code>SOAPElement</code> object with the given
+     * local name, prefix and uri.
+     *
+     * @param localName a <code>String</code> giving the local name
+     *                  for the new element
+     * @param prefix the prefix for this <code>SOAPElement</code>
+     * @param uri a <code>String</code> giving the URI of the
+     *            namespace to which the new element belongs
+     *
+     * @exception SOAPException if there is an error in creating the
+     *            <code>SOAPElement</code> object
+     *
+     * @deprecated Use
+     * javax.xml.soap.SOAPFactory.createElement(String localName,
+     *                      String prefix,
+     *                      String uri)
+     * instead
+     *
+     * @see javax.xml.soap.SOAPFactory#createElement(java.lang.String, java.lang.String, java.lang.String)
+     */
+    public SOAPElement create(String localName, String prefix, String uri)
+        throws SOAPException {
+        return soapFactory.createElement(localName, prefix, uri);
+    }
+
+    /**
+     * Creates a new instance of <code>SOAPElementFactory</code>.
+     *
+     * @return a new instance of a <code>SOAPElementFactory</code>
+     *
+     * @exception SOAPException if there was an error creating the
+     *            default <code>SOAPElementFactory</code>
+     */
+    public static SOAPElementFactory newInstance() throws SOAPException {
+        try {
+            return new SOAPElementFactory(SOAPFactory.newInstance());
+        } catch (Exception ex) {
+            throw new SOAPException(
+                "Unable to create SOAP Element Factory: " + ex.getMessage());
+        }
+    }
+}