javax.xml.soap.SOAPElementFactory Maven / Gradle / Ivy
/*
* 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 javax.xml.soap;
/**
* SOAPElementFactory is a factory for XML fragments that will eventually end up in
* the SOAP part. These fragments can be inserted as children of the SOAPHeader or
* SOAPBody or SOAPEnvelope.
*
* 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.
*
* @see SOAPFactory SOAPFactory
* @deprecated - Use javax.xml.soap.SOAPFactory for creating SOAPElements.
*/
public class SOAPElementFactory {
/**
* Create a new SOAPElementFactory from a SOAPFactory.
*
* @param soapfactory the SOAPFactory to use
*/
private SOAPElementFactory(SOAPFactory soapfactory) {
sf = soapfactory;
}
/**
* Create a SOAPElement object initialized with the given Name
* object.
*
* @param name a Name object with the XML name for the new element
* @return the new SOAPElement object that was created
* @throws SOAPException if there is an error in creating the SOAPElement object
* @see SOAPFactory#createElement(Name) SOAPFactory.createElement(javax.xml.soap.Name)
* @deprecated Use javax.xml.soap.SOAPFactory.createElement(javax.xml.soap.Name) instead
*/
public SOAPElement create(Name name) throws SOAPException {
return sf.createElement(name);
}
/**
* Create a SOAPElement object initialized with the given local name.
*
* @param localName a String giving the local name for the new element
* @return the new SOAPElement object that was created
* @throws SOAPException if there is an error in creating the SOAPElement object
* @see SOAPFactory#createElement(String) SOAPFactory.createElement(java.lang.String)
* @deprecated Use javax.xml.soap.SOAPFactory.createElement(String localName) instead
*/
public SOAPElement create(String localName) throws SOAPException {
return sf.createElement(localName);
}
/**
* Create a new SOAPElement object with the given local name, prefix and uri.
*
* @param localName a String giving the local name for the new element
* @param prefix the prefix for this SOAPElement
* @param uri a String giving the URI of the namespace to which the new
* element belongs
* @return the new SOAPElement object that was created
* @throws SOAPException if there is an error in creating the SOAPElement object
* @see SOAPFactory#createElement(String, String, String)
* SOAPFactory.createElement(java.lang.String, java.lang.String, java.lang.String)
* @deprecated Use javax.xml.soap.SOAPFactory.createElement(String localName, String prefix,
* String uri) instead
*/
public SOAPElement create(String localName, String prefix, String uri)
throws SOAPException {
return sf.createElement(localName, prefix, uri);
}
/**
* Creates a new instance of SOAPElementFactory.
*
* @return a new instance of a SOAPElementFactory
* @throws SOAPException if there was an error creating the default SOAPElementFactory
*/
public static SOAPElementFactory newInstance() throws SOAPException {
try {
return new SOAPElementFactory(SOAPFactory.newInstance());
} catch (Exception exception) {
throw new SOAPException("Unable to create SOAP Element Factory: "
+ exception.getMessage());
}
}
private SOAPFactory sf;
}