src/share/jaxws_classes/javax/xml/soap/SOAPElementFactory.java

Fri, 04 Oct 2013 16:21:34 +0100

author
mkos
date
Fri, 04 Oct 2013 16:21:34 +0100
changeset 408
b0610cd08440
parent 368
0989ad8c0860
child 637
9c07ef4934dd
permissions
-rw-r--r--

8025054: Update JAX-WS RI integration to 2.2.9-b130926.1035
Reviewed-by: chegar

ohair@286 1 /*
alanb@368 2 * Copyright (c) 2004, 2012, Oracle and/or its affiliates. All rights reserved.
ohair@286 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
ohair@286 4 *
ohair@286 5 * This code is free software; you can redistribute it and/or modify it
ohair@286 6 * under the terms of the GNU General Public License version 2 only, as
ohair@286 7 * published by the Free Software Foundation. Oracle designates this
ohair@286 8 * particular file as subject to the "Classpath" exception as provided
ohair@286 9 * by Oracle in the LICENSE file that accompanied this code.
ohair@286 10 *
ohair@286 11 * This code is distributed in the hope that it will be useful, but WITHOUT
ohair@286 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
ohair@286 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
ohair@286 14 * version 2 for more details (a copy is included in the LICENSE file that
ohair@286 15 * accompanied this code).
ohair@286 16 *
ohair@286 17 * You should have received a copy of the GNU General Public License version
ohair@286 18 * 2 along with this work; if not, write to the Free Software Foundation,
ohair@286 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
ohair@286 20 *
ohair@286 21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
ohair@286 22 * or visit www.oracle.com if you need additional information or have any
ohair@286 23 * questions.
ohair@286 24 */
ohair@286 25
ohair@286 26 package javax.xml.soap;
ohair@286 27
ohair@286 28 /**
ohair@286 29 * <code>SOAPElementFactory</code> is a factory for XML fragments that
ohair@286 30 * will eventually end up in the SOAP part. These fragments
ohair@286 31 * can be inserted as children of the <code>SOAPHeader</code> or
ohair@286 32 * <code>SOAPBody</code> or <code>SOAPEnvelope</code>.
ohair@286 33 *
ohair@286 34 * <p>Elements created using this factory do not have the properties
ohair@286 35 * of an element that lives inside a SOAP header document. These
ohair@286 36 * elements are copied into the XML document tree when they are
ohair@286 37 * inserted.
ohair@286 38 * @deprecated - Use <code>javax.xml.soap.SOAPFactory</code> for creating SOAPElements.
ohair@286 39 * @see javax.xml.soap.SOAPFactory
ohair@286 40 */
ohair@286 41 public class SOAPElementFactory {
ohair@286 42
ohair@286 43 private SOAPFactory soapFactory;
ohair@286 44
ohair@286 45 private SOAPElementFactory(SOAPFactory soapFactory) {
ohair@286 46 this.soapFactory = soapFactory;
ohair@286 47 }
ohair@286 48
ohair@286 49 /**
ohair@286 50 * Create a <code>SOAPElement</code> object initialized with the
ohair@286 51 * given <code>Name</code> object.
ohair@286 52 *
ohair@286 53 * @param name a <code>Name</code> object with the XML name for
ohair@286 54 * the new element
ohair@286 55 *
ohair@286 56 * @return the new <code>SOAPElement</code> object that was
ohair@286 57 * created
ohair@286 58 *
ohair@286 59 * @exception SOAPException if there is an error in creating the
ohair@286 60 * <code>SOAPElement</code> object
ohair@286 61 *
ohair@286 62 * @deprecated Use
ohair@286 63 * javax.xml.soap.SOAPFactory.createElement(javax.xml.soap.Name)
ohair@286 64 * instead
ohair@286 65 *
ohair@286 66 * @see javax.xml.soap.SOAPFactory#createElement(javax.xml.soap.Name)
ohair@286 67 * @see javax.xml.soap.SOAPFactory#createElement(javax.xml.namespace.QName)
ohair@286 68 */
ohair@286 69 public SOAPElement create(Name name) throws SOAPException {
ohair@286 70 return soapFactory.createElement(name);
ohair@286 71 }
ohair@286 72
ohair@286 73 /**
ohair@286 74 * Create a <code>SOAPElement</code> object initialized with the
ohair@286 75 * given local name.
ohair@286 76 *
ohair@286 77 * @param localName a <code>String</code> giving the local name for
ohair@286 78 * the new element
ohair@286 79 *
ohair@286 80 * @return the new <code>SOAPElement</code> object that was
ohair@286 81 * created
ohair@286 82 *
ohair@286 83 * @exception SOAPException if there is an error in creating the
ohair@286 84 * <code>SOAPElement</code> object
ohair@286 85 *
ohair@286 86 * @deprecated Use
ohair@286 87 * javax.xml.soap.SOAPFactory.createElement(String localName) instead
ohair@286 88 *
ohair@286 89 * @see javax.xml.soap.SOAPFactory#createElement(java.lang.String)
ohair@286 90 */
ohair@286 91 public SOAPElement create(String localName) throws SOAPException {
ohair@286 92 return soapFactory.createElement(localName);
ohair@286 93 }
ohair@286 94
ohair@286 95 /**
ohair@286 96 * Create a new <code>SOAPElement</code> object with the given
ohair@286 97 * local name, prefix and uri.
ohair@286 98 *
ohair@286 99 * @param localName a <code>String</code> giving the local name
ohair@286 100 * for the new element
ohair@286 101 * @param prefix the prefix for this <code>SOAPElement</code>
ohair@286 102 * @param uri a <code>String</code> giving the URI of the
ohair@286 103 * namespace to which the new element belongs
ohair@286 104 *
ohair@286 105 * @exception SOAPException if there is an error in creating the
ohair@286 106 * <code>SOAPElement</code> object
ohair@286 107 *
ohair@286 108 * @deprecated Use
ohair@286 109 * javax.xml.soap.SOAPFactory.createElement(String localName,
ohair@286 110 * String prefix,
ohair@286 111 * String uri)
ohair@286 112 * instead
ohair@286 113 *
ohair@286 114 * @see javax.xml.soap.SOAPFactory#createElement(java.lang.String, java.lang.String, java.lang.String)
ohair@286 115 */
ohair@286 116 public SOAPElement create(String localName, String prefix, String uri)
ohair@286 117 throws SOAPException {
ohair@286 118 return soapFactory.createElement(localName, prefix, uri);
ohair@286 119 }
ohair@286 120
ohair@286 121 /**
ohair@286 122 * Creates a new instance of <code>SOAPElementFactory</code>.
ohair@286 123 *
ohair@286 124 * @return a new instance of a <code>SOAPElementFactory</code>
ohair@286 125 *
ohair@286 126 * @exception SOAPException if there was an error creating the
ohair@286 127 * default <code>SOAPElementFactory</code>
ohair@286 128 */
ohair@286 129 public static SOAPElementFactory newInstance() throws SOAPException {
ohair@286 130 try {
ohair@286 131 return new SOAPElementFactory(SOAPFactory.newInstance());
ohair@286 132 } catch (Exception ex) {
ohair@286 133 throw new SOAPException(
ohair@286 134 "Unable to create SOAP Element Factory: " + ex.getMessage());
ohair@286 135 }
ohair@286 136 }
ohair@286 137 }

mercurial