Javadoc: Add missing comments

checkstyle-suppressions.xml

@@ -37,7 +37,7 @@
   <suppress checks="FinalClass" files="URIUtils.java"/>
   <suppress checks="FinalClass" files="ZipFileSystemConfigBuilder.java"/>
   <!-- Can't change method name without breaking binary compatibility. -->
-  <suppress checks="MethodName" files="DefaultFileSystemManager.java" lines="185"/>
+  <suppress checks="MethodName" files="DefaultFileSystemManager.java" lines="192"/>
   <!-- Use of literals here is reasonable. -->
   <suppress checks="MagicNumber" files="URIUtils.java" lines="143, 152, 162"/>
   <suppress checks="MagicNumber" files="RamFileRandomAccessContent.java"/>

commons-vfs2-hdfs/src/main/java/org/apache/commons/vfs2/provider/hdfs/HdfsFileSystemConfigBuilder.java

@@ -52,6 +52,9 @@ public static HdfsFileSystemConfigBuilder getInstance() {
         return BUILDER;
     }
 
+    /**
+     * Constructs a new instance.
+     */
     private HdfsFileSystemConfigBuilder() {
         super("hdfs.");
     }

commons-vfs2-sandbox/src/main/java/org/apache/commons/vfs2/provider/smb/SmbFileNameParser.java

@@ -42,7 +42,7 @@ public static FileNameParser getInstance() {
     }
 
     /**
-     * Creates a new instance with the default port 139.
+     * Constructs a new instance with the default port 139.
      */
     public SmbFileNameParser() {
         super(SMB_PORT);

commons-vfs2/src/main/java/org/apache/commons/vfs2/AllFileSelector.java

@@ -21,6 +21,13 @@
  */
 public class AllFileSelector implements FileSelector {
 
+    /**
+     * Constructs a new instance.
+     */
+    public AllFileSelector() {
+        // empty
+    }
+
     /**
      * Determines if a file or folder should be selected.
      *

commons-vfs2/src/main/java/org/apache/commons/vfs2/FileSystemConfigBuilder.java

@@ -478,20 +478,6 @@ protected <T> T getParam(final FileSystemOptions fileSystemOptions, final String
         return fileSystemOptions == null ? null : fileSystemOptions.getOption(getConfigClass(), name);
     }
 
-    /**
-     * Gets a named parameter.
-     *
-     * @param <T> The expected return type.
-     * @param fileSystemOptions file system options to query, may be null.
-     * @param name get option with this name
-     * @param defaultValue The default value if absent.
-     * @return the named option or {@code defaultValue}.
-     * @since 2.10.0
-     */
-    protected <T> T getParamOrDefault(final FileSystemOptions fileSystemOptions, final String name, final T defaultValue) {
-        return fileSystemOptions == null ? defaultValue : fileSystemOptions.getOptionOrDefault(getConfigClass(), name, defaultValue);
-    }
-
     /**
      * Gets a named parameter.
      *
@@ -518,6 +504,20 @@ private <T> T getParam(final FileSystemOptions fileSystemOptions, final String n
         return value;
     }
 
+    /**
+     * Gets a named parameter.
+     *
+     * @param <T> The expected return type.
+     * @param fileSystemOptions file system options to query, may be null.
+     * @param name get option with this name
+     * @param defaultValue The default value if absent.
+     * @return the named option or {@code defaultValue}.
+     * @since 2.10.0
+     */
+    protected <T> T getParamOrDefault(final FileSystemOptions fileSystemOptions, final String name, final T defaultValue) {
+        return fileSystemOptions == null ? defaultValue : fileSystemOptions.getOptionOrDefault(getConfigClass(), name, defaultValue);
+    }
+
     /**
      * Gets the system property for the given name.
      *

commons-vfs2/src/main/java/org/apache/commons/vfs2/cache/AbstractFilesCache.java

@@ -25,6 +25,13 @@
  */
 public abstract class AbstractFilesCache extends AbstractVfsComponent implements FilesCache {
 
+    /**
+     * Constructs a new instance for subclasses.
+     */
+    public AbstractFilesCache() {
+        // empty
+    }
+
     /**
      * Default implementation is a NOOP.
      *

commons-vfs2/src/main/java/org/apache/commons/vfs2/cache/DefaultFilesCache.java

@@ -50,6 +50,13 @@ public class DefaultFilesCache extends AbstractFilesCache {
     /** The FileSystem cache. Keeps one Map for each FileSystem. */
     private final ConcurrentMap<FileSystem, ConcurrentMap<FileName, FileObject>> fileSystemCache = new ConcurrentHashMap<>(10);
 
+    /**
+     * Constructs a new instance.
+     */
+    public DefaultFilesCache() {
+        // empty
+    }
+
     @Override
     public void clear(final FileSystem filesystem) {
         // avoid keeping a reference to the FileSystem (key) object

commons-vfs2/src/main/java/org/apache/commons/vfs2/cache/NullFilesCache.java

@@ -32,6 +32,13 @@
  */
 public class NullFilesCache extends AbstractFilesCache {
 
+    /**
+     * Constructs a new instance.
+     */
+    public NullFilesCache() {
+        // empty
+    }
+
     @Override
     public void clear(final FileSystem filesystem) {
         // empty

commons-vfs2/src/main/java/org/apache/commons/vfs2/cache/SoftRefFilesCache.java

@@ -115,7 +115,7 @@ private synchronized void close(final FileSystem fileSystem) {
     }
 
     /**
-     * Creates a new Reference.
+     * Constructs a new Reference.
      *
      * @param file a file object.
      * @param referenceQueue a ReferenceQueue.

commons-vfs2/src/main/java/org/apache/commons/vfs2/cache/WeakRefFilesCache.java

@@ -31,6 +31,13 @@
  */
 public class WeakRefFilesCache extends SoftRefFilesCache {
 
+    /**
+     * Constructs a new instance.
+     */
+    public WeakRefFilesCache() {
+        // empty
+    }
+
     @Override
     protected Reference<FileObject> createReference(final FileObject file, final ReferenceQueue<FileObject> refqueue) {
         return new WeakReference<>(file, refqueue);

commons-vfs2/src/main/java/org/apache/commons/vfs2/events/AbstractFileChangeEvent.java

@@ -26,7 +26,7 @@
 public abstract class AbstractFileChangeEvent extends FileChangeEvent {
 
     /**
-     * Constructs a new instance.
+     * Constructs a new instance for subclasses.
      *
      * @param fileObject the file object.
      */

commons-vfs2/src/main/java/org/apache/commons/vfs2/impl/DefaultFileMonitor.java

@@ -79,8 +79,6 @@
 // TODO Add a Builder so we can construct and start.
 public class DefaultFileMonitor implements Runnable, FileMonitor, AutoCloseable {
 
-    private static final ThreadFactory THREAD_FACTORY = new BasicThreadFactory.Builder().daemon(true).priority(Thread.MIN_PRIORITY).build();
-
     /**
      * File monitor agent.
      */
@@ -266,6 +264,8 @@ private void resetChildrenList() {
 
     }
 
+    private static final ThreadFactory THREAD_FACTORY = new BasicThreadFactory.Builder().daemon(true).priority(Thread.MIN_PRIORITY).build();
+
     private static final Log LOG = LogFactory.getLog(DefaultFileMonitor.class);
 
     private static final Duration DEFAULT_DELAY = Duration.ofSeconds(1);

commons-vfs2/src/main/java/org/apache/commons/vfs2/impl/DefaultFileSystemConfigBuilder.java

@@ -25,6 +25,7 @@
  * Default options usable for all file systems.
  */
 public class DefaultFileSystemConfigBuilder extends FileSystemConfigBuilder {
+
     /**
      * Dummy class that implements FileSystem.
      */
@@ -43,6 +44,13 @@ public static DefaultFileSystemConfigBuilder getInstance() {
         return BUILDER;
     }
 
+    /**
+     * Constructs a new instance.
+     */
+    public DefaultFileSystemConfigBuilder() {
+        // empty
+    }
+
     @Override
     protected Class<? extends FileSystem> getConfigClass() {
         return DefaultFileSystem.class;

commons-vfs2/src/main/java/org/apache/commons/vfs2/impl/DefaultFileSystemManager.java

@@ -174,6 +174,13 @@ public URLStreamHandler createURLStreamHandler(final String protocol) {
      */
     private boolean init;
 
+    /**
+     * Constructs a new instance.
+     */
+    public DefaultFileSystemManager() {
+        // empty
+    }
+
     /**
      * Closes the given file system.
      * <p>

commons-vfs2/src/main/java/org/apache/commons/vfs2/impl/DefaultProviderConfiguration.java

@@ -20,6 +20,14 @@
  * Same as {@link ProviderConfiguration} but for the default provider.
  */
 public class DefaultProviderConfiguration extends ProviderConfiguration {
+
+    /**
+     * Constructs a new instance.
+     */
+    public DefaultProviderConfiguration() {
+        // empty
+    }
+
     @Override
     public boolean isDefault() {
         return true;

commons-vfs2/src/main/java/org/apache/commons/vfs2/impl/FileContentInfoFilenameFactory.java

@@ -32,6 +32,13 @@ public class FileContentInfoFilenameFactory implements FileContentInfoFactory {
 
     private static final FileContentInfo NULL_INSTANCE = new DefaultFileContentInfo(null, null);
 
+    /**
+     * Constructs a new instance.
+     */
+    public FileContentInfoFilenameFactory() {
+        // empty
+    }
+
     @Override
     public FileContentInfo create(final FileContent fileContent) {
         String contentType = null;

commons-vfs2/src/main/java/org/apache/commons/vfs2/impl/StandardFileSystemManager.java

@@ -53,6 +53,13 @@ public class StandardFileSystemManager extends DefaultFileSystemManager {
     private URL configUri;
     private ClassLoader classLoader;
 
+    /**
+     * Constructs a new instance.
+     */
+    public StandardFileSystemManager() {
+        // empty
+    }
+
     /**
      * Adds an extension map.
      *

commons-vfs2/src/main/java/org/apache/commons/vfs2/impl/VirtualFileProvider.java

@@ -30,6 +30,13 @@
  */
 public class VirtualFileProvider extends AbstractVfsContainer {
 
+    /**
+     * Constructs a new instance.
+     */
+    public VirtualFileProvider() {
+        // empty
+    }
+
     /**
      * Close a VirtualFileSystem by removing it from the {@code #components} list of this provider.
      * <p>

commons-vfs2/src/main/java/org/apache/commons/vfs2/operations/AbstractFileOperation.java

@@ -30,6 +30,8 @@ public abstract class AbstractFileOperation implements FileOperation {
     private final FileObject fileObject;
 
     /**
+     * Constructs a new instance for subclasses.
+     *
      * @param file The FileObject.
      */
     public AbstractFileOperation(final FileObject file) {

commons-vfs2/src/main/java/org/apache/commons/vfs2/operations/AbstractFileOperationProvider.java

@@ -35,6 +35,13 @@ public abstract class AbstractFileOperationProvider implements FileOperationProv
      */
     private final Collection<Class<? extends FileOperation>> operations = new ArrayList<>();
 
+    /**
+     * Constructs a new instance for subclasses.
+     */
+    public AbstractFileOperationProvider() {
+        // empty
+    }
+
     /**
      * Add new FileOperation to list of known operations.
      *

commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/AbstractFileName.java

@@ -92,7 +92,7 @@ public static boolean checkName(final String basePath, final String path, final
     private String key;
 
     /**
-     * Constructs a new instance.
+     * Constructs a new instance for subclasses.
      *
      * @param scheme The scheme.
      * @param absolutePath the absolute path, maybe empty or null.

commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/AbstractFileNameParser.java

@@ -21,6 +21,13 @@
  */
 public abstract class AbstractFileNameParser implements FileNameParser {
 
+    /**
+     * Constructs a new instance for subclasses.
+     */
+    public AbstractFileNameParser() {
+        // empty
+    }
+
     @Override
     public boolean encodeCharacter(final char ch) {
         return ch == '%';

commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/AbstractFileObject.java

@@ -137,7 +137,7 @@ private static void traverse(final DefaultFileSelectorInfo fileInfo, final FileS
     private FileOperations operations;
 
     /**
-     * Constructs a new instance.
+     * Constructs a new instance for subclasses.
      *
      * @param fileName the file name.
      * @param fileSystem the file system.

commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/AbstractFileProvider.java

@@ -46,7 +46,7 @@ public abstract class AbstractFileProvider extends AbstractVfsContainer implemen
     private FileNameParser fileNameParser;
 
     /**
-     * Constructs a new instance.
+     * Constructs a new instance for subclasses.
      */
     public AbstractFileProvider() {
         fileNameParser = GenericFileNameParser.getInstance();

commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/AbstractFileSystem.java

@@ -97,7 +97,9 @@ public abstract class AbstractFileSystem extends AbstractVfsComponent implements
      */
     private final AtomicInteger openStreams = new AtomicInteger();
 
-    /** Only provided for Serializable subclasses. */
+    /**
+     * Only provided for Serializable subclasses.
+     */
     AbstractFileSystem() {
         this(null, null, null);
     }

commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/AbstractLayeredFileProvider.java

@@ -28,7 +28,7 @@
 public abstract class AbstractLayeredFileProvider extends AbstractFileProvider {
 
     /**
-     * Constructs a new instance.
+     * Constructs a new instance for subclasses.
      */
     public AbstractLayeredFileProvider() {
         setFileNameParser(LayeredFileNameParser.getInstance());

commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/AbstractOriginatingFileProvider.java

@@ -29,7 +29,7 @@
 public abstract class AbstractOriginatingFileProvider extends AbstractFileProvider {
 
     /**
-     * Constructs a new instance.
+     * Constructs a new instance for subclasses.
      */
     public AbstractOriginatingFileProvider() {
     }

commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/AbstractRandomAccessContent.java

@@ -32,7 +32,7 @@
 public abstract class AbstractRandomAccessContent implements RandomAccessContent {
 
     /**
-     * Constructs a new instance.
+     * Constructs a new instance for subclasses.
      *
      * @param mode the RandomAccessMode.
      */

commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/AbstractRandomAccessStreamContent.java

@@ -28,7 +28,7 @@
 public abstract class AbstractRandomAccessStreamContent extends AbstractRandomAccessContent {
 
     /**
-     * Constructs a new instance.
+     * Constructs a new instance for subclasses.
      *
      * @param mode the RandomAccessMode.
      */

commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/AbstractVfsComponent.java

@@ -27,6 +27,13 @@ public abstract class AbstractVfsComponent implements VfsComponent {
     private VfsComponentContext context;
     private Log log;
 
+    /**
+     * Constructs a new instance for subclasses.
+     */
+    public AbstractVfsComponent() {
+        // empty
+    }
+
     /**
      * Closes the provider. This implementation does nothing.
      */