Author: veithen
Date: Sat Oct 10 14:00:56 2015
New Revision: 1707880
URL: http://svn.apache.org/viewvc?rev=1707880&view=rev
Log:
Fix Javadoc errors detected by Java 8.
Modified:
webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/attachments/ConfigurableDataHandler.java
webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/attachments/impl/BufferUtils.java
webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/ext/stax/datahandler/DataHandlerReader.java
webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/mime/ContentType.java
webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/om/OMAbstractFactory.java
webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/om/OMAttribute.java
webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/om/OMContainer.java
webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/om/OMElement.java
webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/om/OMNode.java
webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/om/OMOutputFormat.java
webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/om/OMXMLParserWrapper.java
webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/om/OMXMLStreamReaderConfiguration.java
webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/om/dom/DOMMetaFactory.java
webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/om/impl/MTOMXMLStreamWriter.java
webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/om/util/OMXMLStreamReaderValidator.java
webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/om/util/StAXUtils.java
webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/om/xpath/DocumentNavigator.java
webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/soap/SOAPBody.java
webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/soap/SOAPFault.java
webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/soap/SOAPFaultDetail.java
webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/soap/SOAPFaultRole.java
webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/util/UIDGenerator.java
webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/util/stax/XMLFragmentStreamReader.java
webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/util/stax/debug/XMLStreamReaderValidator.java
Modified:
webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/attachments/ConfigurableDataHandler.java
URL:
http://svn.apache.org/viewvc/webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/attachments/ConfigurableDataHandler.java?rev=1707880&r1=1707879&r2=1707880&view=diff
==============================================================================
---
webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/attachments/ConfigurableDataHandler.java
(original)
+++
webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/attachments/ConfigurableDataHandler.java
Sat Oct 10 14:00:56 2015
@@ -27,8 +27,8 @@ import java.net.URL;
* This Axiom DataHandler inplementation allows the user to set custom values
for the following MIME
* body part headers. <ul> <li>content-transfer-encoding</li>
<li>content-type</li> </ul> <p>Data
* written to the MIME part gets encoded by content-transfer-encoding
specified as above</p>
- * <p/>
- * <p>Usage is Similar to the javax.activation.DataHandler except for the
setting of the above
+ * <p>
+ * Usage is Similar to the javax.activation.DataHandler except for the setting
of the above
* properties. </p> <p>eg: </p> <p> dataHandler = new
ConfigurableDataHandler(new
* ByteArrayDataSource(byteArray));</p> <p>
dataHandler.setTransferEncoding("quoted-printable");</p>
* <p> dataHandler.setContentType("image/jpg");</p>
Modified:
webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/attachments/impl/BufferUtils.java
URL:
http://svn.apache.org/viewvc/webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/attachments/impl/BufferUtils.java?rev=1707880&r1=1707879&r2=1707880&view=diff
==============================================================================
---
webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/attachments/impl/BufferUtils.java
(original)
+++
webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/attachments/impl/BufferUtils.java
Sat Oct 10 14:00:56 2015
@@ -255,7 +255,6 @@ public class BufferUtils {
* @param limit
* @return 1 if DataHandler data is bigger than limit, 0 if DataHandler
data is smaller or
* -1 if an error occurs or unsupported.
- * @throws IOException
*/
public static int doesDataHandlerExceedLimit(DataHandler dh, int limit){
//If Optimized Threshold not set return true.
Modified:
webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/ext/stax/datahandler/DataHandlerReader.java
URL:
http://svn.apache.org/viewvc/webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/ext/stax/datahandler/DataHandlerReader.java?rev=1707880&r1=1707879&r2=1707880&view=diff
==============================================================================
---
webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/ext/stax/datahandler/DataHandlerReader.java
(original)
+++
webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/ext/stax/datahandler/DataHandlerReader.java
Sat Oct 10 14:00:56 2015
@@ -103,7 +103,7 @@ public interface DataHandlerReader {
* <li>If the content ID has been extracted from an <tt>href</tt>
attribute, it MUST NOT
* contain the <tt>cid:</tt> prefix.</li>
* <li>If it has been extracted from a <tt>Content-ID</tt> MIME header, it
MUST NOT be
- * enclosed in angles (<tt><></tt>).</li>
+ * enclosed in angles (<tt><></tt>).</li>
* </ul>
* <p>
* A consumer MAY use the return value of this method in contexts where it
is desirable to
Modified:
webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/mime/ContentType.java
URL:
http://svn.apache.org/viewvc/webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/mime/ContentType.java?rev=1707880&r1=1707879&r2=1707880&view=diff
==============================================================================
---
webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/mime/ContentType.java
(original)
+++
webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/mime/ContentType.java
Sat Oct 10 14:00:56 2015
@@ -37,10 +37,10 @@ import javax.activation.MimeType;
* parameter := attribute "=" value
* attribute := token
* value := token / quoted-string
- * token := 1*<any (US-ASCII) CHAR except SPACE, CTLs, or tspecials>
- * tspecials := "(" / ")" / "<" / ">" / "@" / "," / ";" / ":" / "\" /
<"> / "/" / "[" / "]" / "?" / "="
- * quoted-string := <"> *(qtext/quoted-pair) <">
- * qtext := <any CHAR excepting <">, "\" & CR, and including
linear-white-space>
+ * token := 1*<any (US-ASCII) CHAR except SPACE, CTLs, or tspecials>
+ * tspecials := "(" / ")" / "<" / ">" / "@" / "," / ";" / ":" / "\" /
<"> / "/" / "[" / "]" / "?" / "="
+ * quoted-string := <"> *(qtext/quoted-pair) <">
+ * qtext := <any CHAR excepting <">, "\" & CR, and including
linear-white-space>
* quoted-pair := "\" CHAR
* </pre>
* <p>
Modified:
webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/om/OMAbstractFactory.java
URL:
http://svn.apache.org/viewvc/webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/om/OMAbstractFactory.java?rev=1707880&r1=1707879&r2=1707880&view=diff
==============================================================================
---
webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/om/OMAbstractFactory.java
(original)
+++
webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/om/OMAbstractFactory.java
Sat Oct 10 14:00:56 2015
@@ -55,7 +55,6 @@ import org.apache.axiom.soap.SOAPFactory
* Note that while {@link #getMetaFactory()} always returns the same instance,
the other methods
* may return new instances on every invocation, depending on the {@link
OMMetaFactory}
* implementation.
- * <p>
*/
public class OMAbstractFactory {
/**
Modified:
webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/om/OMAttribute.java
URL:
http://svn.apache.org/viewvc/webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/om/OMAttribute.java?rev=1707880&r1=1707879&r2=1707880&view=diff
==============================================================================
---
webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/om/OMAttribute.java
(original)
+++
webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/om/OMAttribute.java
Sat Oct 10 14:00:56 2015
@@ -24,7 +24,7 @@ public interface OMAttribute extends OMN
/**
* Get the attribute value.
*
- * @return the attribute value; never <code>null</code
+ * @return the attribute value; never <code>null</code>
*/
String getAttributeValue();
Modified:
webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/om/OMContainer.java
URL:
http://svn.apache.org/viewvc/webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/om/OMContainer.java?rev=1707880&r1=1707879&r2=1707880&view=diff
==============================================================================
---
webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/om/OMContainer.java
(original)
+++
webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/om/OMContainer.java
Sat Oct 10 14:00:56 2015
@@ -39,8 +39,8 @@ import java.util.Iterator;
/**
* Captures the operations related to containment shared by both a document
and an element.
- * <p/>
- * <p>Exposes the ability to add, find, and iterate over the children of a
document or element.</p>
+ * <p>
+ * Exposes the ability to add, find, and iterate over the children of a
document or element.</p>
*/
public interface OMContainer extends OMSerializable {
/**
@@ -65,7 +65,6 @@ public interface OMContainer extends OMS
/**
* Returns an iterator for child nodes matching the given QName.
- * <p/>
*
* @param elementQName The QName specifying namespace and local name to
match.
* @return Returns an iterator of {@link OMElement} items that match the
given QName
@@ -75,7 +74,6 @@ public interface OMContainer extends OMS
/**
* Returns an iterator for child nodes matching the local name.
- * <p/>
*
* @param localName
* @return Returns an iterator of {@link OMElement} items that match the
given localName
@@ -84,7 +82,6 @@ public interface OMContainer extends OMS
/**
* Returns an iterator for child nodes matching the namespace uri.
- * <p/>
*
* @param uri
* @return Returns an iterator of {@link OMElement} items that match the
given uri
@@ -283,6 +280,8 @@ public interface OMContainer extends OMS
* consuming the reader are different:
* <p>
* <table border="2" rules="all" cellpadding="4" cellspacing="0">
+ * <caption>Side effects of consuming events from the reader returned by
+ * {@link #getXMLStreamReader(boolean)}</caption>
* <tr>
* <th>State</th>
* <th><code>cache</code></th>
@@ -339,7 +338,7 @@ public interface OMContainer extends OMS
* {@link XOPEncodingStreamReader} instead.</li>
* <li>Some existing code uses the {@link OMAttachmentAccessor} interface
of the returned
* reader to fetch attachments using {@link
OMAttachmentAccessor#getDataHandler(String)}. There
- * is no reason anymore to do so:</li>
+ * is no reason anymore to do so:
* <ul>
* <li>When {@link OMXMLStreamReader#setInlineMTOM(boolean)} is used to
disable MTOM inlining,
* {@link OMAttachmentAccessor#getDataHandler(String)} must be used to
retrieve the binary
@@ -356,6 +355,7 @@ public interface OMContainer extends OMS
* doesn't give access to the attachments in the SwA case (neither in
1.2.9 nor in previous
* versions).</li>
* </ul>
+ * </li>
* </ul>
* <p>
* Code making any of these assumptions should be fixed, so that only
{@link XMLStreamReader}
@@ -397,7 +397,7 @@ public interface OMContainer extends OMS
* {@link ContentHandler#endPrefixMapping(String)} events also for
namespace mappings declared
* on the ancestors of the element. To understand why this is important,
consider the following
* example:
- * <pre><root xmlns:ns="urn:ns"><element
attr="ns:someThing"/><root></pre>
+ * <pre><root xmlns:ns="urn:ns"><element
attr="ns:someThing"/><root></pre>
* <p>
* In that case, to correctly interpret the attribute value, the SAX
content handler must be
* aware of the namespace mapping for the <tt>ns</tt> prefix, even if the
serialization starts
Modified:
webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/om/OMElement.java
URL:
http://svn.apache.org/viewvc/webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/om/OMElement.java?rev=1707880&r1=1707879&r2=1707880&view=diff
==============================================================================
---
webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/om/OMElement.java
(original)
+++
webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/om/OMElement.java
Sat Oct 10 14:00:56 2015
@@ -182,12 +182,12 @@ public interface OMElement extends OMNod
/**
* Finds a namespace with the given uri and prefix, in the scope of the
hierarchy.
- * <p/>
- * <p>Searches from the current element and goes up the hiararchy until a
match is found. If no
+ * <p>
+ * Searches from the current element and goes up the hiararchy until a
match is found. If no
* match is found, returns <tt>null</tt>.</p>
- * <p/>
- * <p>Either <tt>prefix</tt> or <tt>uri</tt> should be null. Results are
undefined if both are
- * specified.</p>
+ * <p>
+ * Either <tt>prefix</tt> or <tt>uri</tt> should be null. Results are
undefined if both are
+ * specified.
*
* @param uri The namespace to look for. If this is specified,
<tt>prefix</tt> should be
* null.
@@ -427,7 +427,7 @@ public interface OMElement extends OMNod
* This method iterates over all the text children of the element and
concatenates
* them to a single string. Only direct children will be considered, i.e.
the text
* is not extracted recursively. For example the return value for
- * <tt><element>A<child>B</child>C</element></tt> will be
<tt>AC</tt>.
+ * <tt><element>A<child>B</child>C</element></tt>
will be <tt>AC</tt>.
* <p>
* All whitespace will be preserved.
*
Modified:
webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/om/OMNode.java
URL:
http://svn.apache.org/viewvc/webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/om/OMNode.java?rev=1707880&r1=1707879&r2=1707880&view=diff
==============================================================================
---
webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/om/OMNode.java
(original)
+++
webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/om/OMNode.java
Sat Oct 10 14:00:56 2015
@@ -26,14 +26,12 @@ import java.io.Writer;
/**
* Defines the base interface used by most of the XML object model within Axis.
- * <p/>
- * <p/>
+ * <p>
* This tree model for XML captures the idea of deferring the construction of
child nodes until they
* are needed. The <code>isComplete</code> function identifies whether or not
a particular node has
* been fully parsed. A node may not be fully parsed, for example, if all of
the children of an
* element have not yet been parsed. </p>
- * <p/>
- * <p/>
+ * <p>
* In comparison to DOM, in this model, you will not find document fragments,
or entities. In
* addition, while {@link OMDocument} and {@link OMAttribute} exist, neither
is an extension of
* <code>OMNode</code>. </p>
@@ -97,8 +95,7 @@ public interface OMNode extends OMSerial
/**
* Returns the parent containing node.
- * <p/>
- * <p/>
+ * <p>
* Returns the parent container, which may be either an {@link OMDocument}
or {@link OMElement}.
*
* @return The {@link OMContainer} of the node.
@@ -114,8 +111,7 @@ public interface OMNode extends OMSerial
/**
* Removes a node (and all of its children) from its containing parent.
- * <p/>
- * <p/>
+ * <p>
* Removes a node from its parent. Partially complete nodes will be
completed before they are
* detached from the model. A node cannot be detached until its next
sibling has been identified,
* so that the next sibling and parent can be updated appropriately.
Please note that this will not
@@ -132,8 +128,7 @@ public interface OMNode extends OMSerial
/**
* Discards a node.
- * <p/>
- * <p/>
+ * <p>
* Discard goes to the parser level and if the element is not completely
built, then it will be
* completely skipped at the parser level. </p>
*
Modified:
webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/om/OMOutputFormat.java
URL:
http://svn.apache.org/viewvc/webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/om/OMOutputFormat.java?rev=1707880&r1=1707879&r2=1707880&view=diff
==============================================================================
---
webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/om/OMOutputFormat.java
(original)
+++
webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/om/OMOutputFormat.java
Sat Oct 10 14:00:56 2015
@@ -35,7 +35,7 @@ import org.apache.commons.logging.LogFac
/**
* Formats options for OM Output.
- * <p/>
+ * <p>
* Setting of all the properties in a OMOutputFormat should be done before
calling the
* getContentType() method. It is advised to set all the properties at the
creation time of the
* OMOutputFormat and not to change them later.
Modified:
webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/om/OMXMLParserWrapper.java
URL:
http://svn.apache.org/viewvc/webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/om/OMXMLParserWrapper.java?rev=1707880&r1=1707879&r2=1707880&view=diff
==============================================================================
---
webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/om/OMXMLParserWrapper.java
(original)
+++
webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/om/OMXMLParserWrapper.java
Sat Oct 10 14:00:56 2015
@@ -170,6 +170,7 @@ public interface OMXMLParserWrapper {
* the builder:
* <p>
* <table border="2" rules="all" cellpadding="4" cellspacing="0">
+ * <caption>Actions performed by the {@link #detach()} method</caption>
* <tr>
* <th>Source object type</th>
* <th>Action performed by this method</th>
Modified:
webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/om/OMXMLStreamReaderConfiguration.java
URL:
http://svn.apache.org/viewvc/webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/om/OMXMLStreamReaderConfiguration.java?rev=1707880&r1=1707879&r2=1707880&view=diff
==============================================================================
---
webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/om/OMXMLStreamReaderConfiguration.java
(original)
+++
webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/om/OMXMLStreamReaderConfiguration.java
Sat Oct 10 14:00:56 2015
@@ -66,13 +66,13 @@ public class OMXMLStreamReaderConfigurat
* <pre>
* <soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/";
* xmlns:xsd="http://www.w3.org/2001/XMLSchema";
- * xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";>
- * <soapenv:Body>
- * <ns:echo xmlns:ns="urn:test">
- * <in xsi:type="xsd:string">test</in>
- * </ns:echo>
- * </soapenv:Body>
- * </soapenv:Envelope>
+ *
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+ * <soapenv:Body>
+ * <ns:echo xmlns:ns="urn:test">
+ * <in xsi:type="xsd:string">test</in>
+ * </ns:echo>
+ * </soapenv:Body>
+ * </soapenv:Envelope>
* </pre>
* <p>
* When {@link OMContainer#getXMLStreamReader(boolean)} is invoked on the
{@link OMElement}
Modified:
webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/om/dom/DOMMetaFactory.java
URL:
http://svn.apache.org/viewvc/webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/om/dom/DOMMetaFactory.java?rev=1707880&r1=1707879&r2=1707880&view=diff
==============================================================================
---
webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/om/dom/DOMMetaFactory.java
(original)
+++
webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/om/dom/DOMMetaFactory.java
Sat Oct 10 14:00:56 2015
@@ -58,8 +58,9 @@ import org.w3c.dom.Text;
* Axiom implementations supporting this feature MUST conform to the Axiom API
as well as the DOM
* API, and nodes created by the implementation MUST implement both the Axiom
interfaces and the DOM
* interfaces corresponding, as specified by the following table:
- * <table border="2" rules="all" cellpadding="4" cellspacing="0">
* <p>
+ * <table border="2" rules="all" cellpadding="4" cellspacing="0">
+ * <caption>Mapping between Axiom and DOM interfaces</caption>
* <tr>
* <th>Axiom interface</th>
* <th>DOM interface</th>
Modified:
webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/om/impl/MTOMXMLStreamWriter.java
URL:
http://svn.apache.org/viewvc/webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/om/impl/MTOMXMLStreamWriter.java?rev=1707880&r1=1707879&r2=1707880&view=diff
==============================================================================
---
webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/om/impl/MTOMXMLStreamWriter.java
(original)
+++
webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/om/impl/MTOMXMLStreamWriter.java
Sat Oct 10 14:00:56 2015
@@ -52,7 +52,7 @@ import org.apache.commons.logging.LogFac
* MTOMXMLStreamWriter is an XML + Attachments stream writer.
*
* For the moment this assumes that transport takes the decision of whether to
optimize or not by
- * looking at whether the MTOM optimize is enabled & also looking at the OM
tree whether it has any
+ * looking at whether the MTOM optimize is enabled and also looking at the OM
tree whether it has any
* optimizable content.
*/
public class MTOMXMLStreamWriter implements XMLStreamWriter {
Modified:
webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/om/util/OMXMLStreamReaderValidator.java
URL:
http://svn.apache.org/viewvc/webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/om/util/OMXMLStreamReaderValidator.java?rev=1707880&r1=1707879&r2=1707880&view=diff
==============================================================================
---
webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/om/util/OMXMLStreamReaderValidator.java
(original)
+++
webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/om/util/OMXMLStreamReaderValidator.java
Sat Oct 10 14:00:56 2015
@@ -23,22 +23,8 @@ import org.apache.axiom.util.stax.debug.
import javax.activation.DataHandler;
-// TODO: this needs reformatting; the (generated) Javadoc is unreadable!
/**
- * There are several places in the code where events are passed from
- * a source to a consumer using XMLStreamReader events.
- *
- * OMXMLStreamReader (impl)--> consumer of XMLStreamReader events
- *
- * This simple class can be interjected as a filter and used to do some simple
validation.
- * Validating the events coming from source (impl) can help find and correct
errors
- * when they occur. Otherwise the errors may be caught much further
downstream and hard to fix.
- *
- * OMXMLStreamReader (impl)--> OMXMLStreamReaderValiator-> consumer of
XMLStreamReader events
- *
- *
- * In the initial version, the XMStreamValidator ensures that the start
element events match the
- * end element events.
+ * Subclass of {@link XMLStreamReaderValidator} that also implements {@link
OMXMLStreamReader}.
*
* @see org.apache.axiom.om.OMElement#getXMLStreamReader(boolean)
*/
Modified:
webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/om/util/StAXUtils.java
URL:
http://svn.apache.org/viewvc/webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/om/util/StAXUtils.java?rev=1707880&r1=1707879&r2=1707880&view=diff
==============================================================================
---
webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/om/util/StAXUtils.java
(original)
+++
webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/om/util/StAXUtils.java
Sat Oct 10 14:00:56 2015
@@ -71,7 +71,7 @@ import java.util.WeakHashMap;
* <dt><tt>com.ctc.wstx.minTextSegment</tt></dt>
* <dd>Property to specify shortest non-complete text segment (part of CDATA
section or text
* content) that the parser is allowed to return, if not required to
coalesce text.
- * This property is Woodstox specific.</dt>
+ * This property is Woodstox specific.</dd>
* </dl>
* <p>Good candidates for <tt>XMLOutputFactory.properties</tt> are:</p>
* <dl>
Modified:
webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/om/xpath/DocumentNavigator.java
URL:
http://svn.apache.org/viewvc/webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/om/xpath/DocumentNavigator.java?rev=1707880&r1=1707879&r2=1707880&view=diff
==============================================================================
---
webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/om/xpath/DocumentNavigator.java
(original)
+++
webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/om/xpath/DocumentNavigator.java
Sat Oct 10 14:00:56 2015
@@ -599,7 +599,7 @@ public class DocumentNavigator extends D
/**
* Translates a namespace prefix to a namespace URI, <b>possibly</b>
considering a particular
* element node.
- * <p/>
+ * <p>
* Strictly speaking, prefix-to-URI translation should occur irrespective
of any element in the
* document. This method is provided to allow a non-conforming
ease-of-use enhancement. </p>
*
@@ -646,7 +646,7 @@ public class DocumentNavigator extends D
/**
* Returns the parent of the given context node.
- * <p/>
+ * <p>
* The parent of any node must either be a document node or an element
node.
*
* @param contextNode the context node
Modified:
webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/soap/SOAPBody.java
URL:
http://svn.apache.org/viewvc/webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/soap/SOAPBody.java?rev=1707880&r1=1707879&r2=1707880&view=diff
==============================================================================
---
webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/soap/SOAPBody.java
(original)
+++
webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/soap/SOAPBody.java
Sat Oct 10 14:00:56 2015
@@ -26,7 +26,7 @@ import org.apache.axiom.om.OMNamespace;
/**
* An object that represents the contents of the SOAP body element in a SOAP
message. B SOAP body
* element consists of XML data that affects the way the application-specific
content is processed.
- * <p/>
+ * <p>
* B <code>SOAPBody</code> object contains <code>OMBodyBlock</code> objects,
which have the content
* for the SOAP body. B <code>SOAPFault</code> object, which carries status
and/or error
* information, is an example of a <code>OMBodyBlock</code> object.
Modified:
webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/soap/SOAPFault.java
URL:
http://svn.apache.org/viewvc/webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/soap/SOAPFault.java?rev=1707880&r1=1707879&r2=1707880&view=diff
==============================================================================
---
webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/soap/SOAPFault.java
(original)
+++
webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/soap/SOAPFault.java
Sat Oct 10 14:00:56 2015
@@ -29,7 +29,7 @@ import org.apache.axiom.om.OMException;
* are not related to the content in the message itself. Problems not related
to the message itself
* are generally errors in processing, such as the inability to communicate
with an upstream
* server.
- * <p/>
+ * <p>
* The <CODE>SOAPFault</CODE> interface provides methods for retrieving the
information contained in
* a <CODE> SOAPFault</CODE> object and for setting the fault code, the fault
actor, and a string
* describing the fault. B fault code is one of the codes defined in the SOAP
1.1 specification that
@@ -93,9 +93,9 @@ public interface SOAPFault extends OMEle
/**
* Returns Exception if there is one in the SOAP fault.
- * <p/>
- * If the exception is like; <SOAPFault> <Detail> <Exception> stack trace
goes here </Exception>
- * </Detail> </SOAPFault>
+ * <p>
+ * If the exception is like; <SOAPFault> <Detail>
<Exception> stack trace goes
+ * here </Exception> </Detail> </SOAPFault>
*
* @return Returns Exception.
* @throws org.apache.axiom.om.OMException
Modified:
webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/soap/SOAPFaultDetail.java
URL:
http://svn.apache.org/viewvc/webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/soap/SOAPFaultDetail.java?rev=1707880&r1=1707879&r2=1707880&view=diff
==============================================================================
---
webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/soap/SOAPFaultDetail.java
(original)
+++
webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/soap/SOAPFaultDetail.java
Sat Oct 10 14:00:56 2015
@@ -27,7 +27,7 @@ import java.util.Iterator;
/**
* The Detail element information item is intended for carrying application
specific error
* information related to the SOAP Body .
- * <p/>
+ * <p>
* The Detail element information item has: A [local name] of Detail . A
[namespace name] of
* http://www.w3.org/2003/05/soap-envelope . Zero or more attribute
information items in its
* [attributes] property. Zero or more child element information items in its
[children] property.
Modified:
webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/soap/SOAPFaultRole.java
URL:
http://svn.apache.org/viewvc/webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/soap/SOAPFaultRole.java?rev=1707880&r1=1707879&r2=1707880&view=diff
==============================================================================
---
webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/soap/SOAPFaultRole.java
(original)
+++
webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/soap/SOAPFaultRole.java
Sat Oct 10 14:00:56 2015
@@ -25,7 +25,7 @@ import org.apache.axiom.om.OMElement;
/**
* The Role element information item identifies the role the node was
operating in at the point the
* fault occurred.
- * <p/>
+ * <p>
* The Role element information item has: A [local name] of Role . A
[namespace name] of
* http://www.w3.org/2003/05/soap-envelope .
*/
Modified:
webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/util/UIDGenerator.java
URL:
http://svn.apache.org/viewvc/webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/util/UIDGenerator.java?rev=1707880&r1=1707879&r2=1707880&view=diff
==============================================================================
---
webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/util/UIDGenerator.java
(original)
+++
webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/util/UIDGenerator.java
Sat Oct 10 14:00:56 2015
@@ -139,7 +139,7 @@ public final class UIDGenerator {
* must match the <tt>msg-id</tt> production, which is defined by RFC2822
as
* follows:
* <pre>
- * msg-id = [CFWS] "<" id-left "@" id-right ">" [CFWS]
+ * msg-id = [CFWS] "<" id-left "@" id-right ">" [CFWS]
* id-left = dot-atom-text / no-fold-quote / obs-id-left
* id-right = dot-atom-text / no-fold-literal / obs-id-right
* dot-atom-text = 1*atext *("." 1*atext)
@@ -172,7 +172,7 @@ public final class UIDGenerator {
* <p>
* Valid MIME boundaries are defined by the following production in
RFC2046:
* <pre>
- * boundary := 0*69<bchars> bcharsnospace
+ * boundary := 0*69<bchars> bcharsnospace
* bchars := bcharsnospace / " "
* bcharsnospace := DIGIT / ALPHA / "'" / "(" / ")" /
* "+" / "_" / "," / "-" / "." /
@@ -183,8 +183,8 @@ public final class UIDGenerator {
* <tt>Content-Type</tt> header), it will require quoting if it contains
characters from
* the following production:
* <pre>
- * tspecials := "(" / ")" / "<" / ">" / "@" /
- * "," / ";" / ":" / "\" / <"> /
+ * tspecials := "(" / ")" / "<" / ">" / "@" /
+ * "," / ";" / ":" / "\" / <"> /
* "/" / "[" / "]" / "?" / "="</pre>
* <p>
* This method produces a boundary that doesn't contain any of these
characters and
Modified:
webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/util/stax/XMLFragmentStreamReader.java
URL:
http://svn.apache.org/viewvc/webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/util/stax/XMLFragmentStreamReader.java?rev=1707880&r1=1707879&r2=1707880&view=diff
==============================================================================
---
webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/util/stax/XMLFragmentStreamReader.java
(original)
+++
webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/util/stax/XMLFragmentStreamReader.java
Sat Oct 10 14:00:56 2015
@@ -33,19 +33,19 @@ import javax.xml.stream.XMLStreamReader;
* the sequence of events appear as a complete document.
* <p>
* Assume for example that the parent reader is parsing the following document:
- * <pre><a><b>text</b></a></pre>
- * If the current event is <code><b></code> when the wrapper is created, it
will produce
+ * <pre><a><b>text</b></a></pre>
+ * If the current event is <code><b></code> when the wrapper is created,
it will produce
* the following sequence of events:
* <p>
* <ul>
* <li>A synthetic START_DOCUMENT event.</li>
- * <li>START_ELEMENT, CHARACTERS and END_ELEMENT events for
<code><b>text</b></code>.
+ * <li>START_ELEMENT, CHARACTERS and END_ELEMENT events for
<code><b>text</b></code>.
* For these events, the wrapper directly delegates to the parent
reader.</li>
* <li>A synthetic END_DOCUMENT event.</li>
* </ul>
* After all events have been consumed from the wrapper, the current event on
the parent reader
* will be the event following the last END_ELEMENT of the fragment. In the
example above this
- * will be <code></a></code>.
+ * will be <code></a></code>.
* <p>
* The wrapper will release the reference to the parent reader when {@link
#close()} is called.
* For obvious reasons, the wrapper will never call {@link
XMLStreamReader#close()} on the parent
Modified:
webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/util/stax/debug/XMLStreamReaderValidator.java
URL:
http://svn.apache.org/viewvc/webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/util/stax/debug/XMLStreamReaderValidator.java?rev=1707880&r1=1707879&r2=1707880&view=diff
==============================================================================
---
webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/util/stax/debug/XMLStreamReaderValidator.java
(original)
+++
webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/util/stax/debug/XMLStreamReaderValidator.java
Sat Oct 10 14:00:56 2015
@@ -29,22 +29,12 @@ import javax.xml.stream.XMLStreamReader;
import java.util.Stack;
-// TODO: this needs reformatting; the (generated) Javadoc is unreadable!
/**
- * There are several places in the code where events are passed from
- * a source to a consumer using XMLStreamReader events.
- *
- * XMLStreamReader (impl)--> consumer of XMLStreamReader events
- *
- * This simple class can be interjected as a filter and used to do some simple
validation.
- * Validating the events coming from source (impl) can help find and correct
errors
- * when they occur. Otherwise the errors may be caught much further
downstream and hard to fix.
- *
- * XMLStreamReader (impl)--> XMLStreamReaderValiator-> consumer of
XMLStreamReader events
- *
- *
- * In the initial version, the XMStreamValidator ensures that the start
element events match the
- * end element events.
+ * {@link XMLStreamReader} wrapper that performs some simple consistency
checks on the events
+ * returned by the wrapper reader. This is most useful for custom {@link
XMLStreamReader}
+ * implementations. Validating events can help find and correct errors when
they occur. Otherwise
+ * the errors may be caught much further downstream and hard to fix. In its
current version, the
+ * validator ensures that the start element events match the end element
events.
*/
public class XMLStreamReaderValidator extends XMLStreamReaderWrapper {
