Author: veithen
Date: Mon May 24 10:14:38 2010
New Revision: 947585
URL: http://svn.apache.org/viewvc?rev=947585&view=rev
Log:
Some quick Javadoc fixes.
Added:
webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/ext/io/package.html
webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/util/package.html
Modified:
webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/util/blob/MemoryBlob.java
webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/util/blob/OverflowBlob.java
webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/util/blob/WritableBlob.java
webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/util/namespace/MapBasedNamespaceContext.java
webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/util/stax/AbstractXMLStreamWriter.java
webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/util/stax/TextFromElementReader.java
webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/util/stax/WrappedTextNodeStreamReader.java
webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/util/stax/XMLEventUtils.java
webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/util/stax/dialect/NamespaceContextCorrectingXMLStreamReaderWrapper.java
webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/util/stax/dialect/NamespaceContextCorrectingXMLStreamWriterWrapper.java
webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/util/stax/dialect/StAXDialect.java
webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/util/stax/wrapper/WrappingXMLOutputFactory.java
webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/util/stax/xop/XOPUtils.java
Added:
webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/ext/io/package.html
URL:
http://svn.apache.org/viewvc/webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/ext/io/package.html?rev=947585&view=auto
==============================================================================
---
webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/ext/io/package.html
(added)
+++
webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/ext/io/package.html
Mon May 24 10:14:38 2010
@@ -0,0 +1,5 @@
+<html>
+<body>
+Defines Axiom specific extensions to the classes in {...@link java.io}.
+</body>
+</html>
\ No newline at end of file
Modified:
webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/util/blob/MemoryBlob.java
URL:
http://svn.apache.org/viewvc/webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/util/blob/MemoryBlob.java?rev=947585&r1=947584&r2=947585&view=diff
==============================================================================
---
webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/util/blob/MemoryBlob.java
(original)
+++
webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/util/blob/MemoryBlob.java
Mon May 24 10:14:38 2010
@@ -27,6 +27,9 @@ import java.util.List;
import org.apache.axiom.ext.io.StreamCopyException;
+/**
+ * Blob implementation that stores data in memory.
+ */
public class MemoryBlob implements WritableBlob {
// TODO: this should be configurable
final static int BUFFER_SIZE = 4096;
Modified:
webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/util/blob/OverflowBlob.java
URL:
http://svn.apache.org/viewvc/webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/util/blob/OverflowBlob.java?rev=947585&r1=947584&r2=947585&view=diff
==============================================================================
---
webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/util/blob/OverflowBlob.java
(original)
+++
webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/util/blob/OverflowBlob.java
Mon May 24 10:14:38 2010
@@ -32,16 +32,11 @@ import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
/**
- * Class representing some temporary data in the form of a byte stream.
- * <p>
- * Data is stored by writing to the output stream obtained using
- * {...@link #getOutputStream()}. It can then be read back using
- * the input stream obtained from {...@link #getInputStream()}.
- * The data is first stored into a fixed size buffer. Once this
- * buffer overflows, it is transferred to a temporary file. The buffer
- * is divided into a given number of fixed size chunks that are allocated
- * on demand. Since a temporary file may be created it is mandatory to
- * call {...@link #release()} to discard the temporary data.
+ * Blob implementation that stores data in a temporary file if the size
exceeds a configurable
+ * threshold. The data is first stored into a fixed size buffer. Once this
buffer overflows, it is
+ * transferred to a temporary file. The buffer is divided into a given number
of fixed size chunks
+ * that are allocated on demand. Since a temporary file may be created it is
mandatory to call
+ * {...@link #release()} to discard the blob.
*/
public class OverflowBlob implements WritableBlob {
private static final Log log = LogFactory.getLog(OverflowBlob.class);
Modified:
webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/util/blob/WritableBlob.java
URL:
http://svn.apache.org/viewvc/webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/util/blob/WritableBlob.java?rev=947585&r1=947584&r2=947585&view=diff
==============================================================================
---
webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/util/blob/WritableBlob.java
(original)
+++
webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/util/blob/WritableBlob.java
Mon May 24 10:14:38 2010
@@ -38,8 +38,8 @@ import org.apache.axiom.ext.io.StreamCop
* <dt>COMMITTED
* <dd>All data has been written to the blob and the blob will no longer
accept any new data.
* </dl>
- * If the blob is in state NEW or UNCOMMITTED, any call to a method defined by
the {...@link Blob}
- * superinterface will result in an {...@link IllegalStateException}.
+ * Whether or not reading data from the blob if is in state NEW or UNCOMMITTED
depends on the
+ * return value of {...@link #isSupportingReadUncommitted()}.
* <p>
* Blobs are not thread safe.
*/
@@ -127,7 +127,7 @@ public interface WritableBlob extends Bl
/**
* Read data from the given input stream and write it to the blob.
* <p>
- * This method is similar to {...@link #readFrom(InputStream, boolean)},
except that the state
+ * This method is similar to {...@link #readFrom(InputStream, long,
boolean)}, except that the state
* of the blob after the invocation (i.e. the <code>commit</code>
argument) is determined
* automatically:
* <p>
Modified:
webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/util/namespace/MapBasedNamespaceContext.java
URL:
http://svn.apache.org/viewvc/webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/util/namespace/MapBasedNamespaceContext.java?rev=947585&r1=947584&r2=947585&view=diff
==============================================================================
---
webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/util/namespace/MapBasedNamespaceContext.java
(original)
+++
webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/util/namespace/MapBasedNamespaceContext.java
Mon May 24 10:14:38 2010
@@ -25,6 +25,9 @@ import java.util.Iterator;
import java.util.Map;
import java.util.Set;
+/**
+ * Namespace context implementation that stores namespace bindings in a
{...@link Map}.
+ */
public class MapBasedNamespaceContext extends AbstractNamespaceContext {
protected Map namespaces;
Added:
webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/util/package.html
URL:
http://svn.apache.org/viewvc/webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/util/package.html?rev=947585&view=auto
==============================================================================
---
webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/util/package.html
(added)
+++
webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/util/package.html
Mon May 24 10:14:38 2010
@@ -0,0 +1,7 @@
+<html>
+<body>
+Contains utility classes not depending on the Axiom API. This package and all
its
+subpackages are meant to contain utility classes that have no dependencies on
the
+rest of the Axiom API, except for {...@link org.apache.axiom.ext}.
+</body>
+</html>
\ No newline at end of file
Modified:
webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/util/stax/AbstractXMLStreamWriter.java
URL:
http://svn.apache.org/viewvc/webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/util/stax/AbstractXMLStreamWriter.java?rev=947585&r1=947584&r2=947585&view=diff
==============================================================================
---
webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/util/stax/AbstractXMLStreamWriter.java
(original)
+++
webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/util/stax/AbstractXMLStreamWriter.java
Mon May 24 10:14:38 2010
@@ -30,8 +30,8 @@ import org.apache.commons.logging.LogFac
/**
* Partial implementation of the {...@link XMLStreamWriter} interface. It
handles namespace bindings,
* i.e. the methods related to the namespace context. Subclasses only need to
implement write
- * methods that take a prefix together with the namespace URI argument. All
{...@link XMLStreamWriter}
- * methods that have a namespace URI argument, but no prefix argument are
implemented by this class.
+ * methods that take a prefix together with the namespace URI argument. This
class implements all
+ * {...@link XMLStreamWriter} methods that have a namespace URI argument, but
no prefix argument.
*/
public abstract class AbstractXMLStreamWriter implements XMLStreamWriter {
private static final Log log =
LogFactory.getLog(AbstractXMLStreamWriter.class);
Modified:
webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/util/stax/TextFromElementReader.java
URL:
http://svn.apache.org/viewvc/webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/util/stax/TextFromElementReader.java?rev=947585&r1=947584&r2=947585&view=diff
==============================================================================
---
webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/util/stax/TextFromElementReader.java
(original)
+++
webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/util/stax/TextFromElementReader.java
Mon May 24 10:14:38 2010
@@ -30,19 +30,19 @@ import org.apache.axiom.om.OMException;
/**
* {...@link Reader} implementation that extracts the text nodes from an
element given by an
* {...@link XMLStreamReader}. The expected input is a document with only a
document
- * element (as produced by {...@link
org.apache.axiom.om.OMElement.OMElement#getXMLStreamReader()}).
+ * element (as produced by {...@link
org.apache.axiom.om.OMElement#getXMLStreamReader()}).
* The class will extract the text nodes that are direct children of that
element, i.e. it uses
- * the same conventions as {...@link
org.apache.axiom.om.OMElement.OMElement#getText()}.
+ * the same conventions as {...@link org.apache.axiom.om.OMElement#getText()}.
* It will call {...@link XMLStreamReader#close()} when the end of the
document is reached or when
* {...@link #close()} is called.
* <p>
* The main purpose of this class is to provide a convenient and efficient way
to get the text
* content of an element without converting it first to a string, i.e. without
using
- * {...@link org.apache.axiom.om.OMElement.OMElement#getText()}. This is
important for potentially
+ * {...@link org.apache.axiom.om.OMElement#getText()}. This is important for
potentially
* large contents, for which this class guarantees constant memory usage.
* <p>
* Note that this class should in general not be used directly. Instead,
- * {...@link ElementHelper#getTextAsStream(org.apache.axiom.om.OMElement)}
+ * {...@link
org.apache.axiom.om.util.ElementHelper#getTextAsStream(org.apache.axiom.om.OMElement)}
* should be called to get the most efficient stream implementation for a
given an element.
*/
public class TextFromElementReader extends Reader {
Modified:
webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/util/stax/WrappedTextNodeStreamReader.java
URL:
http://svn.apache.org/viewvc/webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/util/stax/WrappedTextNodeStreamReader.java?rev=947585&r1=947584&r2=947585&view=diff
==============================================================================
---
webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/util/stax/WrappedTextNodeStreamReader.java
(original)
+++
webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/util/stax/WrappedTextNodeStreamReader.java
Mon May 24 10:14:38 2010
@@ -33,7 +33,7 @@ import javax.xml.stream.XMLStreamReader;
import org.apache.axiom.util.namespace.MapBasedNamespaceContext;
/**
- * {...@link XMLInputStreamReader} implementation that
+ * {...@link XMLStreamReader} implementation that
* represents a text node wrapped inside an element. The text data is provided
by a
* {...@link java.io.Reader Reader}.
* <p>
Modified:
webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/util/stax/XMLEventUtils.java
URL:
http://svn.apache.org/viewvc/webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/util/stax/XMLEventUtils.java?rev=947585&r1=947584&r2=947585&view=diff
==============================================================================
---
webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/util/stax/XMLEventUtils.java
(original)
+++
webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/util/stax/XMLEventUtils.java
Mon May 24 10:14:38 2010
@@ -20,6 +20,9 @@ package org.apache.axiom.util.stax;
import javax.xml.stream.XMLStreamConstants;
+/**
+ * Contains utility methods related to StAX events.
+ */
public final class XMLEventUtils {
private XMLEventUtils() {}
Modified:
webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/util/stax/dialect/NamespaceContextCorrectingXMLStreamReaderWrapper.java
URL:
http://svn.apache.org/viewvc/webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/util/stax/dialect/NamespaceContextCorrectingXMLStreamReaderWrapper.java?rev=947585&r1=947584&r2=947585&view=diff
==============================================================================
---
webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/util/stax/dialect/NamespaceContextCorrectingXMLStreamReaderWrapper.java
(original)
+++
webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/util/stax/dialect/NamespaceContextCorrectingXMLStreamReaderWrapper.java
Mon May 24 10:14:38 2010
@@ -35,7 +35,7 @@ import org.apache.axiom.util.stax.wrappe
* {...@link XMLStreamReader#getNamespaceContext()} and {...@link
XMLStreamReader#getNamespaceURI(String)}
* methods. Invocations of these two methods will therefore never reach the
underlying reader.
*/
-public class NamespaceContextCorrectingXMLStreamReaderWrapper extends
XMLStreamReaderWrapper {
+class NamespaceContextCorrectingXMLStreamReaderWrapper extends
XMLStreamReaderWrapper {
private final ScopedNamespaceContext namespaceContext = new
ScopedNamespaceContext();
/**
Modified:
webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/util/stax/dialect/NamespaceContextCorrectingXMLStreamWriterWrapper.java
URL:
http://svn.apache.org/viewvc/webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/util/stax/dialect/NamespaceContextCorrectingXMLStreamWriterWrapper.java?rev=947585&r1=947584&r2=947585&view=diff
==============================================================================
---
webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/util/stax/dialect/NamespaceContextCorrectingXMLStreamWriterWrapper.java
(original)
+++
webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/util/stax/dialect/NamespaceContextCorrectingXMLStreamWriterWrapper.java
Mon May 24 10:14:38 2010
@@ -66,7 +66,7 @@ import org.apache.axiom.util.stax.Abstra
* This implies that if the wrapper is used, these methods will never be
called on the underlying
* writer.
*/
-public class NamespaceContextCorrectingXMLStreamWriterWrapper extends
AbstractXMLStreamWriter {
+class NamespaceContextCorrectingXMLStreamWriterWrapper extends
AbstractXMLStreamWriter {
private final XMLStreamWriter parent;
public NamespaceContextCorrectingXMLStreamWriterWrapper(XMLStreamWriter
parent) {
Modified:
webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/util/stax/dialect/StAXDialect.java
URL:
http://svn.apache.org/viewvc/webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/util/stax/dialect/StAXDialect.java?rev=947585&r1=947584&r2=947585&view=diff
==============================================================================
---
webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/util/stax/dialect/StAXDialect.java
(original)
+++
webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/util/stax/dialect/StAXDialect.java
Mon May 24 10:14:38 2010
@@ -156,7 +156,7 @@ public interface StAXDialect {
/**
* Configure the given factory to enable reporting of CDATA sections by
stream readers created
* from it. The example in the documentation of the
- * {...@link java.xml.stream.XMLStreamReader#next()} method suggests that
even if the parser is non
+ * {...@link javax.xml.stream.XMLStreamReader#next()} method suggests that
even if the parser is non
* coalescing, CDATA sections should be reported as CHARACTERS events.
Some implementations
* strictly follow the example, while for others it is sufficient to make
the parser non
* coalescing.
Modified:
webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/util/stax/wrapper/WrappingXMLOutputFactory.java
URL:
http://svn.apache.org/viewvc/webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/util/stax/wrapper/WrappingXMLOutputFactory.java?rev=947585&r1=947584&r2=947585&view=diff
==============================================================================
---
webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/util/stax/wrapper/WrappingXMLOutputFactory.java
(original)
+++
webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/util/stax/wrapper/WrappingXMLOutputFactory.java
Mon May 24 10:14:38 2010
@@ -47,7 +47,7 @@ public class WrappingXMLOutputFactory ex
* which to wrap {...@link XMLEventWriter} instances created from the
factory. The default
* implementation simply returns the unwrapped writer.
*
- * @param reader
+ * @param writer
* the writer to wrap
* @return the wrapped writer
*/
@@ -60,7 +60,7 @@ public class WrappingXMLOutputFactory ex
* which to wrap {...@link XMLStreamWriter} instances created from the
factory. The default
* implementation simply returns the unwrapped writer.
*
- * @param reader
+ * @param writer
* the writer to wrap
* @return the wrapped writer
*/
Modified:
webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/util/stax/xop/XOPUtils.java
URL:
http://svn.apache.org/viewvc/webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/util/stax/xop/XOPUtils.java?rev=947585&r1=947584&r2=947585&view=diff
==============================================================================
---
webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/util/stax/xop/XOPUtils.java
(original)
+++
webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/util/stax/xop/XOPUtils.java
Mon May 24 10:14:38 2010
@@ -29,6 +29,9 @@ import javax.xml.stream.XMLStreamReader;
import org.apache.axiom.om.impl.builder.DataHandlerReaderUtils;
+/**
+ * Contains utility methods related to XOP.
+ */
public class XOPUtils {
private static final MimePartProvider nullMimePartProvider = new
MimePartProvider() {
public boolean isLoaded(String contentID) {
