You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by gg...@apache.org on 2023/05/18 21:06:17 UTC

[commons-io] 10/13: Javadoc

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 bd3c2d9ba9ab3834277fba1b7995dd3b2a308bcb
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Thu May 18 16:31:26 2023 -0400

    Javadoc
---
 .../org/apache/commons/io/input/XmlStreamReader.java     | 16 ++++++++--------
 1 file changed, 8 insertions(+), 8 deletions(-)

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 3ccf0a41..74902e3d 100644
--- a/src/main/java/org/apache/commons/io/input/XmlStreamReader.java
+++ b/src/main/java/org/apache/commons/io/input/XmlStreamReader.java
@@ -340,7 +340,7 @@ public class XmlStreamReader extends Reader {
      * @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()}
+     * @deprecated Use {@link #builder()} and {@link Builder#get()}
      */
     @Deprecated
     public XmlStreamReader(final File file) throws IOException {
@@ -359,7 +359,7 @@ public class XmlStreamReader extends Reader {
      * @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()}
+     * @deprecated Use {@link #builder()} and {@link Builder#get()}
      */
     @Deprecated
     public XmlStreamReader(final InputStream inputStream) throws IOException {
@@ -395,7 +395,7 @@ public class XmlStreamReader extends Reader {
      * @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()}
+     * @deprecated Use {@link #builder()} and {@link Builder#get()}
      */
     @Deprecated
     public XmlStreamReader(final InputStream inputStream, final boolean lenient) throws IOException {
@@ -432,7 +432,7 @@ public class XmlStreamReader extends Reader {
      * @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()}
+     * @deprecated Use {@link #builder()} and {@link Builder#get()}
      */
     @Deprecated
     @SuppressWarnings("resource") // InputStream is managed through a InputStreamReader in this instance.
@@ -459,7 +459,7 @@ public class XmlStreamReader extends Reader {
      * @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()}
+     * @deprecated Use {@link #builder()} and {@link Builder#get()}
      */
     @Deprecated
     public XmlStreamReader(final InputStream inputStream, final String httpContentType) throws IOException {
@@ -497,7 +497,7 @@ public class XmlStreamReader extends Reader {
      * @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()}
+     * @deprecated Use {@link #builder()} and {@link Builder#get()}
      */
     @Deprecated
     public XmlStreamReader(final InputStream inputStream, final String httpContentType, final boolean lenient) throws IOException {
@@ -536,7 +536,7 @@ public class XmlStreamReader extends Reader {
      * @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()}
+     * @deprecated Use {@link #builder()} and {@link Builder#get()}
      */
     @Deprecated
     @SuppressWarnings("resource") // InputStream is managed through a InputStreamReader in this instance.
@@ -563,7 +563,7 @@ public class XmlStreamReader extends Reader {
      * @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()}
+     * @deprecated Use {@link #builder()} and {@link Builder#get()}
      */
     @Deprecated
     @SuppressWarnings("resource") // InputStream is managed through another reader in this instance.