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 e99c56f1 Javadoc: Normalize @deprecated e99c56f1 is described below commit e99c56f1e7985576af0d2a5943459d70bc6ab85f Author: Gary Gregory <garydgreg...@gmail.com> AuthorDate: Thu Jan 25 14:05:35 2024 -0500 Javadoc: Normalize @deprecated We don't need to specify when a method was @deprecated. --- src/main/java/org/apache/commons/io/CopyUtils.java | 8 ++--- src/main/java/org/apache/commons/io/FileUtils.java | 12 ++++---- src/main/java/org/apache/commons/io/IOUtils.java | 34 +++++++++++----------- .../io/output/AbstractByteArrayOutputStream.java | 2 +- .../commons/io/output/LockableFileWriter.java | 2 +- 5 files changed, 29 insertions(+), 29 deletions(-) diff --git a/src/main/java/org/apache/commons/io/CopyUtils.java b/src/main/java/org/apache/commons/io/CopyUtils.java index 4dc6de41..ad562aa6 100644 --- a/src/main/java/org/apache/commons/io/CopyUtils.java +++ b/src/main/java/org/apache/commons/io/CopyUtils.java @@ -131,7 +131,7 @@ public class CopyUtils { * @param input the byte array to read from * @param output the {@link Writer} to write to * @throws IOException In case of an I/O problem - * @deprecated 2.5 use {@link #copy(byte[], Writer, String)} instead + * @deprecated Use {@link #copy(byte[], Writer, String)} instead */ @Deprecated public static void copy(final byte[] input, final Writer output) throws IOException { @@ -183,7 +183,7 @@ public class CopyUtils { * @param input the {@link InputStream} to read from * @param output the {@link Writer} to write to * @throws IOException In case of an I/O problem - * @deprecated 2.5 use {@link #copy(InputStream, Writer, String)} instead + * @deprecated Use {@link #copy(InputStream, Writer, String)} instead */ @Deprecated public static void copy( @@ -223,7 +223,7 @@ public class CopyUtils { * @param input the {@link Reader} to read from * @param output the {@link OutputStream} to write to * @throws IOException In case of an I/O problem - * @deprecated 2.5 use {@link #copy(Reader, OutputStream, String)} instead + * @deprecated Use {@link #copy(Reader, OutputStream, String)} instead */ @Deprecated public static void copy( @@ -293,7 +293,7 @@ public class CopyUtils { * @param input the {@link String} to read from * @param output the {@link OutputStream} to write to * @throws IOException In case of an I/O problem - * @deprecated 2.5 use {@link #copy(String, OutputStream, String)} instead + * @deprecated Use {@link #copy(String, OutputStream, String)} instead */ @Deprecated public static void copy( diff --git a/src/main/java/org/apache/commons/io/FileUtils.java b/src/main/java/org/apache/commons/io/FileUtils.java index f83cf09b..c7bbbdfc 100644 --- a/src/main/java/org/apache/commons/io/FileUtils.java +++ b/src/main/java/org/apache/commons/io/FileUtils.java @@ -2658,7 +2658,7 @@ public class FileUtils { * @throws IOException if an I/O error occurs, including when the file does not exist, is a directory rather than a * regular file, or for some other reason why the file cannot be opened for reading. * @since 1.3.1 - * @deprecated 2.5 use {@link #readFileToString(File, Charset)} instead (and specify the appropriate encoding) + * @deprecated Use {@link #readFileToString(File, Charset)} instead (and specify the appropriate encoding) */ @Deprecated public static String readFileToString(final File file) throws IOException { @@ -2708,7 +2708,7 @@ public class FileUtils { * @throws IOException if an I/O error occurs, including when the file does not exist, is a directory rather than a * regular file, or for some other reason why the file cannot be opened for reading. * @since 1.3 - * @deprecated 2.5 use {@link #readLines(File, Charset)} instead (and specify the appropriate encoding) + * @deprecated Use {@link #readLines(File, Charset)} instead (and specify the appropriate encoding) */ @Deprecated public static List<String> readLines(final File file) throws IOException { @@ -3137,7 +3137,7 @@ public class FileUtils { * @param data the content to write to the file * @throws IOException in case of an I/O error * @since 2.0 - * @deprecated 2.5 use {@link #write(File, CharSequence, Charset)} instead (and specify the appropriate encoding) + * @deprecated Use {@link #write(File, CharSequence, Charset)} instead (and specify the appropriate encoding) */ @Deprecated public static void write(final File file, final CharSequence data) throws IOException { @@ -3153,7 +3153,7 @@ public class FileUtils { * end of the file rather than overwriting * @throws IOException in case of an I/O error * @since 2.1 - * @deprecated 2.5 use {@link #write(File, CharSequence, Charset, boolean)} instead (and specify the appropriate encoding) + * @deprecated Use {@link #write(File, CharSequence, Charset, boolean)} instead (and specify the appropriate encoding) */ @Deprecated public static void write(final File file, final CharSequence data, final boolean append) throws IOException { @@ -3436,7 +3436,7 @@ public class FileUtils { * @param file the file to write * @param data the content to write to the file * @throws IOException in case of an I/O error - * @deprecated 2.5 use {@link #writeStringToFile(File, String, Charset)} instead (and specify the appropriate encoding) + * @deprecated Use {@link #writeStringToFile(File, String, Charset)} instead (and specify the appropriate encoding) */ @Deprecated public static void writeStringToFile(final File file, final String data) throws IOException { @@ -3452,7 +3452,7 @@ public class FileUtils { * end of the file rather than overwriting * @throws IOException in case of an I/O error * @since 2.1 - * @deprecated 2.5 use {@link #writeStringToFile(File, String, Charset, boolean)} instead (and specify the appropriate encoding) + * @deprecated Use {@link #writeStringToFile(File, String, Charset, boolean)} instead (and specify the appropriate encoding) */ @Deprecated public static void writeStringToFile(final File file, final String data, final boolean append) throws IOException { diff --git a/src/main/java/org/apache/commons/io/IOUtils.java b/src/main/java/org/apache/commons/io/IOUtils.java index cd818a41..03a2bc24 100644 --- a/src/main/java/org/apache/commons/io/IOUtils.java +++ b/src/main/java/org/apache/commons/io/IOUtils.java @@ -1123,7 +1123,7 @@ public class IOUtils { * @throws NullPointerException if the input or output is null * @throws IOException if an I/O error occurs * @since 1.1 - * @deprecated 2.5 use {@link #copy(InputStream, Writer, Charset)} instead + * @deprecated Use {@link #copy(InputStream, Writer, Charset)} instead */ @Deprecated public static void copy(final InputStream input, final Writer writer) @@ -1287,7 +1287,7 @@ public class IOUtils { * @throws NullPointerException if the input or output is null * @throws IOException if an I/O error occurs * @since 1.1 - * @deprecated 2.5 use {@link #copy(Reader, OutputStream, Charset)} instead + * @deprecated Use {@link #copy(Reader, OutputStream, Charset)} instead */ @Deprecated public static void copy(final Reader reader, final OutputStream output) @@ -2178,7 +2178,7 @@ public class IOUtils { * @throws NullPointerException if the input is null * @throws UncheckedIOException if an I/O error occurs * @since 1.1 - * @deprecated 2.5 use {@link #readLines(InputStream, Charset)} instead + * @deprecated Use {@link #readLines(InputStream, Charset)} instead */ @Deprecated public static List<String> readLines(final InputStream input) throws UncheckedIOException { @@ -2799,7 +2799,7 @@ public class IOUtils { * @return the requested byte array * @throws NullPointerException if the input is null * @throws IOException if an I/O error occurs - * @deprecated 2.5 use {@link #toByteArray(Reader, Charset)} instead + * @deprecated Use {@link #toByteArray(Reader, Charset)} instead */ @Deprecated public static byte[] toByteArray(final Reader reader) throws IOException { @@ -2864,7 +2864,7 @@ public class IOUtils { * @param input the {@link String} to convert * @return the requested byte array * @throws NullPointerException if the input is null - * @deprecated 2.5 Use {@link String#getBytes()} instead + * @deprecated Use {@link String#getBytes()} instead */ @Deprecated public static byte[] toByteArray(final String input) { @@ -2928,7 +2928,7 @@ public class IOUtils { * @throws NullPointerException if the input is null * @throws IOException if an I/O error occurs * @since 1.1 - * @deprecated 2.5 use {@link #toCharArray(InputStream, Charset)} instead + * @deprecated Use {@link #toCharArray(InputStream, Charset)} instead */ @Deprecated public static char[] toCharArray(final InputStream inputStream) throws IOException { @@ -3009,7 +3009,7 @@ public class IOUtils { * @param input the CharSequence to convert * @return an input stream * @since 2.0 - * @deprecated 2.5 use {@link #toInputStream(CharSequence, Charset)} instead + * @deprecated Use {@link #toInputStream(CharSequence, Charset)} instead */ @Deprecated public static InputStream toInputStream(final CharSequence input) { @@ -3056,7 +3056,7 @@ public class IOUtils { * @param input the string to convert * @return an input stream * @since 1.1 - * @deprecated 2.5 use {@link #toInputStream(String, Charset)} instead + * @deprecated Use {@link #toInputStream(String, Charset)} instead */ @Deprecated public static InputStream toInputStream(final String input) { @@ -3103,7 +3103,7 @@ public class IOUtils { * @param input the byte array to read * @return the requested String * @throws NullPointerException if the input is null - * @deprecated 2.5 Use {@link String#String(byte[])} instead + * @deprecated Use {@link String#String(byte[])} instead */ @Deprecated public static String toString(final byte[] input) { @@ -3140,7 +3140,7 @@ public class IOUtils { * @return the requested String * @throws NullPointerException if the input is null * @throws IOException if an I/O error occurs - * @deprecated 2.5 use {@link #toString(InputStream, Charset)} instead + * @deprecated Use {@link #toString(InputStream, Charset)} instead */ @Deprecated public static String toString(final InputStream input) throws IOException { @@ -3267,7 +3267,7 @@ public class IOUtils { * @return The contents of the URL as a String. * @throws IOException if an I/O exception occurs. * @since 2.1 - * @deprecated 2.5 use {@link #toString(URI, Charset)} instead + * @deprecated Use {@link #toString(URI, Charset)} instead */ @Deprecated public static String toString(final URI uri) throws IOException { @@ -3310,7 +3310,7 @@ public class IOUtils { * @return The contents of the URL as a String. * @throws IOException if an I/O exception occurs. * @since 2.1 - * @deprecated 2.5 use {@link #toString(URL, Charset)} instead + * @deprecated Use {@link #toString(URL, Charset)} instead */ @Deprecated public static String toString(final URL url) throws IOException { @@ -3376,7 +3376,7 @@ public class IOUtils { * @throws NullPointerException if output is null * @throws IOException if an I/O error occurs * @since 1.1 - * @deprecated 2.5 use {@link #write(byte[], Writer, Charset)} instead + * @deprecated Use {@link #write(byte[], Writer, Charset)} instead */ @Deprecated public static void write(final byte[] data, final Writer writer) throws IOException { @@ -3444,7 +3444,7 @@ public class IOUtils { * @throws NullPointerException if output is null * @throws IOException if an I/O error occurs * @since 1.1 - * @deprecated 2.5 use {@link #write(char[], OutputStream, Charset)} instead + * @deprecated Use {@link #write(char[], OutputStream, Charset)} instead */ @Deprecated public static void write(final char[] data, final OutputStream output) @@ -3530,7 +3530,7 @@ public class IOUtils { * @throws NullPointerException if output is null * @throws IOException if an I/O error occurs * @since 2.0 - * @deprecated 2.5 use {@link #write(CharSequence, OutputStream, Charset)} instead + * @deprecated Use {@link #write(CharSequence, OutputStream, Charset)} instead */ @Deprecated public static void write(final CharSequence data, final OutputStream output) @@ -3612,7 +3612,7 @@ public class IOUtils { * @throws NullPointerException if output is null * @throws IOException if an I/O error occurs * @since 1.1 - * @deprecated 2.5 use {@link #write(String, OutputStream, Charset)} instead + * @deprecated Use {@link #write(String, OutputStream, Charset)} instead */ @Deprecated public static void write(final String data, final OutputStream output) @@ -3814,7 +3814,7 @@ public class IOUtils { * @throws NullPointerException if the output is null * @throws IOException if an I/O error occurs * @since 1.1 - * @deprecated 2.5 use {@link #writeLines(Collection, String, OutputStream, Charset)} instead + * @deprecated Use {@link #writeLines(Collection, String, OutputStream, Charset)} instead */ @Deprecated public static void writeLines(final Collection<?> lines, final String lineEnding, diff --git a/src/main/java/org/apache/commons/io/output/AbstractByteArrayOutputStream.java b/src/main/java/org/apache/commons/io/output/AbstractByteArrayOutputStream.java index 830624d9..236116e4 100644 --- a/src/main/java/org/apache/commons/io/output/AbstractByteArrayOutputStream.java +++ b/src/main/java/org/apache/commons/io/output/AbstractByteArrayOutputStream.java @@ -263,7 +263,7 @@ public abstract class AbstractByteArrayOutputStream extends OutputStream { * using the platform default charset. * @return the contents of the byte array as a String * @see java.io.ByteArrayOutputStream#toString() - * @deprecated 2.5 use {@link #toString(String)} instead + * @deprecated Use {@link #toString(String)} instead */ @Override @Deprecated diff --git a/src/main/java/org/apache/commons/io/output/LockableFileWriter.java b/src/main/java/org/apache/commons/io/output/LockableFileWriter.java index acc28f7d..d197270f 100644 --- a/src/main/java/org/apache/commons/io/output/LockableFileWriter.java +++ b/src/main/java/org/apache/commons/io/output/LockableFileWriter.java @@ -192,7 +192,7 @@ public class LockableFileWriter extends Writer { * @param lockDir the directory in which the lock file should be held * @throws NullPointerException if the file is null * @throws IOException in case of an I/O error - * @deprecated 2.5 use {@link #LockableFileWriter(File, Charset, boolean, String)} instead + * @deprecated Use {@link #LockableFileWriter(File, Charset, boolean, String)} instead */ @Deprecated public LockableFileWriter(final File file, final boolean append, final String lockDir) throws IOException {