This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-io.git
commit 85517c8b805a5969409ff3b95266ec4a3033d958
Author: Gary Gregory <gardgreg...@gmail.com>
AuthorDate: Mon Feb 1 10:30:33 2021 -0500
Javadoc. Close HTML tags. Use paragraph tags.
---
.../java/org/apache/commons/io/input/AutoCloseInputStream.java | 1 +
src/main/java/org/apache/commons/io/input/BOMInputStream.java | 7 ++++---
src/main/java/org/apache/commons/io/input/BoundedInputStream.java | 1 +
src/main/java/org/apache/commons/io/input/BrokenInputStream.java | 1 +
.../java/org/apache/commons/io/input/CharSequenceInputStream.java | 1 +
.../org/apache/commons/io/input/ClassLoaderObjectInputStream.java | 1 +
src/main/java/org/apache/commons/io/input/NullInputStream.java | 3 +++
src/main/java/org/apache/commons/io/input/QueueInputStream.java | 5 ++---
src/main/java/org/apache/commons/io/input/TaggedInputStream.java | 1 +
.../apache/commons/io/input/UnsupportedOperationExceptions.java | 2 ++
.../org/apache/commons/io/input/compatibility/XmlStreamReader.java | 5 +++++
.../commons/io/input/compatibility/XmlStreamReaderException.java | 1 +
12 files changed, 23 insertions(+), 6 deletions(-)
diff --git
a/src/main/java/org/apache/commons/io/input/AutoCloseInputStream.java
b/src/main/java/org/apache/commons/io/input/AutoCloseInputStream.java
index 477dbf2..8aa605d 100644
--- a/src/main/java/org/apache/commons/io/input/AutoCloseInputStream.java
+++ b/src/main/java/org/apache/commons/io/input/AutoCloseInputStream.java
@@ -32,6 +32,7 @@ import java.io.InputStream;
* stream as soon as possible even if the client application (by not explicitly
* closing the stream when no longer needed) or the underlying stream (by not
* releasing resources once the last byte has been read) do not do that.
+ * </p>
*
* @since 1.4
*/
diff --git a/src/main/java/org/apache/commons/io/input/BOMInputStream.java
b/src/main/java/org/apache/commons/io/input/BOMInputStream.java
index a890151..4e030aa 100644
--- a/src/main/java/org/apache/commons/io/input/BOMInputStream.java
+++ b/src/main/java/org/apache/commons/io/input/BOMInputStream.java
@@ -28,11 +28,13 @@ import org.apache.commons.io.IOUtils;
/**
* This class is used to wrap a stream that includes an encoded {@link
ByteOrderMark} as its first bytes.
- *
+ * <p>
* This class detects these bytes and, if required, can automatically skip
them and return the subsequent byte as the
* first byte in the stream.
- *
+ * </p>
+ * <p>
* The {@link ByteOrderMark} implementation has the following pre-defined BOMs:
+ * </p>
* <ul>
* <li>UTF-8 - {@link ByteOrderMark#UTF_8}</li>
* <li>UTF-16BE - {@link ByteOrderMark#UTF_16LE}</li>
@@ -41,7 +43,6 @@ import org.apache.commons.io.IOUtils;
* <li>UTF-32LE - {@link ByteOrderMark#UTF_32BE}</li>
* </ul>
*
- *
* <h2>Example 1 - Detect and exclude a UTF-8 BOM</h2>
*
* <pre>
diff --git a/src/main/java/org/apache/commons/io/input/BoundedInputStream.java
b/src/main/java/org/apache/commons/io/input/BoundedInputStream.java
index 5aee129..6babddb 100644
--- a/src/main/java/org/apache/commons/io/input/BoundedInputStream.java
+++ b/src/main/java/org/apache/commons/io/input/BoundedInputStream.java
@@ -31,6 +31,7 @@ import java.io.InputStream;
* So, one of these, initialized with the Content-length sent in the
* ServletInputStream's header, will stop it blocking, providing it's been sent
* with a correct content length.
+ * </p>
*
* @since 2.0
*/
diff --git a/src/main/java/org/apache/commons/io/input/BrokenInputStream.java
b/src/main/java/org/apache/commons/io/input/BrokenInputStream.java
index df39fde..d9e97f6 100644
--- a/src/main/java/org/apache/commons/io/input/BrokenInputStream.java
+++ b/src/main/java/org/apache/commons/io/input/BrokenInputStream.java
@@ -25,6 +25,7 @@ import java.io.InputStream;
* <p>
* This class is mostly useful for testing error handling in code that uses an
* input stream.
+ * </p>
*
* @since 2.0
*/
diff --git
a/src/main/java/org/apache/commons/io/input/CharSequenceInputStream.java
b/src/main/java/org/apache/commons/io/input/CharSequenceInputStream.java
index d40ba2d..b627c3c 100644
--- a/src/main/java/org/apache/commons/io/input/CharSequenceInputStream.java
+++ b/src/main/java/org/apache/commons/io/input/CharSequenceInputStream.java
@@ -35,6 +35,7 @@ import java.util.Objects;
* StringBuilder or CharBuffer.
* <p>
* <strong>Note:</strong> Supports {@link #mark(int)} and {@link #reset()}.
+ * </p>
*
* @since 2.2
*/
diff --git
a/src/main/java/org/apache/commons/io/input/ClassLoaderObjectInputStream.java
b/src/main/java/org/apache/commons/io/input/ClassLoaderObjectInputStream.java
index fd428ac..7295f9a 100644
---
a/src/main/java/org/apache/commons/io/input/ClassLoaderObjectInputStream.java
+++
b/src/main/java/org/apache/commons/io/input/ClassLoaderObjectInputStream.java
@@ -28,6 +28,7 @@ import java.lang.reflect.Proxy;
* {@code ClassLoader} rather than the system default.
* <p>
* This is useful in dynamic container environments.
+ * </p>
*
* @since 1.1
*/
diff --git a/src/main/java/org/apache/commons/io/input/NullInputStream.java
b/src/main/java/org/apache/commons/io/input/NullInputStream.java
index f66f5cb..7197bfd 100644
--- a/src/main/java/org/apache/commons/io/input/NullInputStream.java
+++ b/src/main/java/org/apache/commons/io/input/NullInputStream.java
@@ -29,12 +29,14 @@ import java.io.InputStream;
* This implementation provides a light weight
* object for testing with an {@link InputStream}
* where the contents don't matter.
+ * </p>
* <p>
* One use case would be for testing the handling of
* large {@link InputStream} as it can emulate that
* scenario without the overhead of actually processing
* large numbers of bytes - significantly speeding up
* test execution times.
+ * </p>
* <p>
* This implementation returns zero from the method that
* reads a byte and leaves the array unchanged in the read
@@ -42,6 +44,7 @@ import java.io.InputStream;
* If alternative data is required the {@code processByte()} and
* {@code processBytes()} methods can be implemented to generate
* data, for example:
+ * </p>
*
* <pre>
* public class TestInputStream extends NullInputStream {
diff --git a/src/main/java/org/apache/commons/io/input/QueueInputStream.java
b/src/main/java/org/apache/commons/io/input/QueueInputStream.java
index 02d036c..6b954a8 100644
--- a/src/main/java/org/apache/commons/io/input/QueueInputStream.java
+++ b/src/main/java/org/apache/commons/io/input/QueueInputStream.java
@@ -34,7 +34,6 @@ import java.util.concurrent.LinkedBlockingQueue;
* <p>
* Example usage:
* </p>
- *
* <pre>
* QueueInputStream inputStream = new QueueInputStream();
* QueueOutputStream outputStream = inputStream.newQueueOutputStream();
@@ -42,11 +41,11 @@ import java.util.concurrent.LinkedBlockingQueue;
* outputStream.write("hello world".getBytes(UTF_8));
* inputStream.read();
* </pre>
- *
+ * <p>
* Unlike JDK {@link PipedInputStream} and {@link PipedOutputStream}, queue
input/output streams may be used safely in a
* single thread or multiple threads. Also, unlike JDK classes, no special
meaning is attached to initial or current
* thread. Instances can be used longer after initial threads exited.
- *
+ * </p>
* <p>
* Closing a {@code QueueInputStream} has no effect. The methods in this class
can be called after the stream has been
* closed without generating an {@code IOException}.
diff --git a/src/main/java/org/apache/commons/io/input/TaggedInputStream.java
b/src/main/java/org/apache/commons/io/input/TaggedInputStream.java
index eeaec7b..d30dc84 100644
--- a/src/main/java/org/apache/commons/io/input/TaggedInputStream.java
+++ b/src/main/java/org/apache/commons/io/input/TaggedInputStream.java
@@ -48,6 +48,7 @@ import org.apache.commons.io.TaggedIOException;
* used to let higher levels of code handle the exception caused by this
* stream while other processing errors are being taken care of at this
* lower level.
+ * </p>
* <pre>
* TaggedInputStream stream = new TaggedInputStream(...);
* try {
diff --git
a/src/main/java/org/apache/commons/io/input/UnsupportedOperationExceptions.java
b/src/main/java/org/apache/commons/io/input/UnsupportedOperationExceptions.java
index 3b92200..9799e99 100644
---
a/src/main/java/org/apache/commons/io/input/UnsupportedOperationExceptions.java
+++
b/src/main/java/org/apache/commons/io/input/UnsupportedOperationExceptions.java
@@ -20,7 +20,9 @@ package org.apache.commons.io.input;
/**
* Package-private factory for {@link UnsupportedOperationException} to
provide messages with consistent formatting.
*
+ * <p>
* TODO Consider making this public and use from LineIterator but this feels
like it belongs in LANG rather than IO.
+ * </p>
*/
class UnsupportedOperationExceptions {
diff --git
a/src/test/java/org/apache/commons/io/input/compatibility/XmlStreamReader.java
b/src/test/java/org/apache/commons/io/input/compatibility/XmlStreamReader.java
index df8ed51..94d3424 100644
---
a/src/test/java/org/apache/commons/io/input/compatibility/XmlStreamReader.java
+++
b/src/test/java/org/apache/commons/io/input/compatibility/XmlStreamReader.java
@@ -42,23 +42,28 @@ import org.apache.commons.io.output.XmlStreamWriter;
* <p>
* IMPORTANT: This class is not related in any way to the
org.xml.sax.XMLReader.
* This one IS a character stream.
+ * </p>
* <p>
* All this has to be done without consuming characters from the stream, if not
* the XML parser will not recognized the document as a valid XML. This is not
* 100% true, but it's close enough (UTF-8 BOM is not handled by all parsers
* right now, XmlStreamReader handles it and things work in all parsers).
+ * </p>
* <p>
* The XmlStreamReader class handles the charset encoding of XML documents in
* Files, raw streams and HTTP streams by offering a wide set of constructors.
+ * </p>
* <p>
* By default the charset encoding detection is lenient, the constructor with
* the lenient flag can be used for a script (following HTTP MIME and XML
* specifications). All this is nicely explained by Mark Pilgrim in his blog,
<a
* href="http://diveintomark.org/archives/2004/02/13/xml-media-types";>
* Determining the character encoding of a feed</a>.
+ * </p>
* <p>
* Originally developed for <a href="http://rome.dev.java.net";>ROME</a> under
* Apache License 2.0.
+ * </p>
*
* @see XmlStreamWriter
*/
diff --git
a/src/test/java/org/apache/commons/io/input/compatibility/XmlStreamReaderException.java
b/src/test/java/org/apache/commons/io/input/compatibility/XmlStreamReaderException.java
index cb4931f..3d35bbb 100644
---
a/src/test/java/org/apache/commons/io/input/compatibility/XmlStreamReaderException.java
+++
b/src/test/java/org/apache/commons/io/input/compatibility/XmlStreamReaderException.java
@@ -27,6 +27,7 @@ import java.io.InputStream;
* do an alternate processing with the stream. Note that the original
* InputStream given to the XmlStreamReader cannot be used as that one has been
* already read.
+ * </p>
*
*/
public class XmlStreamReaderException extends
org.apache.commons.io.input.XmlStreamReaderException {
