Javadoc: Add missing comments

Author: garydgregory

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);