--- old/src/java.xml.ws/share/classes/javax/xml/soap/SOAPFactory.java 2015-07-09 12:13:59.000000000 +0200
+++ new/src/java.xml.ws/share/classes/javax/xml/soap/SOAPFactory.java 2015-07-09 12:13:59.000000000 +0200
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 2004, 2013, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2004, 2015, 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
@@ -30,18 +30,18 @@
import org.w3c.dom.Element;
/**
- * SOAPFactory
is a factory for creating various objects
+ * {@code SOAPFactory} is a factory for creating various objects
* that exist in the SOAP XML tree.
- * SOAPFactory
can be
+ * {@code SOAPFactory} can be
* used to create XML fragments that will eventually end up in the
* SOAP part. These fragments can be inserted as children of the
* {@link SOAPHeaderElement} or {@link SOAPBodyElement} or
* {@link SOAPEnvelope} or other {@link SOAPElement} objects.
*
- * SOAPFactory
also has methods to create
- * javax.xml.soap.Detail
objects as well as
- * java.xml.soap.Name
objects.
+ * {@code SOAPFactory} also has methods to create
+ * {@code javax.xml.soap.Detail} objects as well as
+ * {@code java.xml.soap.Name} objects.
*
* @since 1.6
*/
@@ -49,34 +49,34 @@
/**
* A constant representing the property used to lookup the name of
- * a SOAPFactory
implementation class.
+ * a {@code SOAPFactory} implementation class.
*/
static private final String SOAP_FACTORY_PROPERTY =
"javax.xml.soap.SOAPFactory";
/**
- * Class name of default SOAPFactory
implementation.
+ * Class name of default {@code SOAPFactory} implementation.
*/
static final String DEFAULT_SOAP_FACTORY
= "com.sun.xml.internal.messaging.saaj.soap.ver1_1.SOAPFactory1_1Impl";
/**
- * Creates a SOAPElement
object from an existing DOM
- * Element
. If the DOM Element
that is passed in
- * as an argument is already a SOAPElement
then this method
+ * Creates a {@code SOAPElement} object from an existing DOM
+ * {@code Element}. If the DOM {@code Element} that is passed in
+ * as an argument is already a {@code SOAPElement} then this method
* must return it unmodified without any further work. Otherwise, a new
- * SOAPElement
is created and a deep copy is made of the
- * domElement
argument. The concrete type of the return value
- * will depend on the name of the domElement
argument. If any
- * part of the tree rooted in domElement
violates SOAP rules, a
- * SOAPException
will be thrown.
+ * {@code SOAPElement} is created and a deep copy is made of the
+ * {@code domElement} argument. The concrete type of the return value
+ * will depend on the name of the {@code domElement} argument. If any
+ * part of the tree rooted in {@code domElement} violates SOAP rules, a
+ * {@code SOAPException} will be thrown.
*
- * @param domElement - the Element
to be copied.
+ * @param domElement - the {@code Element} to be copied.
*
- * @return a new SOAPElement
that is a copy of domElement
.
+ * @return a new {@code SOAPElement} that is a copy of {@code domElement}.
*
* @exception SOAPException if there is an error in creating the
- * SOAPElement
object
+ * {@code SOAPElement} object
*
* @since 1.6, SAAJ 1.3
*/
@@ -85,41 +85,41 @@
}
/**
- * Creates a SOAPElement
object initialized with the
- * given Name
object. The concrete type of the return value
- * will depend on the name given to the new SOAPElement
. For
- * instance, a new SOAPElement
with the name
+ * Creates a {@code SOAPElement} object initialized with the
+ * given {@code Name} object. The concrete type of the return value
+ * will depend on the name given to the new {@code SOAPElement}. For
+ * instance, a new {@code SOAPElement} with the name
* "{http://www.w3.org/2003/05/soap-envelope}Envelope" would cause a
- * SOAPEnvelope
that supports SOAP 1.2 behavior to be created.
+ * {@code SOAPEnvelope} that supports SOAP 1.2 behavior to be created.
*
- * @param name a Name
object with the XML name for
+ * @param name a {@code Name} object with the XML name for
* the new element
*
- * @return the new SOAPElement
object that was
+ * @return the new {@code SOAPElement} object that was
* created
*
* @exception SOAPException if there is an error in creating the
- * SOAPElement
object
+ * {@code SOAPElement} object
* @see SOAPFactory#createElement(javax.xml.namespace.QName)
*/
public abstract SOAPElement createElement(Name name) throws SOAPException;
/**
- * Creates a SOAPElement
object initialized with the
- * given QName
object. The concrete type of the return value
- * will depend on the name given to the new SOAPElement
. For
- * instance, a new SOAPElement
with the name
+ * Creates a {@code SOAPElement} object initialized with the
+ * given {@code QName} object. The concrete type of the return value
+ * will depend on the name given to the new {@code SOAPElement}. For
+ * instance, a new {@code SOAPElement} with the name
* "{http://www.w3.org/2003/05/soap-envelope}Envelope" would cause a
- * SOAPEnvelope
that supports SOAP 1.2 behavior to be created.
+ * {@code SOAPEnvelope} that supports SOAP 1.2 behavior to be created.
*
- * @param qname a QName
object with the XML name for
+ * @param qname a {@code QName} object with the XML name for
* the new element
*
- * @return the new SOAPElement
object that was
+ * @return the new {@code SOAPElement} object that was
* created
*
* @exception SOAPException if there is an error in creating the
- * SOAPElement
object
+ * {@code SOAPElement} object
* @see SOAPFactory#createElement(Name)
* @since 1.6, SAAJ 1.3
*/
@@ -128,38 +128,38 @@
}
/**
- * Creates a SOAPElement
object initialized with the
+ * Creates a {@code SOAPElement} object initialized with the
* given local name.
*
- * @param localName a String
giving the local name for
+ * @param localName a {@code String} giving the local name for
* the new element
*
- * @return the new SOAPElement
object that was
+ * @return the new {@code SOAPElement} object that was
* created
*
* @exception SOAPException if there is an error in creating the
- * SOAPElement
object
+ * {@code SOAPElement} object
*/
public abstract SOAPElement createElement(String localName)
throws SOAPException;
/**
- * Creates a new SOAPElement
object with the given
+ * Creates a new {@code SOAPElement} object with the given
* local name, prefix and uri. The concrete type of the return value
- * will depend on the name given to the new SOAPElement
. For
- * instance, a new SOAPElement
with the name
+ * will depend on the name given to the new {@code SOAPElement}. For
+ * instance, a new {@code SOAPElement} with the name
* "{http://www.w3.org/2003/05/soap-envelope}Envelope" would cause a
- * SOAPEnvelope
that supports SOAP 1.2 behavior to be created.
+ * {@code SOAPEnvelope} that supports SOAP 1.2 behavior to be created.
*
- * @param localName a String
giving the local name
+ * @param localName a {@code 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
+ * @param prefix the prefix for this {@code SOAPElement}
+ * @param uri a {@code String} giving the URI of the
* namespace to which the new element belongs
*
* @exception SOAPException if there is an error in creating the
- * SOAPElement
object
+ * {@code SOAPElement} object
*/
public abstract SOAPElement createElement(
String localName,
@@ -168,51 +168,51 @@
throws SOAPException;
/**
- * Creates a new Detail
object which serves as a container
- * for DetailEntry
objects.
+ * Creates a new {@code Detail} object which serves as a container
+ * for {@code DetailEntry} objects.
*
- * This factory method creates Detail
objects for use in
- * situations where it is not practical to use the SOAPFault
+ * This factory method creates {@code Detail} objects for use in
+ * situations where it is not practical to use the {@code SOAPFault}
* abstraction.
*
- * @return a Detail
object
+ * @return a {@code Detail} object
* @throws SOAPException if there is a SOAP error
* @throws UnsupportedOperationException if the protocol specified
- * for the SOAPFactory was DYNAMIC_SOAP_PROTOCOL
+ * for the SOAPFactory was {@code DYNAMIC_SOAP_PROTOCOL}
*/
public abstract Detail createDetail() throws SOAPException;
/**
- *Creates a new SOAPFault
object initialized with the given reasonText
- * and faultCode
+ *Creates a new {@code SOAPFault} object initialized with the given {@code reasonText}
+ * and {@code faultCode}
*@param reasonText the ReasonText/FaultString for the fault
*@param faultCode the FaultCode for the fault
- *@return a SOAPFault
object
+ *@return a {@code SOAPFault} object
*@throws SOAPException if there is a SOAP error
*@since 1.6, SAAJ 1.3
*/
public abstract SOAPFault createFault(String reasonText, QName faultCode) throws SOAPException;
/**
- *Creates a new default SOAPFault
object
- *@return a SOAPFault
object
+ *Creates a new default {@code SOAPFault} object
+ *@return a {@code SOAPFault} object
*@throws SOAPException if there is a SOAP error
*@since 1.6, SAAJ 1.3
*/
public abstract SOAPFault createFault() throws SOAPException;
/**
- * Creates a new Name
object initialized with the
+ * Creates a new {@code Name} object initialized with the
* given local name, namespace prefix, and namespace URI.
*
- * This factory method creates Name
objects for use in
- * situations where it is not practical to use the SOAPEnvelope
+ * This factory method creates {@code Name} objects for use in
+ * situations where it is not practical to use the {@code SOAPEnvelope}
* abstraction.
*
- * @param localName a String
giving the local name
- * @param prefix a String
giving the prefix of the namespace
- * @param uri a String
giving the URI of the namespace
- * @return a Name
object initialized with the given
+ * @param localName a {@code String} giving the local name
+ * @param prefix a {@code String} giving the prefix of the namespace
+ * @param uri a {@code String} giving the URI of the namespace
+ * @return a {@code Name} object initialized with the given
* local name, namespace prefix, and namespace URI
* @throws SOAPException if there is a SOAP error
*/
@@ -223,22 +223,22 @@
throws SOAPException;
/**
- * Creates a new Name
object initialized with the
+ * Creates a new {@code Name} object initialized with the
* given local name.
*
- * This factory method creates Name
objects for use in
- * situations where it is not practical to use the SOAPEnvelope
+ * This factory method creates {@code Name} objects for use in
+ * situations where it is not practical to use the {@code SOAPEnvelope}
* abstraction.
*
- * @param localName a String
giving the local name
- * @return a Name
object initialized with the given
+ * @param localName a {@code String} giving the local name
+ * @return a {@code Name} object initialized with the given
* local name
* @throws SOAPException if there is a SOAP error
*/
public abstract Name createName(String localName) throws SOAPException;
/**
- * Creates a new SOAPFactory
object that is an instance of
+ * Creates a new {@code SOAPFactory} object that is an instance of
* the default implementation (SOAP 1.1),
*
* This method uses the following ordered lookup procedure to determine the SOAPFactory implementation class to load:
@@ -252,10 +252,10 @@
*
SOAPFactory
+ * @return a new instance of a {@code SOAPFactory}
*
* @exception SOAPException if there was an error creating the
- * default SOAPFactory
+ * default {@code SOAPFactory}
* @see SAAJMetaFactory
*/
public static SOAPFactory newInstance()
@@ -275,21 +275,21 @@
}
/**
- * Creates a new SOAPFactory
object that is an instance of
+ * Creates a new {@code SOAPFactory} object that is an instance of
* the specified implementation, this method uses the SAAJMetaFactory to
* locate the implementation class and create the SOAPFactory instance.
*
- * @return a new instance of a SOAPFactory
+ * @return a new instance of a {@code SOAPFactory}
*
* @param protocol a string constant representing the protocol of the
* specified SOAP factory implementation. May be
- * either DYNAMIC_SOAP_PROTOCOL
,
- * DEFAULT_SOAP_PROTOCOL
(which is the same
- * as) SOAP_1_1_PROTOCOL
, or
- * SOAP_1_2_PROTOCOL
.
+ * either {@code DYNAMIC_SOAP_PROTOCOL},
+ * {@code DEFAULT_SOAP_PROTOCOL} (which is the same
+ * as) {@code SOAP_1_1_PROTOCOL}, or
+ * {@code SOAP_1_2_PROTOCOL}.
*
* @exception SOAPException if there was an error creating the
- * specified SOAPFactory
+ * specified {@code SOAPFactory}
* @see SAAJMetaFactory
* @since 1.6, SAAJ 1.3
*/