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 20d8a001 Javadoc
20d8a001 is described below
commit 20d8a001fe871d5a30ae07c7aea8b70f8704ff8b
Author: Gary Gregory <garydgreg...@gmail.com>
AuthorDate: Wed Oct 11 07:40:56 2023 -0400
Javadoc
Make private static classes final
---
src/main/java/org/apache/commons/io/IOIndexedException.java | 3 +++
.../org/apache/commons/io/comparator/CompositeFileComparator.java | 3 +++
src/main/java/org/apache/commons/io/file/PathUtils.java | 6 +++---
src/main/java/org/apache/commons/io/input/ByteBufferCleaner.java | 4 ++--
.../java/org/apache/commons/io/input/ReversedLinesFileReader.java | 3 +++
src/test/java/org/apache/commons/io/DemuxInputStreamTest.java | 4 ++--
src/test/java/org/apache/commons/io/DirectoryWalkerTest.java | 4 ++--
.../java/org/apache/commons/io/DirectoryWalkerTestCaseJava4.java | 2 +-
src/test/java/org/apache/commons/io/function/IOBaseStreamTest.java | 4 ++--
src/test/java/org/apache/commons/io/function/IOFunctionTest.java | 2 +-
src/test/java/org/apache/commons/io/input/BOMInputStreamTest.java | 2 +-
.../apache/commons/io/input/ClassLoaderObjectInputStreamTest.java | 2 +-
.../java/org/apache/commons/io/input/MarkShieldInputStreamTest.java | 2 +-
.../java/org/apache/commons/io/input/ObservableInputStreamTest.java | 4 ++--
src/test/java/org/apache/commons/io/input/ProxyReaderTest.java | 4 ++--
src/test/java/org/apache/commons/io/input/TailerTest.java | 4 ++--
.../org/apache/commons/io/input/XmlStreamReaderUtilitiesTest.java | 2 +-
.../compatibility/XmlStreamReaderUtilitiesCompatibilityTest.java | 2 +-
.../org/apache/commons/io/output/ByteArrayOutputStreamTest.java | 4 ++--
19 files changed, 35 insertions(+), 26 deletions(-)
diff --git a/src/main/java/org/apache/commons/io/IOIndexedException.java
b/src/main/java/org/apache/commons/io/IOIndexedException.java
index 9a85328e..1893509f 100644
--- a/src/main/java/org/apache/commons/io/IOIndexedException.java
+++ b/src/main/java/org/apache/commons/io/IOIndexedException.java
@@ -42,6 +42,9 @@ public class IOIndexedException extends IOException {
return String.format("%s #%,d: %s", name, index, msg);
}
+ /**
+ * Index.
+ */
private final int index;
/**
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 0f57a833..0e264341 100644
---
a/src/main/java/org/apache/commons/io/comparator/CompositeFileComparator.java
+++
b/src/main/java/org/apache/commons/io/comparator/CompositeFileComparator.java
@@ -48,6 +48,9 @@ public class CompositeFileComparator extends
AbstractFileComparator implements S
private static final Comparator<?>[] EMPTY_COMPARATOR_ARRAY = {};
private static final long serialVersionUID = -2224170307287243428L;
+ /**
+ * Delegates.
+ */
private final Comparator<File>[] delegates;
/**
diff --git a/src/main/java/org/apache/commons/io/file/PathUtils.java
b/src/main/java/org/apache/commons/io/file/PathUtils.java
index 71ab166e..d85fdb67 100644
--- a/src/main/java/org/apache/commons/io/file/PathUtils.java
+++ b/src/main/java/org/apache/commons/io/file/PathUtils.java
@@ -90,7 +90,7 @@ public final class PathUtils {
* Private worker/holder that computes and tracks relative path names and
their equality. We reuse the sorted relative
* lists when comparing directories.
*/
- private static class RelativeSortedPaths {
+ private static final class RelativeSortedPaths {
final boolean equals;
// final List<Path> relativeDirList1; // might need later?
@@ -365,7 +365,7 @@ public final class PathUtils {
* Creates the parent directories for the given {@code path}.
* <p>
* If the parent directory already exists, then return it.
- * <p>
+ * </p>
*
* @param path The path to a file (or directory).
* @param attrs An optional list of file attributes to set atomically when
creating the directories.
@@ -381,7 +381,7 @@ public final class PathUtils {
* Creates the parent directories for the given {@code path}.
* <p>
* If the parent directory already exists, then return it.
- * <p>
+ * </p>
*
* @param path The path to a file (or directory).
* @param linkOption A {@link LinkOption} or null.
diff --git a/src/main/java/org/apache/commons/io/input/ByteBufferCleaner.java
b/src/main/java/org/apache/commons/io/input/ByteBufferCleaner.java
index fc334e96..72b1b1e8 100644
--- a/src/main/java/org/apache/commons/io/input/ByteBufferCleaner.java
+++ b/src/main/java/org/apache/commons/io/input/ByteBufferCleaner.java
@@ -38,7 +38,7 @@ class ByteBufferCleaner {
void clean(ByteBuffer buffer) throws ReflectiveOperationException;
}
- private static class Java8Cleaner implements Cleaner {
+ private static final class Java8Cleaner implements Cleaner {
private final Method cleanerMethod;
private final Method cleanMethod;
@@ -57,7 +57,7 @@ class ByteBufferCleaner {
}
}
- private static class Java9Cleaner implements Cleaner {
+ private static final class Java9Cleaner implements Cleaner {
private final Object theUnsafe;
private final Method invokeCleaner;
diff --git
a/src/main/java/org/apache/commons/io/input/ReversedLinesFileReader.java
b/src/main/java/org/apache/commons/io/input/ReversedLinesFileReader.java
index 04c9cf91..7ef620fe 100644
--- a/src/main/java/org/apache/commons/io/input/ReversedLinesFileReader.java
+++ b/src/main/java/org/apache/commons/io/input/ReversedLinesFileReader.java
@@ -66,6 +66,9 @@ public class ReversedLinesFileReader implements Closeable {
*/
public static class Builder extends
AbstractStreamBuilder<ReversedLinesFileReader, Builder> {
+ /**
+ * Constructs a new Builder.
+ */
public Builder() {
setBufferSizeDefault(DEFAULT_BLOCK_SIZE);
setBufferSize(DEFAULT_BLOCK_SIZE);
diff --git a/src/test/java/org/apache/commons/io/DemuxInputStreamTest.java
b/src/test/java/org/apache/commons/io/DemuxInputStreamTest.java
index 6872bc54..73466c21 100644
--- a/src/test/java/org/apache/commons/io/DemuxInputStreamTest.java
+++ b/src/test/java/org/apache/commons/io/DemuxInputStreamTest.java
@@ -37,7 +37,7 @@ import org.junit.jupiter.api.Test;
*/
public class DemuxInputStreamTest {
- private static class ReaderThread extends Thread {
+ private static final class ReaderThread extends Thread {
private final DemuxInputStream demuxInputStream;
private final InputStream inputStream;
private final StringBuffer stringBuffer = new StringBuffer();
@@ -72,7 +72,7 @@ public class DemuxInputStreamTest {
}
}
- private static class WriterThread extends Thread {
+ private static final class WriterThread extends Thread {
private final byte[] byteArray;
private final DemuxOutputStream demuxOutputStream;
private final OutputStream outputStream;
diff --git a/src/test/java/org/apache/commons/io/DirectoryWalkerTest.java
b/src/test/java/org/apache/commons/io/DirectoryWalkerTest.java
index 5ac3aa9c..8089a5ea 100644
--- a/src/test/java/org/apache/commons/io/DirectoryWalkerTest.java
+++ b/src/test/java/org/apache/commons/io/DirectoryWalkerTest.java
@@ -90,7 +90,7 @@ public class DirectoryWalkerTest {
* Test DirectoryWalker implementation that always returns false
* from handleDirectoryStart()
*/
- private static class TestFalseFileFinder extends TestFileFinder {
+ private static final class TestFalseFileFinder extends TestFileFinder {
protected TestFalseFileFinder(final FileFilter filter, final int
depthLimit) {
super(filter, depthLimit);
@@ -143,7 +143,7 @@ public class DirectoryWalkerTest {
* Test DirectoryWalker implementation that finds files in a directory
hierarchy
* applying a file filter.
*/
- private static class TestFileFinderString extends DirectoryWalker<String> {
+ private static final class TestFileFinderString extends
DirectoryWalker<String> {
protected TestFileFinderString(final FileFilter filter, final int
depthLimit) {
super(filter, depthLimit);
diff --git
a/src/test/java/org/apache/commons/io/DirectoryWalkerTestCaseJava4.java
b/src/test/java/org/apache/commons/io/DirectoryWalkerTestCaseJava4.java
index f55699ad..6d1720d8 100644
--- a/src/test/java/org/apache/commons/io/DirectoryWalkerTestCaseJava4.java
+++ b/src/test/java/org/apache/commons/io/DirectoryWalkerTestCaseJava4.java
@@ -102,7 +102,7 @@ public class DirectoryWalkerTestCaseJava4 {
* Test DirectoryWalker implementation that always returns false
* from handleDirectoryStart()
*/
- private static class TestFalseFileFinder extends TestFileFinder {
+ private static final class TestFalseFileFinder extends TestFileFinder {
protected TestFalseFileFinder(final FileFilter filter, final int
depthLimit) {
super(filter, depthLimit);
diff --git a/src/test/java/org/apache/commons/io/function/IOBaseStreamTest.java
b/src/test/java/org/apache/commons/io/function/IOBaseStreamTest.java
index 1c05418c..a0bd3e47 100644
--- a/src/test/java/org/apache/commons/io/function/IOBaseStreamTest.java
+++ b/src/test/java/org/apache/commons/io/function/IOBaseStreamTest.java
@@ -67,7 +67,7 @@ public class IOBaseStreamTest {
/**
* Implements IOBaseStream with a concrete type.
*/
- private static class IOBaseStreamPathFixture<B extends BaseStream<Path,
B>> extends IOBaseStreamFixture<Path, IOBaseStreamPathFixture<B>, B> {
+ private static final class IOBaseStreamPathFixture<B extends
BaseStream<Path, B>> extends IOBaseStreamFixture<Path,
IOBaseStreamPathFixture<B>, B> {
private IOBaseStreamPathFixture(final B baseStream) {
super(baseStream);
@@ -80,7 +80,7 @@ public class IOBaseStreamTest {
}
- private static class MyRuntimeException extends RuntimeException {
+ private static final class MyRuntimeException extends RuntimeException {
private static final long serialVersionUID = 1L;
diff --git a/src/test/java/org/apache/commons/io/function/IOFunctionTest.java
b/src/test/java/org/apache/commons/io/function/IOFunctionTest.java
index 1032aeee..cdb3c01d 100644
--- a/src/test/java/org/apache/commons/io/function/IOFunctionTest.java
+++ b/src/test/java/org/apache/commons/io/function/IOFunctionTest.java
@@ -38,7 +38,7 @@ import org.junit.jupiter.api.Test;
*/
public class IOFunctionTest {
- private static class Holder<T> {
+ private static final class Holder<T> {
T value;
}
diff --git a/src/test/java/org/apache/commons/io/input/BOMInputStreamTest.java
b/src/test/java/org/apache/commons/io/input/BOMInputStreamTest.java
index a79cb1c9..17b7d817 100644
--- a/src/test/java/org/apache/commons/io/input/BOMInputStreamTest.java
+++ b/src/test/java/org/apache/commons/io/input/BOMInputStreamTest.java
@@ -52,7 +52,7 @@ public class BOMInputStreamTest {
/**
* A mock InputStream that expects {@code close()} to be called.
*/
- private static class ExpectCloseInputStream extends InputStream {
+ private static final class ExpectCloseInputStream extends InputStream {
private boolean _closeCalled;
public void assertCloseCalled() {
diff --git
a/src/test/java/org/apache/commons/io/input/ClassLoaderObjectInputStreamTest.java
b/src/test/java/org/apache/commons/io/input/ClassLoaderObjectInputStreamTest.java
index 2e8d0f53..3b341ba0 100644
---
a/src/test/java/org/apache/commons/io/input/ClassLoaderObjectInputStreamTest.java
+++
b/src/test/java/org/apache/commons/io/input/ClassLoaderObjectInputStreamTest.java
@@ -43,7 +43,7 @@ public class ClassLoaderObjectInputStreamTest {
A, B, C
}
- private static class Test implements Serializable {
+ private static final class Test implements Serializable {
private static final long serialVersionUID = 1L;
private final int i;
diff --git
a/src/test/java/org/apache/commons/io/input/MarkShieldInputStreamTest.java
b/src/test/java/org/apache/commons/io/input/MarkShieldInputStreamTest.java
index a72e0f3c..ba0944ef 100644
--- a/src/test/java/org/apache/commons/io/input/MarkShieldInputStreamTest.java
+++ b/src/test/java/org/apache/commons/io/input/MarkShieldInputStreamTest.java
@@ -28,7 +28,7 @@ import org.junit.jupiter.api.Test;
public class MarkShieldInputStreamTest {
- private static class MarkTestableInputStream extends ProxyInputStream {
+ private static final class MarkTestableInputStream extends
ProxyInputStream {
int markcount;
int readlimit;
diff --git
a/src/test/java/org/apache/commons/io/input/ObservableInputStreamTest.java
b/src/test/java/org/apache/commons/io/input/ObservableInputStreamTest.java
index 0a0e9150..4c9b193b 100644
--- a/src/test/java/org/apache/commons/io/input/ObservableInputStreamTest.java
+++ b/src/test/java/org/apache/commons/io/input/ObservableInputStreamTest.java
@@ -35,7 +35,7 @@ import org.junit.jupiter.api.Test;
*/
public class ObservableInputStreamTest {
- private static class DataViewObserver extends MethodCountObserver {
+ private static final class DataViewObserver extends MethodCountObserver {
private byte[] buffer;
private int lastValue = -1;
private int length = -1;
@@ -55,7 +55,7 @@ public class ObservableInputStreamTest {
}
}
- private static class LengthObserver extends Observer {
+ private static final class LengthObserver extends Observer {
private long total;
@Override
diff --git a/src/test/java/org/apache/commons/io/input/ProxyReaderTest.java
b/src/test/java/org/apache/commons/io/input/ProxyReaderTest.java
index b176d480..110d11d2 100644
--- a/src/test/java/org/apache/commons/io/input/ProxyReaderTest.java
+++ b/src/test/java/org/apache/commons/io/input/ProxyReaderTest.java
@@ -28,7 +28,7 @@ import org.junit.jupiter.api.Test;
public class ProxyReaderTest {
/** Custom NullReader implementation. */
- private static class CustomNullReader extends NullReader {
+ private static final class CustomNullReader extends NullReader {
CustomNullReader(final int len) {
super(len);
}
@@ -45,7 +45,7 @@ public class ProxyReaderTest {
}
/** ProxyReader implementation. */
- private static class ProxyReaderImpl extends ProxyReader {
+ private static final class ProxyReaderImpl extends ProxyReader {
ProxyReaderImpl(final Reader proxy) {
super(proxy);
}
diff --git a/src/test/java/org/apache/commons/io/input/TailerTest.java
b/src/test/java/org/apache/commons/io/input/TailerTest.java
index bc5cffd1..783e1718 100644
--- a/src/test/java/org/apache/commons/io/input/TailerTest.java
+++ b/src/test/java/org/apache/commons/io/input/TailerTest.java
@@ -60,7 +60,7 @@ import org.junit.jupiter.api.io.TempDir;
*/
public class TailerTest {
- private static class NonStandardTailable implements Tailer.Tailable {
+ private static final class NonStandardTailable implements Tailer.Tailable {
private final File file;
@@ -115,7 +115,7 @@ public class TailerTest {
/**
* Test {@link TailerListener} implementation.
*/
- private static class TestTailerListener extends TailerListenerAdapter {
+ private static final class TestTailerListener extends
TailerListenerAdapter {
// Must be synchronized because it is written by one thread and read
by another
private final List<String> lines = Collections.synchronizedList(new
ArrayList<>());
diff --git
a/src/test/java/org/apache/commons/io/input/XmlStreamReaderUtilitiesTest.java
b/src/test/java/org/apache/commons/io/input/XmlStreamReaderUtilitiesTest.java
index e2cd2e68..821df8a6 100644
---
a/src/test/java/org/apache/commons/io/input/XmlStreamReaderUtilitiesTest.java
+++
b/src/test/java/org/apache/commons/io/input/XmlStreamReaderUtilitiesTest.java
@@ -31,7 +31,7 @@ import org.junit.jupiter.api.Test;
public class XmlStreamReaderUtilitiesTest {
/** Mock {@link XmlStreamReader} implementation */
- private static class MockXmlStreamReader extends XmlStreamReader {
+ private static final class MockXmlStreamReader extends XmlStreamReader {
MockXmlStreamReader(final String defaultEncoding) throws IOException {
super(CharSequenceInputStream.builder().setCharSequence("").get(),
null, true, defaultEncoding);
}
diff --git
a/src/test/java/org/apache/commons/io/input/compatibility/XmlStreamReaderUtilitiesCompatibilityTest.java
b/src/test/java/org/apache/commons/io/input/compatibility/XmlStreamReaderUtilitiesCompatibilityTest.java
index ee4310a8..acfeb742 100644
---
a/src/test/java/org/apache/commons/io/input/compatibility/XmlStreamReaderUtilitiesCompatibilityTest.java
+++
b/src/test/java/org/apache/commons/io/input/compatibility/XmlStreamReaderUtilitiesCompatibilityTest.java
@@ -27,7 +27,7 @@ import
org.apache.commons.io.input.XmlStreamReaderUtilitiesTest;
public class XmlStreamReaderUtilitiesCompatibilityTest extends
XmlStreamReaderUtilitiesTest {
/** Mock {@link XmlStreamReader} implementation */
- private static class MockXmlStreamReader extends XmlStreamReader {
+ private static final class MockXmlStreamReader extends XmlStreamReader {
MockXmlStreamReader(final String defaultEncoding) throws IOException {
super(CharSequenceInputStream.builder().setCharSequence("").get(),
null, true, defaultEncoding);
}
diff --git
a/src/test/java/org/apache/commons/io/output/ByteArrayOutputStreamTest.java
b/src/test/java/org/apache/commons/io/output/ByteArrayOutputStreamTest.java
index 2d11e58c..a65961d0 100644
--- a/src/test/java/org/apache/commons/io/output/ByteArrayOutputStreamTest.java
+++ b/src/test/java/org/apache/commons/io/output/ByteArrayOutputStreamTest.java
@@ -46,7 +46,7 @@ public class ByteArrayOutputStreamTest {
T newInstance(final int size);
}
- private static class ByteArrayOutputStreamFactory implements
BAOSFactory<ByteArrayOutputStream> {
+ private static final class ByteArrayOutputStreamFactory implements
BAOSFactory<ByteArrayOutputStream> {
@Override
public ByteArrayOutputStream newInstance() {
return new ByteArrayOutputStream();
@@ -58,7 +58,7 @@ public class ByteArrayOutputStreamTest {
}
}
- private static class UnsynchronizedByteArrayOutputStreamFactory implements
BAOSFactory<UnsynchronizedByteArrayOutputStream> {
+ private static final class UnsynchronizedByteArrayOutputStreamFactory
implements BAOSFactory<UnsynchronizedByteArrayOutputStream> {
@Override
public UnsynchronizedByteArrayOutputStream newInstance() {
return new UnsynchronizedByteArrayOutputStream();
