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