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/02 21:38:52 UTC
[commons-io] branch master updated: Javadoc deprecation of Serializable
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 494c5a2c Javadoc deprecation of Serializable
494c5a2c is described below
commit 494c5a2cbb8bb00e31032b7a600fc7914b21d041
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Tue May 2 17:38:47 2023 -0400
Javadoc deprecation of Serializable
---
src/main/java/org/apache/commons/io/ByteOrderMark.java | 4 ++++
.../apache/commons/io/comparator/CompositeFileComparator.java | 4 ++++
.../org/apache/commons/io/comparator/DefaultFileComparator.java | 4 ++++
.../apache/commons/io/comparator/DirectoryFileComparator.java | 4 ++++
.../apache/commons/io/comparator/ExtensionFileComparator.java | 4 ++++
.../apache/commons/io/comparator/LastModifiedFileComparator.java | 4 ++++
.../org/apache/commons/io/comparator/NameFileComparator.java | 4 ++++
.../org/apache/commons/io/comparator/PathFileComparator.java | 5 ++++-
.../org/apache/commons/io/comparator/ReverseFileComparator.java | 4 ++++
.../org/apache/commons/io/comparator/SizeFileComparator.java | 8 ++++++++
.../java/org/apache/commons/io/filefilter/AgeFileFilter.java | 4 ++++
.../java/org/apache/commons/io/filefilter/AndFileFilter.java | 4 ++++
.../org/apache/commons/io/filefilter/CanExecuteFileFilter.java | 4 ++++
.../java/org/apache/commons/io/filefilter/CanReadFileFilter.java | 4 ++++
.../org/apache/commons/io/filefilter/CanWriteFileFilter.java | 9 ++++++---
.../org/apache/commons/io/filefilter/DelegateFileFilter.java | 4 ++++
.../org/apache/commons/io/filefilter/DirectoryFileFilter.java | 4 ++++
.../java/org/apache/commons/io/filefilter/EmptyFileFilter.java | 4 ++++
.../java/org/apache/commons/io/filefilter/FalseFileFilter.java | 4 ++++
.../java/org/apache/commons/io/filefilter/FileFileFilter.java | 4 ++++
.../java/org/apache/commons/io/filefilter/HiddenFileFilter.java | 4 ++++
.../org/apache/commons/io/filefilter/MagicNumberFileFilter.java | 4 ++++
.../java/org/apache/commons/io/filefilter/NameFileFilter.java | 4 ++++
.../java/org/apache/commons/io/filefilter/NotFileFilter.java | 4 ++++
src/main/java/org/apache/commons/io/filefilter/OrFileFilter.java | 4 ++++
.../java/org/apache/commons/io/filefilter/PrefixFileFilter.java | 4 ++++
.../java/org/apache/commons/io/filefilter/RegexFileFilter.java | 4 ++++
.../java/org/apache/commons/io/filefilter/SizeFileFilter.java | 4 ++++
.../java/org/apache/commons/io/filefilter/SuffixFileFilter.java | 4 ++++
.../org/apache/commons/io/filefilter/SymbolicLinkFileFilter.java | 4 ++++
.../java/org/apache/commons/io/filefilter/TrueFileFilter.java | 4 ++++
.../org/apache/commons/io/filefilter/WildcardFileFilter.java | 4 ++++
.../java/org/apache/commons/io/filefilter/WildcardFilter.java | 4 ++++
.../java/org/apache/commons/io/input/CharSequenceReader.java | 4 ++++
src/main/java/org/apache/commons/io/input/TaggedInputStream.java | 4 ++++
src/main/java/org/apache/commons/io/input/TaggedReader.java | 4 ++++
.../org/apache/commons/io/monitor/FileAlterationObserver.java | 4 ++++
src/main/java/org/apache/commons/io/monitor/FileEntry.java | 4 ++++
.../java/org/apache/commons/io/output/StringBuilderWriter.java | 5 ++++-
.../org/apache/commons/io/filefilter/RegexFileFilterTest.java | 1 +
40 files changed, 163 insertions(+), 5 deletions(-)
diff --git a/src/main/java/org/apache/commons/io/ByteOrderMark.java b/src/main/java/org/apache/commons/io/ByteOrderMark.java
index af235c3e..8762f9a0 100644
--- a/src/main/java/org/apache/commons/io/ByteOrderMark.java
+++ b/src/main/java/org/apache/commons/io/ByteOrderMark.java
@@ -23,6 +23,10 @@ import java.util.Objects;
/**
* Byte Order Mark (BOM) representation - see {@link org.apache.commons.io.input.BOMInputStream}.
+ * <h2>Deprecating Serialization</h2>
+ * <p>
+ * <em>Serialization is deprecated and will be removed in 3.0.</em>
+ * </p>
*
* @see org.apache.commons.io.input.BOMInputStream
* @see <a href="http://en.wikipedia.org/wiki/Byte_order_mark">Wikipedia: Byte Order Mark</a>
diff --git a/src/main/java/org/apache/commons/io/comparator/CompositeFileComparator.java b/src/main/java/org/apache/commons/io/comparator/CompositeFileComparator.java
index f29b2746..0f57a833 100644
--- a/src/main/java/org/apache/commons/io/comparator/CompositeFileComparator.java
+++ b/src/main/java/org/apache/commons/io/comparator/CompositeFileComparator.java
@@ -36,6 +36,10 @@ import java.util.stream.StreamSupport;
* List<File> list = ...
* comparator.sort(list);
* </pre>
+ * <h2>Deprecating Serialization</h2>
+ * <p>
+ * <em>Serialization is deprecated and will be removed in 3.0.</em>
+ * </p>
*
* @since 2.0
*/
diff --git a/src/main/java/org/apache/commons/io/comparator/DefaultFileComparator.java b/src/main/java/org/apache/commons/io/comparator/DefaultFileComparator.java
index 9a6880f2..bf5a1c9a 100644
--- a/src/main/java/org/apache/commons/io/comparator/DefaultFileComparator.java
+++ b/src/main/java/org/apache/commons/io/comparator/DefaultFileComparator.java
@@ -42,6 +42,10 @@ import java.util.Comparator;
* File[] array = ...
* ((AbstractFileComparator) DefaultFileComparator.DEFAULT_REVERSE).sort(array);
* </pre>
+ * <h2>Deprecating Serialization</h2>
+ * <p>
+ * <em>Serialization is deprecated and will be removed in 3.0.</em>
+ * </p>
*
* @since 1.4
*/
diff --git a/src/main/java/org/apache/commons/io/comparator/DirectoryFileComparator.java b/src/main/java/org/apache/commons/io/comparator/DirectoryFileComparator.java
index 34ea58d8..35f98bfa 100644
--- a/src/main/java/org/apache/commons/io/comparator/DirectoryFileComparator.java
+++ b/src/main/java/org/apache/commons/io/comparator/DirectoryFileComparator.java
@@ -42,6 +42,10 @@ import java.util.Comparator;
* File[] array = ...
* ((AbstractFileComparator) DirectoryFileComparator.DIRECTORY_REVERSE).sort(array);
* </pre>
+ * <h2>Deprecating Serialization</h2>
+ * <p>
+ * <em>Serialization is deprecated and will be removed in 3.0.</em>
+ * </p>
*
* @since 2.0
*/
diff --git a/src/main/java/org/apache/commons/io/comparator/ExtensionFileComparator.java b/src/main/java/org/apache/commons/io/comparator/ExtensionFileComparator.java
index e855fbff..6960a904 100644
--- a/src/main/java/org/apache/commons/io/comparator/ExtensionFileComparator.java
+++ b/src/main/java/org/apache/commons/io/comparator/ExtensionFileComparator.java
@@ -49,6 +49,10 @@ import org.apache.commons.io.IOCase;
* File[] array = ...
* ((AbstractFileComparator) ExtensionFileComparator.EXTENSION_INSENSITIVE_REVERSE).sort(array);
* </pre>
+ * <h2>Deprecating Serialization</h2>
+ * <p>
+ * <em>Serialization is deprecated and will be removed in 3.0.</em>
+ * </p>
*
* @since 1.4
*/
diff --git a/src/main/java/org/apache/commons/io/comparator/LastModifiedFileComparator.java b/src/main/java/org/apache/commons/io/comparator/LastModifiedFileComparator.java
index fdfadb75..7849f80b 100644
--- a/src/main/java/org/apache/commons/io/comparator/LastModifiedFileComparator.java
+++ b/src/main/java/org/apache/commons/io/comparator/LastModifiedFileComparator.java
@@ -45,6 +45,10 @@ import org.apache.commons.io.FileUtils;
* File[] array = ...
* ((AbstractFileComparator) LastModifiedFileComparator.LASTMODIFIED_REVERSE).sort(array);
* </pre>
+ * <h2>Deprecating Serialization</h2>
+ * <p>
+ * <em>Serialization is deprecated and will be removed in 3.0.</em>
+ * </p>
*
* @since 1.4
*/
diff --git a/src/main/java/org/apache/commons/io/comparator/NameFileComparator.java b/src/main/java/org/apache/commons/io/comparator/NameFileComparator.java
index db3e8b24..76f4dbd0 100644
--- a/src/main/java/org/apache/commons/io/comparator/NameFileComparator.java
+++ b/src/main/java/org/apache/commons/io/comparator/NameFileComparator.java
@@ -47,6 +47,10 @@ import org.apache.commons.io.IOCase;
* File[] array = ...
* ((AbstractFileComparator) NameFileComparator.NAME_INSENSITIVE_REVERSE).sort(array);
* </pre>
+ * <h2>Deprecating Serialization</h2>
+ * <p>
+ * <em>Serialization is deprecated and will be removed in 3.0.</em>
+ * </p>
*
* @since 1.4
*/
diff --git a/src/main/java/org/apache/commons/io/comparator/PathFileComparator.java b/src/main/java/org/apache/commons/io/comparator/PathFileComparator.java
index 4386c1a4..80579d13 100644
--- a/src/main/java/org/apache/commons/io/comparator/PathFileComparator.java
+++ b/src/main/java/org/apache/commons/io/comparator/PathFileComparator.java
@@ -47,7 +47,10 @@ import org.apache.commons.io.IOCase;
* File[] array = ...
* ((AbstractFileComparator) PathFileComparator.PATH_INSENSITIVE_REVERSE).sort(array);
* </pre>
- *
+ * <h2>Deprecating Serialization</h2>
+ * <p>
+ * <em>Serialization is deprecated and will be removed in 3.0.</em>
+ * </p>
* @since 1.4
*/
public class PathFileComparator extends AbstractFileComparator implements Serializable {
diff --git a/src/main/java/org/apache/commons/io/comparator/ReverseFileComparator.java b/src/main/java/org/apache/commons/io/comparator/ReverseFileComparator.java
index eed5bfef..8f33ec4d 100644
--- a/src/main/java/org/apache/commons/io/comparator/ReverseFileComparator.java
+++ b/src/main/java/org/apache/commons/io/comparator/ReverseFileComparator.java
@@ -23,6 +23,10 @@ import java.util.Objects;
/**
* Reverses the result of comparing two {@link File} objects using the delegate {@link Comparator}.
+ * <h2>Deprecating Serialization</h2>
+ * <p>
+ * <em>Serialization is deprecated and will be removed in 3.0.</em>
+ * </p>
*
* @since 1.4
*/
diff --git a/src/main/java/org/apache/commons/io/comparator/SizeFileComparator.java b/src/main/java/org/apache/commons/io/comparator/SizeFileComparator.java
index 0ee5e4ac..21463bd0 100644
--- a/src/main/java/org/apache/commons/io/comparator/SizeFileComparator.java
+++ b/src/main/java/org/apache/commons/io/comparator/SizeFileComparator.java
@@ -28,9 +28,11 @@ import org.apache.commons.io.FileUtils;
* <p>
* This comparator can be used to sort lists or arrays of files
* by their length/size.
+ * </p>
* <p>
* Example of sorting a list of files using the
* {@link #SIZE_COMPARATOR} singleton instance:
+ * </p>
* <pre>
* List<File> list = ...
* ((AbstractFileComparator) SizeFileComparator.SIZE_COMPARATOR).sort(list);
@@ -38,6 +40,7 @@ import org.apache.commons.io.FileUtils;
* <p>
* Example of doing a <i>reverse</i> sort of an array of files using the
* {@link #SIZE_REVERSE} singleton instance:
+ * </p>
* <pre>
* File[] array = ...
* ((AbstractFileComparator) SizeFileComparator.SIZE_REVERSE).sort(array);
@@ -45,6 +48,11 @@ import org.apache.commons.io.FileUtils;
* <p>
* <strong>N.B.</strong> Directories are treated as <b>zero size</b> unless
* {@code sumDirectoryContents} is {@code true}.
+ * </p>
+ * <h2>Deprecating Serialization</h2>
+ * <p>
+ * <em>Serialization is deprecated and will be removed in 3.0.</em>
+ * </p>
*
* @since 1.4
*/
diff --git a/src/main/java/org/apache/commons/io/filefilter/AgeFileFilter.java b/src/main/java/org/apache/commons/io/filefilter/AgeFileFilter.java
index 8f04ffa1..095571c9 100644
--- a/src/main/java/org/apache/commons/io/filefilter/AgeFileFilter.java
+++ b/src/main/java/org/apache/commons/io/filefilter/AgeFileFilter.java
@@ -63,6 +63,10 @@ import org.apache.commons.io.file.PathUtils;
* System.out.println(visitor.getDirList());
* System.out.println(visitor.getFileList());
* </pre>
+ * <h2>Deprecating Serialization</h2>
+ * <p>
+ * <em>Serialization is deprecated and will be removed in 3.0.</em>
+ * </p>
*
* @see FileFilterUtils#ageFileFilter(Date)
* @see FileFilterUtils#ageFileFilter(File)
diff --git a/src/main/java/org/apache/commons/io/filefilter/AndFileFilter.java b/src/main/java/org/apache/commons/io/filefilter/AndFileFilter.java
index e29f780e..312a7dab 100644
--- a/src/main/java/org/apache/commons/io/filefilter/AndFileFilter.java
+++ b/src/main/java/org/apache/commons/io/filefilter/AndFileFilter.java
@@ -33,6 +33,10 @@ import java.util.stream.Stream;
* list return {@code true}. Otherwise, it returns {@code false}.
* Checking of the file filter list stops when the first filter returns
* {@code false}.
+ * <h2>Deprecating Serialization</h2>
+ * <p>
+ * <em>Serialization is deprecated and will be removed in 3.0.</em>
+ * </p>
*
* @since 1.0
* @see FileFilterUtils#and(IOFileFilter...)
diff --git a/src/main/java/org/apache/commons/io/filefilter/CanExecuteFileFilter.java b/src/main/java/org/apache/commons/io/filefilter/CanExecuteFileFilter.java
index 96e8b31a..9bd55e4a 100644
--- a/src/main/java/org/apache/commons/io/filefilter/CanExecuteFileFilter.java
+++ b/src/main/java/org/apache/commons/io/filefilter/CanExecuteFileFilter.java
@@ -50,6 +50,10 @@ import java.nio.file.attribute.BasicFileAttributes;
* System.out.println(files[i]);
* }
* </pre>
+ * <h2>Deprecating Serialization</h2>
+ * <p>
+ * <em>Serialization is deprecated and will be removed in 3.0.</em>
+ * </p>
*
* @since 2.7
*/
diff --git a/src/main/java/org/apache/commons/io/filefilter/CanReadFileFilter.java b/src/main/java/org/apache/commons/io/filefilter/CanReadFileFilter.java
index a30dfae6..a1efdcc9 100644
--- a/src/main/java/org/apache/commons/io/filefilter/CanReadFileFilter.java
+++ b/src/main/java/org/apache/commons/io/filefilter/CanReadFileFilter.java
@@ -58,6 +58,10 @@ import java.nio.file.attribute.BasicFileAttributes;
* System.out.println(file);
* }
* </pre>
+ * <h2>Deprecating Serialization</h2>
+ * <p>
+ * <em>Serialization is deprecated and will be removed in 3.0.</em>
+ * </p>
*
* @since 1.3
*/
diff --git a/src/main/java/org/apache/commons/io/filefilter/CanWriteFileFilter.java b/src/main/java/org/apache/commons/io/filefilter/CanWriteFileFilter.java
index d5580278..842007bf 100644
--- a/src/main/java/org/apache/commons/io/filefilter/CanWriteFileFilter.java
+++ b/src/main/java/org/apache/commons/io/filefilter/CanWriteFileFilter.java
@@ -36,10 +36,9 @@ import java.nio.file.attribute.BasicFileAttributes;
* System.out.println(file);
* }
* </pre>
- *
* <p>
* Example, showing how to print out a list of the current directory's <i>un-writable</i> files:
- *
+ * </p>
* <pre>
* File dir = FileUtils.current();
* String[] files = dir.list(CanWriteFileFilter.CANNOT_WRITE);
@@ -47,9 +46,13 @@ import java.nio.file.attribute.BasicFileAttributes;
* System.out.println(file);
* }
* </pre>
- *
* <p>
* <b>N.B.</b> For read-only files, use {@code CanReadFileFilter.READ_ONLY}.
+ * </p>
+ * <h2>Deprecating Serialization</h2>
+ * <p>
+ * <em>Serialization is deprecated and will be removed in 3.0.</em>
+ * </p>
*
* @since 1.3
*/
diff --git a/src/main/java/org/apache/commons/io/filefilter/DelegateFileFilter.java b/src/main/java/org/apache/commons/io/filefilter/DelegateFileFilter.java
index edc15d70..14c99566 100644
--- a/src/main/java/org/apache/commons/io/filefilter/DelegateFileFilter.java
+++ b/src/main/java/org/apache/commons/io/filefilter/DelegateFileFilter.java
@@ -24,6 +24,10 @@ import java.util.Objects;
/**
* This class turns a Java FileFilter or FilenameFilter into an IO FileFilter.
+ * <h2>Deprecating Serialization</h2>
+ * <p>
+ * <em>Serialization is deprecated and will be removed in 3.0.</em>
+ * </p>
*
* @since 1.0
* @see FileFilterUtils#asFileFilter(FileFilter)
diff --git a/src/main/java/org/apache/commons/io/filefilter/DirectoryFileFilter.java b/src/main/java/org/apache/commons/io/filefilter/DirectoryFileFilter.java
index 1a5e2fa0..b02d8ffe 100644
--- a/src/main/java/org/apache/commons/io/filefilter/DirectoryFileFilter.java
+++ b/src/main/java/org/apache/commons/io/filefilter/DirectoryFileFilter.java
@@ -57,6 +57,10 @@ import java.nio.file.attribute.BasicFileAttributes;
* System.out.println(visitor.getDirList());
* System.out.println(visitor.getFileList());
* </pre>
+ * <h2>Deprecating Serialization</h2>
+ * <p>
+ * <em>Serialization is deprecated and will be removed in 3.0.</em>
+ * </p>
*
* @since 1.0
* @see FileFilterUtils#directoryFileFilter()
diff --git a/src/main/java/org/apache/commons/io/filefilter/EmptyFileFilter.java b/src/main/java/org/apache/commons/io/filefilter/EmptyFileFilter.java
index ec936745..86686e5a 100644
--- a/src/main/java/org/apache/commons/io/filefilter/EmptyFileFilter.java
+++ b/src/main/java/org/apache/commons/io/filefilter/EmptyFileFilter.java
@@ -73,6 +73,10 @@ import org.apache.commons.io.IOUtils;
* System.out.println(visitor.getDirList());
* System.out.println(visitor.getFileList());
* </pre>
+ * <h2>Deprecating Serialization</h2>
+ * <p>
+ * <em>Serialization is deprecated and will be removed in 3.0.</em>
+ * </p>
*
* @since 1.3
*/
diff --git a/src/main/java/org/apache/commons/io/filefilter/FalseFileFilter.java b/src/main/java/org/apache/commons/io/filefilter/FalseFileFilter.java
index 8119f53e..9ffb2ab6 100644
--- a/src/main/java/org/apache/commons/io/filefilter/FalseFileFilter.java
+++ b/src/main/java/org/apache/commons/io/filefilter/FalseFileFilter.java
@@ -24,6 +24,10 @@ import java.nio.file.attribute.BasicFileAttributes;
/**
* A file filter that always returns false.
+ * <h2>Deprecating Serialization</h2>
+ * <p>
+ * <em>Serialization is deprecated and will be removed in 3.0.</em>
+ * </p>
*
* @since 1.0
* @see FileFilterUtils#falseFileFilter()
diff --git a/src/main/java/org/apache/commons/io/filefilter/FileFileFilter.java b/src/main/java/org/apache/commons/io/filefilter/FileFileFilter.java
index 9cadb64f..83c69cfa 100644
--- a/src/main/java/org/apache/commons/io/filefilter/FileFileFilter.java
+++ b/src/main/java/org/apache/commons/io/filefilter/FileFileFilter.java
@@ -56,6 +56,10 @@ import java.nio.file.attribute.BasicFileAttributes;
* System.out.println(visitor.getDirList());
* System.out.println(visitor.getFileList());
* </pre>
+ * <h2>Deprecating Serialization</h2>
+ * <p>
+ * <em>Serialization is deprecated and will be removed in 3.0.</em>
+ * </p>
*
* @since 1.3
* @see FileFilterUtils#fileFileFilter()
diff --git a/src/main/java/org/apache/commons/io/filefilter/HiddenFileFilter.java b/src/main/java/org/apache/commons/io/filefilter/HiddenFileFilter.java
index c6678e82..86ef0d31 100644
--- a/src/main/java/org/apache/commons/io/filefilter/HiddenFileFilter.java
+++ b/src/main/java/org/apache/commons/io/filefilter/HiddenFileFilter.java
@@ -69,6 +69,10 @@ import java.nio.file.attribute.BasicFileAttributes;
* System.out.println(visitor.getDirList());
* System.out.println(visitor.getFileList());
* </pre>
+ * <h2>Deprecating Serialization</h2>
+ * <p>
+ * <em>Serialization is deprecated and will be removed in 3.0.</em>
+ * </p>
*
* @since 1.3
*/
diff --git a/src/main/java/org/apache/commons/io/filefilter/MagicNumberFileFilter.java b/src/main/java/org/apache/commons/io/filefilter/MagicNumberFileFilter.java
index 88bf64f3..68824a40 100644
--- a/src/main/java/org/apache/commons/io/filefilter/MagicNumberFileFilter.java
+++ b/src/main/java/org/apache/commons/io/filefilter/MagicNumberFileFilter.java
@@ -85,6 +85,10 @@ import org.apache.commons.io.RandomAccessFileMode;
* System.out.println(visitor.getDirList());
* System.out.println(visitor.getFileList());
* </pre>
+ * <h2>Deprecating Serialization</h2>
+ * <p>
+ * <em>Serialization is deprecated and will be removed in 3.0.</em>
+ * </p>
*
* @since 2.0
* @see FileFilterUtils#magicNumberFileFilter(byte[])
diff --git a/src/main/java/org/apache/commons/io/filefilter/NameFileFilter.java b/src/main/java/org/apache/commons/io/filefilter/NameFileFilter.java
index 71fe7c93..2d986cfb 100644
--- a/src/main/java/org/apache/commons/io/filefilter/NameFileFilter.java
+++ b/src/main/java/org/apache/commons/io/filefilter/NameFileFilter.java
@@ -60,6 +60,10 @@ import org.apache.commons.io.IOCase;
* System.out.println(visitor.getDirList());
* System.out.println(visitor.getFileList());
* </pre>
+ * <h2>Deprecating Serialization</h2>
+ * <p>
+ * <em>Serialization is deprecated and will be removed in 3.0.</em>
+ * </p>
*
* @since 1.0
* @see FileFilterUtils#nameFileFilter(String)
diff --git a/src/main/java/org/apache/commons/io/filefilter/NotFileFilter.java b/src/main/java/org/apache/commons/io/filefilter/NotFileFilter.java
index 1cc5d4f9..e61081bc 100644
--- a/src/main/java/org/apache/commons/io/filefilter/NotFileFilter.java
+++ b/src/main/java/org/apache/commons/io/filefilter/NotFileFilter.java
@@ -25,6 +25,10 @@ import java.util.Objects;
/**
* This filter produces a logical NOT of the filters specified.
+ * <h2>Deprecating Serialization</h2>
+ * <p>
+ * <em>Serialization is deprecated and will be removed in 3.0.</em>
+ * </p>
*
* @since 1.0
* @see FileFilterUtils#notFileFilter(IOFileFilter)
diff --git a/src/main/java/org/apache/commons/io/filefilter/OrFileFilter.java b/src/main/java/org/apache/commons/io/filefilter/OrFileFilter.java
index d8a6b19c..7d9a3666 100644
--- a/src/main/java/org/apache/commons/io/filefilter/OrFileFilter.java
+++ b/src/main/java/org/apache/commons/io/filefilter/OrFileFilter.java
@@ -31,6 +31,10 @@ import java.util.stream.Stream;
* A {@link java.io.FileFilter} providing conditional OR logic across a list of file filters. This filter returns
* {@code true} if any filters in the list return {@code true}. Otherwise, it returns {@code false}. Checking of the
* file filter list stops when the first filter returns {@code true}.
+ * <h2>Deprecating Serialization</h2>
+ * <p>
+ * <em>Serialization is deprecated and will be removed in 3.0.</em>
+ * </p>
*
* @since 1.0
* @see FileFilterUtils#or(IOFileFilter...)
diff --git a/src/main/java/org/apache/commons/io/filefilter/PrefixFileFilter.java b/src/main/java/org/apache/commons/io/filefilter/PrefixFileFilter.java
index 22081a55..13f03648 100644
--- a/src/main/java/org/apache/commons/io/filefilter/PrefixFileFilter.java
+++ b/src/main/java/org/apache/commons/io/filefilter/PrefixFileFilter.java
@@ -60,6 +60,10 @@ import org.apache.commons.io.IOCase;
* System.out.println(visitor.getDirList());
* System.out.println(visitor.getFileList());
* </pre>
+ * <h2>Deprecating Serialization</h2>
+ * <p>
+ * <em>Serialization is deprecated and will be removed in 3.0.</em>
+ * </p>
*
* @since 1.0
* @see FileFilterUtils#prefixFileFilter(String)
diff --git a/src/main/java/org/apache/commons/io/filefilter/RegexFileFilter.java b/src/main/java/org/apache/commons/io/filefilter/RegexFileFilter.java
index ea16c3b1..9bcdd806 100644
--- a/src/main/java/org/apache/commons/io/filefilter/RegexFileFilter.java
+++ b/src/main/java/org/apache/commons/io/filefilter/RegexFileFilter.java
@@ -64,6 +64,10 @@ import org.apache.commons.io.IOCase;
* System.out.println(visitor.getDirList());
* System.out.println(visitor.getFileList());
* </pre>
+ * <h2>Deprecating Serialization</h2>
+ * <p>
+ * <em>Serialization is deprecated and will be removed in 3.0.</em>
+ * </p>
*
* @since 1.4
*/
diff --git a/src/main/java/org/apache/commons/io/filefilter/SizeFileFilter.java b/src/main/java/org/apache/commons/io/filefilter/SizeFileFilter.java
index 287144a0..cdb8d9b7 100644
--- a/src/main/java/org/apache/commons/io/filefilter/SizeFileFilter.java
+++ b/src/main/java/org/apache/commons/io/filefilter/SizeFileFilter.java
@@ -58,6 +58,10 @@ import java.nio.file.attribute.BasicFileAttributes;
* System.out.println(visitor.getDirList());
* System.out.println(visitor.getFileList());
* </pre>
+ * <h2>Deprecating Serialization</h2>
+ * <p>
+ * <em>Serialization is deprecated and will be removed in 3.0.</em>
+ * </p>
*
* @since 1.2
* @see FileFilterUtils#sizeFileFilter(long)
diff --git a/src/main/java/org/apache/commons/io/filefilter/SuffixFileFilter.java b/src/main/java/org/apache/commons/io/filefilter/SuffixFileFilter.java
index dad16460..e06f5448 100644
--- a/src/main/java/org/apache/commons/io/filefilter/SuffixFileFilter.java
+++ b/src/main/java/org/apache/commons/io/filefilter/SuffixFileFilter.java
@@ -61,6 +61,10 @@ import org.apache.commons.io.IOCase;
* System.out.println(visitor.getDirList());
* System.out.println(visitor.getFileList());
* </pre>
+ * <h2>Deprecating Serialization</h2>
+ * <p>
+ * <em>Serialization is deprecated and will be removed in 3.0.</em>
+ * </p>
*
* @since 1.0
* @see FileFilterUtils#suffixFileFilter(String)
diff --git a/src/main/java/org/apache/commons/io/filefilter/SymbolicLinkFileFilter.java b/src/main/java/org/apache/commons/io/filefilter/SymbolicLinkFileFilter.java
index 9463d27c..20a0dc8c 100644
--- a/src/main/java/org/apache/commons/io/filefilter/SymbolicLinkFileFilter.java
+++ b/src/main/java/org/apache/commons/io/filefilter/SymbolicLinkFileFilter.java
@@ -56,6 +56,10 @@ import java.nio.file.attribute.BasicFileAttributes;
* System.out.println(visitor.getDirList());
* System.out.println(visitor.getFileList());
* </pre>
+ * <h2>Deprecating Serialization</h2>
+ * <p>
+ * <em>Serialization is deprecated and will be removed in 3.0.</em>
+ * </p>
*
* @since 2.11.0
* @see FileFilterUtils#fileFileFilter()
diff --git a/src/main/java/org/apache/commons/io/filefilter/TrueFileFilter.java b/src/main/java/org/apache/commons/io/filefilter/TrueFileFilter.java
index aa4001bd..e48d80a1 100644
--- a/src/main/java/org/apache/commons/io/filefilter/TrueFileFilter.java
+++ b/src/main/java/org/apache/commons/io/filefilter/TrueFileFilter.java
@@ -24,6 +24,10 @@ import java.nio.file.attribute.BasicFileAttributes;
/**
* A file filter that always returns true.
+ * <h2>Deprecating Serialization</h2>
+ * <p>
+ * <em>Serialization is deprecated and will be removed in 3.0.</em>
+ * </p>
*
* @since 1.0
* @see FileFilterUtils#trueFileFilter()
diff --git a/src/main/java/org/apache/commons/io/filefilter/WildcardFileFilter.java b/src/main/java/org/apache/commons/io/filefilter/WildcardFileFilter.java
index c5e55bc4..b6a27bb6 100644
--- a/src/main/java/org/apache/commons/io/filefilter/WildcardFileFilter.java
+++ b/src/main/java/org/apache/commons/io/filefilter/WildcardFileFilter.java
@@ -71,6 +71,10 @@ import org.apache.commons.io.build.AbstractSupplier;
* System.out.println(visitor.getDirList());
* System.out.println(visitor.getFileList());
* </pre>
+ * <h2>Deprecating Serialization</h2>
+ * <p>
+ * <em>Serialization is deprecated and will be removed in 3.0.</em>
+ * </p>
*
* @since 1.3
*/
diff --git a/src/main/java/org/apache/commons/io/filefilter/WildcardFilter.java b/src/main/java/org/apache/commons/io/filefilter/WildcardFilter.java
index 3b9eae89..007e93ef 100644
--- a/src/main/java/org/apache/commons/io/filefilter/WildcardFilter.java
+++ b/src/main/java/org/apache/commons/io/filefilter/WildcardFilter.java
@@ -72,6 +72,10 @@ import org.apache.commons.io.FilenameUtils;
* System.out.println(visitor.getDirList());
* System.out.println(visitor.getFileList());
* </pre>
+ * <h2>Deprecating Serialization</h2>
+ * <p>
+ * <em>Serialization is deprecated and will be removed in 3.0.</em>
+ * </p>
*
* @since 1.1
* @deprecated Use WildcardFileFilter. Deprecated as this class performs directory
diff --git a/src/main/java/org/apache/commons/io/input/CharSequenceReader.java b/src/main/java/org/apache/commons/io/input/CharSequenceReader.java
index 203a65f9..f77777ae 100644
--- a/src/main/java/org/apache/commons/io/input/CharSequenceReader.java
+++ b/src/main/java/org/apache/commons/io/input/CharSequenceReader.java
@@ -28,6 +28,10 @@ import java.util.Objects;
* <p>
* <strong>Note:</strong> Supports {@link #mark(int)} and {@link #reset()}.
* </p>
+ * <h2>Deprecating Serialization</h2>
+ * <p>
+ * <em>Serialization is deprecated and will be removed in 3.0.</em>
+ * </p>
*
* @since 1.4
*/
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 add4eb80..6134046e 100644
--- a/src/main/java/org/apache/commons/io/input/TaggedInputStream.java
+++ b/src/main/java/org/apache/commons/io/input/TaggedInputStream.java
@@ -58,6 +58,10 @@ import org.apache.commons.io.TaggedIOException;
* // ... or process the exception that was caused by something else
* }
* </pre>
+ * <h2>Deprecating Serialization</h2>
+ * <p>
+ * <em>Serialization is deprecated and will be removed in 3.0.</em>
+ * </p>
*
* @see TaggedIOException
* @since 2.0
diff --git a/src/main/java/org/apache/commons/io/input/TaggedReader.java b/src/main/java/org/apache/commons/io/input/TaggedReader.java
index fff91e5b..8d74b60e 100644
--- a/src/main/java/org/apache/commons/io/input/TaggedReader.java
+++ b/src/main/java/org/apache/commons/io/input/TaggedReader.java
@@ -57,6 +57,10 @@ import org.apache.commons.io.TaggedIOException;
* // ... or process the exception that was caused by something else
* }
* </pre>
+ * <h2>Deprecating Serialization</h2>
+ * <p>
+ * <em>Serialization is deprecated and will be removed in 3.0.</em>
+ * </p>
*
* @see TaggedIOException
* @since 2.7
diff --git a/src/main/java/org/apache/commons/io/monitor/FileAlterationObserver.java b/src/main/java/org/apache/commons/io/monitor/FileAlterationObserver.java
index 426f4c41..d34e825b 100644
--- a/src/main/java/org/apache/commons/io/monitor/FileAlterationObserver.java
+++ b/src/main/java/org/apache/commons/io/monitor/FileAlterationObserver.java
@@ -115,6 +115,10 @@ import org.apache.commons.io.comparator.NameFileComparator;
* basic implementation does not support. The {@link FileEntry#refresh(File)}
* method is used to determine if a file or directory has changed since the last
* check and stores the current state of the {@link File}'s properties.
+ * <h2>Deprecating Serialization</h2>
+ * <p>
+ * <em>Serialization is deprecated and will be removed in 3.0.</em>
+ * </p>
*
* @see FileAlterationListener
* @see FileAlterationMonitor
diff --git a/src/main/java/org/apache/commons/io/monitor/FileEntry.java b/src/main/java/org/apache/commons/io/monitor/FileEntry.java
index 773e1752..63964e95 100644
--- a/src/main/java/org/apache/commons/io/monitor/FileEntry.java
+++ b/src/main/java/org/apache/commons/io/monitor/FileEntry.java
@@ -44,6 +44,10 @@ import org.apache.commons.io.file.attribute.FileTimes;
* {@link #newChildInstance(File)} to return a new instance of the appropriate type.
* You may also want to override the {@link #refresh(File)} method.
* </p>
+ * <h2>Deprecating Serialization</h2>
+ * <p>
+ * <em>Serialization is deprecated and will be removed in 3.0.</em>
+ * </p>
* @see FileAlterationObserver
* @since 2.0
*/
diff --git a/src/main/java/org/apache/commons/io/output/StringBuilderWriter.java b/src/main/java/org/apache/commons/io/output/StringBuilderWriter.java
index bd9530db..398f73a7 100644
--- a/src/main/java/org/apache/commons/io/output/StringBuilderWriter.java
+++ b/src/main/java/org/apache/commons/io/output/StringBuilderWriter.java
@@ -28,7 +28,10 @@ import java.io.Writer;
* For safe usage with multiple {@link Thread}s then
* {@code java.io.StringWriter} should be used.
* </p>
- *
+ * <h2>Deprecating Serialization</h2>
+ * <p>
+ * <em>Serialization is deprecated and will be removed in 3.0.</em>
+ * </p>
* @since 2.0
*/
public class StringBuilderWriter extends Writer implements Serializable {
diff --git a/src/test/java/org/apache/commons/io/filefilter/RegexFileFilterTest.java b/src/test/java/org/apache/commons/io/filefilter/RegexFileFilterTest.java
index 3318ad13..e80ec10d 100644
--- a/src/test/java/org/apache/commons/io/filefilter/RegexFileFilterTest.java
+++ b/src/test/java/org/apache/commons/io/filefilter/RegexFileFilterTest.java
@@ -150,6 +150,7 @@ public class RegexFileFilterTest {
/**
* Tests https://issues.apache.org/jira/browse/IO-733.
+ *
* @throws IOException
*/
@SuppressWarnings("unchecked")