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-vfs.git
The following commit(s) were added to refs/heads/master by this push: new a6d3b34b No need for blank Javadoc lines between Javadoc @ tags a6d3b34b is described below commit a6d3b34be65ddd61275f21d3a56e0155d60c5654 Author: Gary Gregory <garydgreg...@gmail.com> AuthorDate: Fri Nov 29 07:08:53 2024 -0500 No need for blank Javadoc lines between Javadoc @ tags --- .../webdav4/Webdav4FileSystemConfigBuilder.java | 2 - .../commons/vfs2/FileSystemConfigBuilder.java | 45 ---------------------- .../org/apache/commons/vfs2/FileSystemManager.java | 2 - .../apache/commons/vfs2/PatternFileSelector.java | 2 - .../apache/commons/vfs2/filter/AgeFileFilter.java | 1 - .../commons/vfs2/filter/CanExecuteFileFilter.java | 1 - .../commons/vfs2/filter/CanReadFileFilter.java | 1 - .../commons/vfs2/filter/CanWriteFileFilter.java | 1 - .../commons/vfs2/filter/ConditionalFileFilter.java | 1 - .../commons/vfs2/filter/DirectoryFileFilter.java | 1 - .../commons/vfs2/filter/EmptyFileFilter.java | 1 - .../commons/vfs2/filter/FalseFileFilter.java | 1 - .../apache/commons/vfs2/filter/FileFileFilter.java | 1 - .../commons/vfs2/filter/HiddenFileFilter.java | 1 - .../apache/commons/vfs2/filter/NameFileFilter.java | 1 - .../apache/commons/vfs2/filter/NotFileFilter.java | 1 - .../commons/vfs2/filter/PrefixFileFilter.java | 1 - .../commons/vfs2/filter/RegexFileFilter.java | 1 - .../apache/commons/vfs2/filter/SizeFileFilter.java | 1 - .../commons/vfs2/filter/SuffixFileFilter.java | 1 - .../vfs2/filter/SymbolicLinkFileFilter.java | 1 - .../apache/commons/vfs2/filter/TrueFileFilter.java | 1 - .../commons/vfs2/filter/WildcardFileFilter.java | 1 - .../apache/commons/vfs2/function/VfsConsumer.java | 1 - .../vfs2/impl/DefaultFileSystemManager.java | 2 - .../vfs2/operations/DefaultFileOperations.java | 1 - .../vfs2/operations/FileOperationProvider.java | 2 - .../commons/vfs2/operations/FileOperations.java | 1 - .../apache/commons/vfs2/provider/UriParser.java | 1 - .../vfs2/provider/bzip2/Bzip2FileObject.java | 1 - .../commons/vfs2/provider/gzip/GzipFileObject.java | 1 - .../vfs2/provider/http4/Http4FileObject.java | 2 - .../vfs2/provider/http5/Http5FileObject.java | 1 - .../provider/sftp/SftpFileSystemConfigBuilder.java | 1 - .../apache/commons/vfs2/util/FileObjectUtils.java | 1 - .../apache/commons/vfs2/filter/BaseFilterTest.java | 8 ---- 36 files changed, 93 deletions(-) diff --git a/commons-vfs2-jackrabbit2/src/main/java/org/apache/commons/vfs2/provider/webdav4/Webdav4FileSystemConfigBuilder.java b/commons-vfs2-jackrabbit2/src/main/java/org/apache/commons/vfs2/provider/webdav4/Webdav4FileSystemConfigBuilder.java index 6d6d1302..8f8825d6 100644 --- a/commons-vfs2-jackrabbit2/src/main/java/org/apache/commons/vfs2/provider/webdav4/Webdav4FileSystemConfigBuilder.java +++ b/commons-vfs2-jackrabbit2/src/main/java/org/apache/commons/vfs2/provider/webdav4/Webdav4FileSystemConfigBuilder.java @@ -62,7 +62,6 @@ public final class Webdav4FileSystemConfigBuilder extends Http4FileSystemConfigB * @param opts The FileSystem options. * @return {@code true} to follow redirects, {@code false} not to. * @see #setAppendTrailingSlash - * * @since 2.10.0 */ public boolean getAppendTrailingSlash(final FileSystemOptions opts) { @@ -114,7 +113,6 @@ public final class Webdav4FileSystemConfigBuilder extends Http4FileSystemConfigB * * @param opts The FileSystem options. * @param appendTrailingSlash {@code true} to append slash, {@code false} not to. - * * @since 2.10.0 */ public void setAppendTrailingSlash(final FileSystemOptions opts, final boolean appendTrailingSlash) { diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileSystemConfigBuilder.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileSystemConfigBuilder.java index 4a39aef4..c0855bd7 100644 --- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileSystemConfigBuilder.java +++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileSystemConfigBuilder.java @@ -50,7 +50,6 @@ public abstract class FileSystemConfigBuilder { * Constructs builder with specified component name. * * @param component component name to be used in prefix - * * @since 2.0 */ protected FileSystemConfigBuilder(final String component) { @@ -64,7 +63,6 @@ public abstract class FileSystemConfigBuilder { * @param name the option name * @return the option in {@code opts} or system properties, otherwise null * @see #getBoolean(FileSystemOptions, String, Boolean) - * * @since 2.0 */ protected Boolean getBoolean(final FileSystemOptions fileSystemOptions, final String name) { @@ -79,7 +77,6 @@ public abstract class FileSystemConfigBuilder { * @param defaultValue value to return if option is not present * @return the option in {@code opts} or system properties, otherwise {@code defaultValue} * @see #getBoolean(FileSystemOptions, String, Boolean) - * * @since 2.0 */ protected boolean getBoolean(final FileSystemOptions fileSystemOptions, final String name, @@ -95,7 +92,6 @@ public abstract class FileSystemConfigBuilder { * @param defaultValue value to return if option is not present * @return the option in {@code opts} or system properties, otherwise {@code defaultValue} * @see #getBoolean(FileSystemOptions, String, Boolean) - * * @since 2.0 */ protected Boolean getBoolean(final FileSystemOptions fileSystemOptions, final String name, @@ -110,7 +106,6 @@ public abstract class FileSystemConfigBuilder { * @param name the option name * @return the option in {@code opts} or system properties, otherwise null * @see #getByte(FileSystemOptions, String, Byte) - * * @since 2.0 */ protected Byte getByte(final FileSystemOptions fileSystemOptions, final String name) { @@ -125,7 +120,6 @@ public abstract class FileSystemConfigBuilder { * @param defaultValue value to return if option is not present * @return the option in {@code opts} or system properties, otherwise {@code defaultValue} * @see #getByte(FileSystemOptions, String, Byte) - * * @since 2.0 */ protected byte getByte(final FileSystemOptions fileSystemOptions, final String name, final byte defaultValue) { @@ -139,7 +133,6 @@ public abstract class FileSystemConfigBuilder { * @param name the option name * @param defaultValue value to return if option is not present * @return the option in {@code opts} or system properties, otherwise {@code defaultValue} - * * @since 2.0 */ protected Byte getByte(final FileSystemOptions fileSystemOptions, final String name, final Byte defaultValue) { @@ -153,7 +146,6 @@ public abstract class FileSystemConfigBuilder { * @param name the option name * @return the option in {@code opts} or system properties, otherwise null * @see #getCharacter(FileSystemOptions, String, Character) - * * @since 2.0 */ protected Character getCharacter(final FileSystemOptions fileSystemOptions, final String name) { @@ -168,7 +160,6 @@ public abstract class FileSystemConfigBuilder { * @param defaultValue value to return if option is not present * @return the option in {@code opts} or system properties, otherwise {@code defaultValue} * @see #getCharacter(FileSystemOptions, String, Character) - * * @since 2.0 */ protected char getCharacter(final FileSystemOptions fileSystemOptions, final String name, final char defaultValue) { @@ -182,7 +173,6 @@ public abstract class FileSystemConfigBuilder { * @param name the option name * @param defaultValue value to return if option is not present * @return the option in {@code opts} or system properties, otherwise {@code defaultValue} - * * @since 2.0 */ protected Character getCharacter(final FileSystemOptions fileSystemOptions, final String name, @@ -202,7 +192,6 @@ public abstract class FileSystemConfigBuilder { * Gets the target of this configuration. * * @return the specific file system class - * * @since 1.0 */ protected abstract Class<? extends FileSystem> getConfigClass(); @@ -214,7 +203,6 @@ public abstract class FileSystemConfigBuilder { * @param name the option name * @return the option in {@code opts} or system properties, otherwise null * @see #getDouble(FileSystemOptions, String, Double) - * * @since 2.0 */ protected Double getDouble(final FileSystemOptions fileSystemOptions, final String name) { @@ -229,7 +217,6 @@ public abstract class FileSystemConfigBuilder { * @param defaultValue value to return if option is not present * @return the option in {@code opts} or system properties, otherwise {@code defaultValue} * @see #getDouble(FileSystemOptions, String, Double) - * * @since 2.0 */ protected double getDouble(final FileSystemOptions fileSystemOptions, final String name, @@ -244,7 +231,6 @@ public abstract class FileSystemConfigBuilder { * @param name the option name * @param defaultValue value to return if option is not present * @return the option in {@code opts} or system properties, otherwise {@code defaultValue} - * * @since 2.0 */ protected Double getDouble(final FileSystemOptions fileSystemOptions, final String name, @@ -259,7 +245,6 @@ public abstract class FileSystemConfigBuilder { * @param name the option name * @return the option in {@code opts} or system properties, otherwise null * @see #getLong(FileSystemOptions, String, Long) - * * @since 2.8.0 */ protected Duration getDuration(final FileSystemOptions fileSystemOptions, final String name) { @@ -273,7 +258,6 @@ public abstract class FileSystemConfigBuilder { * @param name the option name * @param defaultValue value to return if option is not present * @return the option in {@code opts} or system properties, otherwise {@code defaultValue} - * * @since 2.8.0 */ protected Duration getDuration(final FileSystemOptions fileSystemOptions, final String name, @@ -288,7 +272,6 @@ public abstract class FileSystemConfigBuilder { * @param name the option name * @return the option in {@code opts} or system properties, otherwise null * @see #getLong(FileSystemOptions, String, Long) - * * @since 2.8.0 */ protected Integer getDurationInteger(final FileSystemOptions fileSystemOptions, final String name) { @@ -302,7 +285,6 @@ public abstract class FileSystemConfigBuilder { * @param name the option name * @param defaultValue value to return if option is not present * @return the option in {@code opts} or system properties, otherwise {@code defaultValue} - * * @since 2.8.0 */ protected Integer getDurationInteger(final FileSystemOptions fileSystemOptions, final String name, @@ -320,7 +302,6 @@ public abstract class FileSystemConfigBuilder { * @return the option in {@code opts} or system properties, otherwise null * @see #getEnum(Class, FileSystemOptions, String, Enum) * @throws IllegalArgumentException if option value is not a known enumeration. - * * @since 2.1 */ protected <E extends Enum<E>> E getEnum(final Class<E> enumClass, final FileSystemOptions fileSystemOptions, @@ -339,7 +320,6 @@ public abstract class FileSystemConfigBuilder { * @return the option in {@code opts} or system properties, otherwise {@code defaultValue} * @see #getEnum(Class, FileSystemOptions, String, Enum) * @throws IllegalArgumentException if option value is not a known enumeration. - * * @since 2.1 */ protected <E extends Enum<E>> E getEnum(final Class<E> enumClass, final FileSystemOptions fileSystemOptions, @@ -363,7 +343,6 @@ public abstract class FileSystemConfigBuilder { * @return the option in {@code opts} or system properties, otherwise null * @see #getFloat(FileSystemOptions, String, Float) * @throws NumberFormatException if option value is not a valid float. - * * @since 2.0 */ protected Float getFloat(final FileSystemOptions fileSystemOptions, final String name) { @@ -379,7 +358,6 @@ public abstract class FileSystemConfigBuilder { * @return the option in {@code opts} or system properties, otherwise {@code defaultValue} * @see #getFloat(FileSystemOptions, String, Float) * @throws NumberFormatException if option value is not a valid float. - * * @since 2.0 */ protected float getFloat(final FileSystemOptions fileSystemOptions, final String name, final float defaultValue) { @@ -394,7 +372,6 @@ public abstract class FileSystemConfigBuilder { * @param defaultValue value to return if option is not present * @return the option in {@code opts} or system properties, otherwise {@code defaultValue} * @throws NumberFormatException if option value is not a valid float. - * * @since 2.0 */ protected Float getFloat(final FileSystemOptions fileSystemOptions, final String name, final Float defaultValue) { @@ -409,7 +386,6 @@ public abstract class FileSystemConfigBuilder { * @return the option in {@code opts} or system properties, otherwise null * @see #getInteger(FileSystemOptions, String, Integer) * @throws NumberFormatException if option value is not a valid integer. - * * @since 2.0 */ protected Integer getInteger(final FileSystemOptions fileSystemOptions, final String name) { @@ -425,7 +401,6 @@ public abstract class FileSystemConfigBuilder { * @return the option in {@code opts} or system properties, otherwise {@code defaultValue} * @see #getInteger(FileSystemOptions, String, Integer) * @throws NumberFormatException if option value is not a valid integer. - * * @since 2.0 */ protected int getInteger(final FileSystemOptions fileSystemOptions, final String name, final int defaultValue) { @@ -440,7 +415,6 @@ public abstract class FileSystemConfigBuilder { * @param defaultValue value to return if option is not present * @return the option in {@code opts} or system properties, otherwise {@code defaultValue} * @throws NumberFormatException if option value is not a valid integer. - * * @since 2.0 */ protected Integer getInteger(final FileSystemOptions fileSystemOptions, final String name, @@ -456,7 +430,6 @@ public abstract class FileSystemConfigBuilder { * @return the option in {@code opts} or system properties, otherwise null * @see #getLong(FileSystemOptions, String, Long) * @throws NumberFormatException if option value is not a valid long. - * * @since 2.0 */ protected Long getLong(final FileSystemOptions fileSystemOptions, final String name) { @@ -472,7 +445,6 @@ public abstract class FileSystemConfigBuilder { * @return the option in {@code opts} or system properties, otherwise {@code defaultValue} * @see #getLong(FileSystemOptions, String, Long) * @throws NumberFormatException if option value is not a valid long. - * * @since 2.0 */ protected long getLong(final FileSystemOptions fileSystemOptions, final String name, final long defaultValue) { @@ -487,7 +459,6 @@ public abstract class FileSystemConfigBuilder { * @param defaultValue value to return if option is not present * @return the option in {@code opts} or system properties, otherwise {@code defaultValue} * @throws NumberFormatException if option value is not a valid long. - * * @since 2.0 */ protected Long getLong(final FileSystemOptions fileSystemOptions, final String name, final Long defaultValue) { @@ -501,7 +472,6 @@ public abstract class FileSystemConfigBuilder { * @param fileSystemOptions file system options to query, may be null. * @param name get option with this name * @return the named option or null - * * @since 1.0 */ protected <T> T getParam(final FileSystemOptions fileSystemOptions, final String name) { @@ -516,7 +486,6 @@ public abstract class FileSystemConfigBuilder { * @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) { @@ -532,7 +501,6 @@ public abstract class FileSystemConfigBuilder { * @param defaultValue value to use if the system property value is null. * @param function Builds an instance of T from a system property String value. * @return the named option or null - * * @since 2.8.0 */ private <T> T getParam(final FileSystemOptions fileSystemOptions, final String name, final T defaultValue, @@ -555,7 +523,6 @@ public abstract class FileSystemConfigBuilder { * * @param name The name to lookup combined with the prefix. * @return a system property or null - * * @since 2.1 */ private String getProperty(final String name) { @@ -567,7 +534,6 @@ public abstract class FileSystemConfigBuilder { * * @param fileSystemOptions file system options to query, may be null. * @return The root URI, or null. - * * @since 2.0 */ public String getRootURI(final FileSystemOptions fileSystemOptions) { @@ -582,7 +548,6 @@ public abstract class FileSystemConfigBuilder { * @return the option in {@code opts} or system properties, otherwise null * @see #getShort(FileSystemOptions, String, Short) * @throws NumberFormatException if option value is not a valid short. - * * @since 2.0 */ protected Short getShort(final FileSystemOptions fileSystemOptions, final String name) { @@ -598,7 +563,6 @@ public abstract class FileSystemConfigBuilder { * @return the option in {@code opts} or system properties, otherwise {@code defaultValue} * @see #getShort(FileSystemOptions, String, Short) * @throws NumberFormatException if option value is not a valid short - * * @since 2.0 */ protected short getShort(final FileSystemOptions fileSystemOptions, final String name, final short defaultValue) { @@ -613,7 +577,6 @@ public abstract class FileSystemConfigBuilder { * @param defaultValue value to return if option is not present * @return the option in {@code opts} or system properties, otherwise {@code defaultValue} * @throws NumberFormatException if option value is not a valid short - * * @since 2.0 */ protected Short getShort(final FileSystemOptions fileSystemOptions, final String name, final Short defaultValue) { @@ -627,7 +590,6 @@ public abstract class FileSystemConfigBuilder { * @param name the option name * @return the option in {@code opts} or system properties, otherwise null * @see #getString(FileSystemOptions, String, String) - * * @since 2.0 */ protected String getString(final FileSystemOptions fileSystemOptions, final String name) { @@ -641,7 +603,6 @@ public abstract class FileSystemConfigBuilder { * @param name the option name * @param defaultValue value to return if option is not present * @return the option in {@code opts} or system properties, otherwise {@code defaultValue} - * * @since 2.0 */ protected String getString(final FileSystemOptions fileSystemOptions, final String name, @@ -655,7 +616,6 @@ public abstract class FileSystemConfigBuilder { * @param fileSystemOptions file system options to query, may be null. * @param name the option to check in {@code opts} or system properties * @return true if option exists - * * @since 2.0 */ protected boolean hasObject(final FileSystemOptions fileSystemOptions, final String name) { @@ -668,7 +628,6 @@ public abstract class FileSystemConfigBuilder { * @param fileSystemOptions file system options to query, may be null. * @param name the name to look up in {@code opts} * @return true if opts have the named parameter - * * @since 1.0 */ protected boolean hasParam(final FileSystemOptions fileSystemOptions, final String name) { @@ -681,7 +640,6 @@ public abstract class FileSystemConfigBuilder { * @param fileSystemOptions the file system options to modify * @param name set option with this name * @param value boolean value to set - * * @since 2.1 */ protected void setParam(final FileSystemOptions fileSystemOptions, final String name, final boolean value) { @@ -694,7 +652,6 @@ public abstract class FileSystemConfigBuilder { * @param fileSystemOptions the file system options to modify * @param name set option with this name * @param value object value to set - * * @since 1.0 */ protected void setParam(final FileSystemOptions fileSystemOptions, final String name, final Object value) { @@ -706,7 +663,6 @@ public abstract class FileSystemConfigBuilder { * * @param fileSystemOptions the file system options to modify * @param rootURI The creator name to be associated with the file. - * * @since 2.0 */ public void setRootURI(final FileSystemOptions fileSystemOptions, final String rootURI) { @@ -729,7 +685,6 @@ public abstract class FileSystemConfigBuilder { * * @param name a name to combine with the builder prefix * @return name of system property - * * @since 2.1 */ private String toPropertyKey(final String name) { diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileSystemManager.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileSystemManager.java index 0b39fe2a..d1e74cb8 100644 --- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileSystemManager.java +++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileSystemManager.java @@ -67,7 +67,6 @@ public interface FileSystemManager extends AutoCloseable { /** * @see FileSystemManager#addOperationProvider(String, org.apache.commons.vfs2.operations.FileOperationProvider) - * * @param schemes The schemes that will be associated with the provider. * @param operationProvider The FileOperationProvider to add. * @throws FileSystemException if an error occurs. @@ -199,7 +198,6 @@ public interface FileSystemManager extends AutoCloseable { * Gets Providers for file operations. * * @param scheme the scheme for which we want to get the list af registered providers. - * * @return the registered FileOperationProviders for the specified scheme. If there were no providers registered for * the scheme, it returns null. * diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/PatternFileSelector.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/PatternFileSelector.java index c9eb3ca6..a55ce090 100644 --- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/PatternFileSelector.java +++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/PatternFileSelector.java @@ -56,7 +56,6 @@ public class PatternFileSelector implements FileSelector { * </p> * * @param regex The regular expressed used by this selector. - * * @see Pattern#compile(String, int) */ public PatternFileSelector(final String regex) { @@ -71,7 +70,6 @@ public class PatternFileSelector implements FileSelector { * * @param regex The expression to be compiled * @param flags Match flags, a bit mask. - * * @see Pattern#compile(String, int) */ public PatternFileSelector(final String regex, final int flags) { diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/AgeFileFilter.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/AgeFileFilter.java index ad5f26e8..1fcc2c64 100644 --- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/AgeFileFilter.java +++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/AgeFileFilter.java @@ -167,7 +167,6 @@ public class AgeFileFilter implements FileFilter, Serializable { * </p> * * @param fileInfo the File to check - * * @return true if the file name matches * @throws FileSystemException Thrown for file system errors. */ diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/CanExecuteFileFilter.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/CanExecuteFileFilter.java index ee14df0a..7902ec50 100644 --- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/CanExecuteFileFilter.java +++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/CanExecuteFileFilter.java @@ -75,7 +75,6 @@ public class CanExecuteFileFilter implements FileFilter, Serializable { * Checks to see if the file can be executed. * * @param fileSelectInfo the File to check. - * * @return {@code true} if the file can be executed, otherwise {@code false}. * @throws FileSystemException Thrown for file system errors. */ diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/CanReadFileFilter.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/CanReadFileFilter.java index 06a98630..f5bca079 100644 --- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/CanReadFileFilter.java +++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/CanReadFileFilter.java @@ -93,7 +93,6 @@ public class CanReadFileFilter implements FileFilter, Serializable { * Checks to see if the file can be read. * * @param fileSelectInfo the File to check. - * * @return {@code true} if the file can be read, otherwise {@code false}. * @throws FileSystemException Thrown for file system errors. */ diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/CanWriteFileFilter.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/CanWriteFileFilter.java index 5a35c18e..ddf9f942 100644 --- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/CanWriteFileFilter.java +++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/CanWriteFileFilter.java @@ -84,7 +84,6 @@ public class CanWriteFileFilter implements FileFilter, Serializable { * Checks to see if the file can be written to. * * @param fileSelectInfo the File to check - * * @return {@code true} if the file can be written to, otherwise {@code false}. * @throws FileSystemException Thrown for file system errors. */ diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/ConditionalFileFilter.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/ConditionalFileFilter.java index caedbe9d..0f8e9a9f 100644 --- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/ConditionalFileFilter.java +++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/ConditionalFileFilter.java @@ -48,7 +48,6 @@ public interface ConditionalFileFilter { * Removes the specified file filter. * * @param fileFilter filter to be removed - * * @return {@code true} if the filter was found in the list, {@code false} * otherwise */ diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/DirectoryFileFilter.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/DirectoryFileFilter.java index 820a6b8c..01f0ed52 100644 --- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/DirectoryFileFilter.java +++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/DirectoryFileFilter.java @@ -62,7 +62,6 @@ public class DirectoryFileFilter implements FileFilter, Serializable { * Checks to see if the file is a directory. * * @param fileSelectInfo the File to check - * * @return {@code true} if the file is a directory * @throws FileSystemException Thrown for file system errors. */ diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/EmptyFileFilter.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/EmptyFileFilter.java index 38c1f5f9..eb291081 100644 --- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/EmptyFileFilter.java +++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/EmptyFileFilter.java @@ -80,7 +80,6 @@ public class EmptyFileFilter implements FileFilter, Serializable { * Checks to see if the file is empty. A non-existing file is also considered empty. * * @param fileSelectInfo the file or directory to check - * * @return {@code true} if the file or directory is <em>empty</em>, otherwise {@code false}. * @throws FileSystemException Thrown for file system errors. */ diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/FalseFileFilter.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/FalseFileFilter.java index 15e752f5..62523f86 100644 --- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/FalseFileFilter.java +++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/FalseFileFilter.java @@ -56,7 +56,6 @@ public class FalseFileFilter implements FileFilter, Serializable { * Returns false. * * @param fileSelectInfo the file to check (ignored) - * * @return Always {@code false} */ @Override diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/FileFileFilter.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/FileFileFilter.java index d5fa8652..97240f80 100644 --- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/FileFileFilter.java +++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/FileFileFilter.java @@ -60,7 +60,6 @@ public class FileFileFilter implements FileFilter, Serializable { * Checks to see if the file is a file. * * @param fileSelectInfo the File to check - * * @return true if the file is a file * @throws FileSystemException Thrown for file system errors. */ diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/HiddenFileFilter.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/HiddenFileFilter.java index 9d1e333f..0ae31a8b 100644 --- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/HiddenFileFilter.java +++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/HiddenFileFilter.java @@ -76,7 +76,6 @@ public class HiddenFileFilter implements FileFilter, Serializable { * Checks to see if the file is hidden. Non-existing files won't be accepted. * * @param fileSelectInfo the File to check - * * @return {@code true} if the file is <em>hidden</em>, otherwise {@code false}. * @throws FileSystemException Thrown for file system errors. */ diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/NameFileFilter.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/NameFileFilter.java index 047eb464..e7501a2d 100644 --- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/NameFileFilter.java +++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/NameFileFilter.java @@ -112,7 +112,6 @@ public class NameFileFilter implements FileFilter, Serializable { * Checks to see if the file name matches. * * @param fileSelectInfo the File to check - * * @return true if the file name matches */ @Override diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/NotFileFilter.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/NotFileFilter.java index 2ad1afe6..f2891cee 100644 --- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/NotFileFilter.java +++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/NotFileFilter.java @@ -53,7 +53,6 @@ public class NotFileFilter implements FileFilter, Serializable { * File. * * @param fileSelectInfo the File to check - * * @return {@code true} if the filter returns {@code false} * @throws FileSystemException Thrown for file system errors. */ diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/PrefixFileFilter.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/PrefixFileFilter.java index c805ac1d..2ad1f69c 100644 --- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/PrefixFileFilter.java +++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/PrefixFileFilter.java @@ -111,7 +111,6 @@ public class PrefixFileFilter implements FileFilter, Serializable { * Checks to see if the file name starts with the prefix. * * @param fileSelectInfo the File to check - * * @return true if the file name starts with one of our prefixes */ @Override diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/RegexFileFilter.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/RegexFileFilter.java index 26660dfd..233f7b69 100644 --- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/RegexFileFilter.java +++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/RegexFileFilter.java @@ -118,7 +118,6 @@ public class RegexFileFilter implements FileFilter, Serializable { * Checks to see if the file name matches one of the regular expressions. * * @param fileSelectInfo the File to check - * * @return true if the file matches one of the regular expressions */ @Override diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/SizeFileFilter.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/SizeFileFilter.java index c184fefd..6d0b46ed 100644 --- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/SizeFileFilter.java +++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/SizeFileFilter.java @@ -94,7 +94,6 @@ public class SizeFileFilter implements FileFilter, Serializable { * </p> * * @param fileSelectInfo the File to check - * * @return true if the file name matches * @throws FileSystemException Thrown for file system errors. */ diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/SuffixFileFilter.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/SuffixFileFilter.java index d86a9085..9c12a8e7 100644 --- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/SuffixFileFilter.java +++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/SuffixFileFilter.java @@ -109,7 +109,6 @@ public class SuffixFileFilter implements FileFilter, Serializable { * Checks to see if the file name ends with the suffix. * * @param fileSelectInfo the File to check - * * @return true if the file name ends with one of our suffixes */ @Override diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/SymbolicLinkFileFilter.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/SymbolicLinkFileFilter.java index 0736b0f0..b915f21c 100644 --- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/SymbolicLinkFileFilter.java +++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/SymbolicLinkFileFilter.java @@ -74,7 +74,6 @@ public class SymbolicLinkFileFilter implements FileFilter, Serializable { * Checks to see if the file is a symbolic link. Non-existing files won't be accepted. * * @param fileSelectInfo the file to check - * * @return {@code true} if the file is <em>symbolic link</em>, otherwise {@code false}. * @throws FileSystemException Thrown for file system errors. */ diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/TrueFileFilter.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/TrueFileFilter.java index 947026e2..9764efbe 100644 --- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/TrueFileFilter.java +++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/TrueFileFilter.java @@ -57,7 +57,6 @@ public class TrueFileFilter implements FileFilter, Serializable { * Returns true. * * @param fileSelectInfo the file to check (ignored) - * * @return Always {@code true} */ @Override diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/WildcardFileFilter.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/WildcardFileFilter.java index ce5f58bc..85b6b08a 100644 --- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/WildcardFileFilter.java +++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/WildcardFileFilter.java @@ -264,7 +264,6 @@ public class WildcardFileFilter implements FileFilter, Serializable { * Checks to see if the file name matches one of the wildcards. * * @param fileSelectInfo the file to check - * * @return true if the file name matches one of the wildcards */ @Override diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/function/VfsConsumer.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/function/VfsConsumer.java index 4832b218..4480e468 100644 --- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/function/VfsConsumer.java +++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/function/VfsConsumer.java @@ -25,7 +25,6 @@ import org.apache.commons.vfs2.FileSystemException; * A {@link java.util.function.Consumer} that throws {@link FileSystemException}. * * @param <T> the type of the input to the operation - * * @since 2.5.0 */ @FunctionalInterface diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/impl/DefaultFileSystemManager.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/impl/DefaultFileSystemManager.java index ae3b92db..fa298145 100644 --- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/impl/DefaultFileSystemManager.java +++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/impl/DefaultFileSystemManager.java @@ -229,7 +229,6 @@ public class DefaultFileSystemManager implements FileSystemManager { /** * @see FileSystemManager#addOperationProvider(String, org.apache.commons.vfs2.operations.FileOperationProvider) - * * @param schemes The array of schemes the provider should apply to. * @param operationProvider The FileOperationProvider. * @throws FileSystemException if an error occurs. @@ -597,7 +596,6 @@ public class DefaultFileSystemManager implements FileSystemManager { /** * @param scheme the scheme for which we want to get the list af registered providers. - * * @return the registered FileOperationProviders for the specified scheme. If there were no providers registered for * the scheme, it returns null. * diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/operations/DefaultFileOperations.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/operations/DefaultFileOperations.java index 405234d5..cea89035 100644 --- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/operations/DefaultFileOperations.java +++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/operations/DefaultFileOperations.java @@ -102,7 +102,6 @@ public class DefaultFileOperations implements FileOperations { /** * @param operationClass the operation's class. * @return true if the operation of specified class is supported for current FileObject and false otherwise. - * * @throws FileSystemException if an error occurs. */ @Override diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/operations/FileOperationProvider.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/operations/FileOperationProvider.java index dac5dd90..6449de67 100644 --- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/operations/FileOperationProvider.java +++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/operations/FileOperationProvider.java @@ -41,7 +41,6 @@ public interface FileOperationProvider { * @param operationsList the list of available operations for the specified FileObject. The operationList contains * classes of available operations, e.g. Class objects. * @param file the FileObject for which we want to get the list of available operations. - * * @throws FileSystemException if list of operations cannot be retrieved. */ void collectOperations(Collection<Class<? extends FileOperation>> operationsList, FileObject file) throws FileSystemException; @@ -52,7 +51,6 @@ public interface FileOperationProvider { * @param file the FileObject for which we need an operation. * @param operationClass the Class which instance we are needed. * @return the required operation instance. - * * @throws FileSystemException if operation cannot be retrieved. */ FileOperation getOperation(FileObject file, Class<? extends FileOperation> operationClass) throws FileSystemException; diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/operations/FileOperations.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/operations/FileOperations.java index 6e8c989d..3099c4af 100644 --- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/operations/FileOperations.java +++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/operations/FileOperations.java @@ -22,7 +22,6 @@ import org.apache.commons.vfs2.FileSystemException; * FileOperations interface provides API to work with operations. * * @see FileOperation on what an operation in the context of VFS is. - * * @since 0.1 */ public interface FileOperations { diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/UriParser.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/UriParser.java index c3038b0f..2c65ad54 100644 --- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/UriParser.java +++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/UriParser.java @@ -486,7 +486,6 @@ public final class UriParser { * @param path The path to normalize. * @return The FileType. * @throws FileSystemException if an error occurs. - * * @see #fixSeparators */ public static FileType normalisePath(final StringBuilder path) throws FileSystemException { diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/bzip2/Bzip2FileObject.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/bzip2/Bzip2FileObject.java index ea915067..4613ee85 100644 --- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/bzip2/Bzip2FileObject.java +++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/bzip2/Bzip2FileObject.java @@ -68,7 +68,6 @@ public class Bzip2FileObject extends CompressedFileFileObject<Bzip2FileSystem> { * @param name Abstract file name. * @param container My container. * @param fs My file system. - * * @deprecated Use {@link #Bzip2FileObject(AbstractFileName, FileObject, Bzip2FileSystem)} instead. */ @Deprecated diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/gzip/GzipFileObject.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/gzip/GzipFileObject.java index af620717..7a0351b1 100644 --- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/gzip/GzipFileObject.java +++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/gzip/GzipFileObject.java @@ -44,7 +44,6 @@ public class GzipFileObject extends CompressedFileFileObject<GzipFileSystem> { * @param name Abstract file name. * @param container My container. * @param fs My file system. - * * @deprecated Use {@link #GzipFileObject(AbstractFileName, FileObject, GzipFileSystem)} instead. */ @Deprecated diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http4/Http4FileObject.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http4/Http4FileObject.java index ae1801f0..d4caffc4 100644 --- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http4/Http4FileObject.java +++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http4/Http4FileObject.java @@ -46,7 +46,6 @@ import org.apache.http.protocol.HTTP; * A file object backed by Apache HttpComponents HttpClient. * * @param <FS> An {@link Http4FileSystem} subclass - * * @since 2.3 * @deprecated Use {@link org.apache.commons.vfs2.provider.http5}. */ @@ -183,7 +182,6 @@ public class Http4FileObject<FS extends Http4FileSystem> extends AbstractFileObj * @param httpRequest {@code HttpUriRequest} object * @return {@code HttpResponse} from the execution * @throws IOException if IO error occurs - * * @since 2.5.0 */ protected HttpResponse executeHttpUriRequest(final HttpUriRequest httpRequest) throws IOException { diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http5/Http5FileObject.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http5/Http5FileObject.java index 32f560de..ffddf76e 100644 --- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http5/Http5FileObject.java +++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http5/Http5FileObject.java @@ -46,7 +46,6 @@ import org.apache.hc.core5.http.HttpStatus; * A file object backed by Apache HttpComponents HttpClient v5. * * @param <FS> An {@link Http5FileSystem} subclass - * * @since 2.5.0 */ public class Http5FileObject<FS extends Http5FileSystem> extends AbstractFileObject<FS> { diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/sftp/SftpFileSystemConfigBuilder.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/sftp/SftpFileSystemConfigBuilder.java index 521ccdfa..f34d05b4 100644 --- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/sftp/SftpFileSystemConfigBuilder.java +++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/sftp/SftpFileSystemConfigBuilder.java @@ -450,7 +450,6 @@ public final class SftpFileSystemConfigBuilder extends FileSystemConfigBuilder { * * @param options The FileSystemOptions. * @return {@code true} if detection of exec channel should be disabled. - * * @see #setDisableDetectExecChannel(FileSystemOptions, boolean) * @since 2.7.0 */ diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/util/FileObjectUtils.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/util/FileObjectUtils.java index 4f07211f..9454c560 100644 --- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/util/FileObjectUtils.java +++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/util/FileObjectUtils.java @@ -74,7 +74,6 @@ public final class FileObjectUtils { * @param file Gets the contents of this file object. * @return The content as a byte array. * @throws IOException if the file content cannot be accessed. - * * @since 2.6.0 */ public static byte[] getContentAsByteArray(final FileObject file) throws IOException { diff --git a/commons-vfs2/src/test/java/org/apache/commons/vfs2/filter/BaseFilterTest.java b/commons-vfs2/src/test/java/org/apache/commons/vfs2/filter/BaseFilterTest.java index 28a02a2e..4d7c6bd7 100644 --- a/commons-vfs2/src/test/java/org/apache/commons/vfs2/filter/BaseFilterTest.java +++ b/commons-vfs2/src/test/java/org/apache/commons/vfs2/filter/BaseFilterTest.java @@ -163,7 +163,6 @@ public abstract class BaseFilterTest { * Returns a subdirectory of the temporary directory. * * @param name Name of the subdirectory. - * * @return Subdirectory of java.io.tmpdir. */ protected static File getTestDir(final String name) { @@ -176,9 +175,7 @@ public abstract class BaseFilterTest { * Returns a ZIP file object. * * @param file File to resolve. - * * @return File object. - * * @throws FileSystemException Error resolving the file. */ protected static FileObject getZipFileObject(final File file) throws FileSystemException { @@ -192,7 +189,6 @@ public abstract class BaseFilterTest { * @param srcDir Directory to list the files for - Cannot be {@code null} * and must be a valid directory. * @param filter Filter or {@code null} for all files. - * * @return List of child entries of the directory. */ private static File[] listFiles(final File srcDir, final FileFilter filter) { @@ -210,7 +206,6 @@ public abstract class BaseFilterTest { * @param destPath Path to use for the ZIP archive - May be {@code null} or * an empty string. * @param destFile Target ZIP file - Cannot be {@code null}. - * * @throws IOException Error writing to the output stream. */ public static void zipDir(final File srcDir, final FileFilter filter, final String destPath, final File destFile) @@ -242,7 +237,6 @@ public abstract class BaseFilterTest { * @param destPath Path to use for the ZIP archive - May be {@code null} or * an empty string. * @param out Destination stream - Cannot be {@code null}. - * * @throws IOException Error writing to the output stream. */ private static void zipDir(final File srcDir, final FileFilter filter, final String destPath, @@ -268,7 +262,6 @@ public abstract class BaseFilterTest { * @param destPath Path to use for the ZIP archive - May be {@code null} or * an empty string. * @param destFile Target ZIP file - Cannot be {@code null}. - * * @throws IOException Error writing to the output stream. */ public static void zipDir(final File srcDir, final String destPath, final File destFile) throws IOException { @@ -282,7 +275,6 @@ public abstract class BaseFilterTest { * @param srcFile File to add - Cannot be {@code null}. * @param destPath Path to use for the file - May be {@code null} or empty. * @param out Destination stream - Cannot be {@code null}. - * * @throws IOException Error writing to the output stream. */ private static void zipFile(final File srcFile, final String destPath, final ZipOutputStream out)