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
The following commit(s) were added to refs/heads/master by this push:
new 37242322 Javadoc
37242322 is described below
commit 372423224532edfef0afd87046e811cad8504735
Author: Gary Gregory <[email protected]>
AuthorDate: Tue Apr 25 16:50:21 2023 -0400
Javadoc
---
src/main/java/org/apache/commons/io/input/XmlStreamReader.java | 10 ++++++++++
1 file changed, 10 insertions(+)
diff --git a/src/main/java/org/apache/commons/io/input/XmlStreamReader.java
b/src/main/java/org/apache/commons/io/input/XmlStreamReader.java
index 8dd121bb..e5924eac 100644
--- a/src/main/java/org/apache/commons/io/input/XmlStreamReader.java
+++ b/src/main/java/org/apache/commons/io/input/XmlStreamReader.java
@@ -330,6 +330,7 @@ public class XmlStreamReader extends Reader {
* </p>
*
* @param file File to create a Reader from.
+ * @throws NullPointerException if the input is {@code null}.
* @throws IOException thrown if there is a problem reading the file.
* @deprecated Use {@link #builder()}
*/
@@ -348,6 +349,7 @@ public class XmlStreamReader extends Reader {
* </p>
*
* @param inputStream InputStream to create a Reader from.
+ * @throws NullPointerException if the input stream is {@code null}.
* @throws IOException thrown if there is a problem reading the stream.
* @deprecated Use {@link #builder()}
*/
@@ -382,6 +384,7 @@ public class XmlStreamReader extends Reader {
*
* @param inputStream InputStream to create a Reader from.
* @param lenient indicates if the charset encoding detection should
be relaxed.
+ * @throws NullPointerException if the input stream is {@code null}.
* @throws IOException thrown if there is a problem reading
the stream.
* @throws XmlStreamReaderException thrown if the charset encoding could
not be determined according to the specs.
* @deprecated Use {@link #builder()}
@@ -418,6 +421,7 @@ public class XmlStreamReader extends Reader {
* @param inputStream InputStream to create a Reader from.
* @param lenient indicates if the charset encoding detection
should be relaxed.
* @param defaultEncoding The default encoding
+ * @throws NullPointerException if the input stream is {@code null}.
* @throws IOException thrown if there is a problem reading
the stream.
* @throws XmlStreamReaderException thrown if the charset encoding could
not be determined according to the specs.
* @deprecated Use {@link #builder()}
@@ -445,6 +449,7 @@ public class XmlStreamReader extends Reader {
*
* @param inputStream InputStream to create the reader from.
* @param httpContentType content-type header to use for the resolution of
the charset encoding.
+ * @throws NullPointerException if the input stream is {@code null}.
* @throws IOException thrown if there is a problem reading the file.
* @deprecated Use {@link #builder()}
*/
@@ -481,6 +486,7 @@ public class XmlStreamReader extends Reader {
* @param inputStream InputStream to create the reader from.
* @param httpContentType content-type header to use for the resolution of
the charset encoding.
* @param lenient indicates if the charset encoding detection
should be relaxed.
+ * @throws NullPointerException if the input stream is {@code null}.
* @throws IOException thrown if there is a problem reading
the file.
* @throws XmlStreamReaderException thrown if the charset encoding could
not be determined according to the specification.
* @deprecated Use {@link #builder()}
@@ -519,6 +525,7 @@ public class XmlStreamReader extends Reader {
* @param httpContentType content-type header to use for the resolution of
the charset encoding.
* @param lenient indicates if the charset encoding detection
should be relaxed.
* @param defaultEncoding The default encoding
+ * @throws NullPointerException if the input stream is {@code null}.
* @throws IOException thrown if there is a problem reading
the file.
* @throws XmlStreamReaderException thrown if the charset encoding could
not be determined according to the specification.
* @deprecated Use {@link #builder()}
@@ -545,6 +552,7 @@ public class XmlStreamReader extends Reader {
* </p>
*
* @param file File to create a Reader from.
+ * @throws NullPointerException if the input is {@code null}.
* @throws IOException thrown if there is a problem reading the file.
* @since 2.11.0
* @deprecated Use {@link #builder()}
@@ -568,6 +576,7 @@ public class XmlStreamReader extends Reader {
* </p>
*
* @param url URL to create a Reader from.
+ * @throws NullPointerException if the input is {@code null}.
* @throws IOException thrown if there is a problem reading the stream of
the URL.
*/
public XmlStreamReader(final URL url) throws IOException {
@@ -589,6 +598,7 @@ public class XmlStreamReader extends Reader {
*
* @param urlConnection URLConnection to create a Reader from.
* @param defaultEncoding The default encoding
+ * @throws NullPointerException if the input is {@code null}.
* @throws IOException thrown if there is a problem reading the stream of
the URLConnection.
*/
public XmlStreamReader(final URLConnection urlConnection, final String
defaultEncoding) throws IOException {
