You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by ni...@apache.org on 2010/10/06 18:13:02 UTC
svn commit: r1005099 - in
/commons/proper/io/trunk/src/main/java/org/apache/commons/io: ./
comparator/ filefilter/ input/ monitor/
Author: niallp
Date: Wed Oct 6 16:13:01 2010
New Revision: 1005099
URL: http://svn.apache.org/viewvc?rev=1005099&view=rev
Log:
JavaDoc improvements
Modified:
commons/proper/io/trunk/src/main/java/org/apache/commons/io/ByteOrderMark.java
commons/proper/io/trunk/src/main/java/org/apache/commons/io/comparator/DirectoryFileComparator.java
commons/proper/io/trunk/src/main/java/org/apache/commons/io/comparator/package.html
commons/proper/io/trunk/src/main/java/org/apache/commons/io/filefilter/AgeFileFilter.java
commons/proper/io/trunk/src/main/java/org/apache/commons/io/filefilter/AndFileFilter.java
commons/proper/io/trunk/src/main/java/org/apache/commons/io/filefilter/DelegateFileFilter.java
commons/proper/io/trunk/src/main/java/org/apache/commons/io/filefilter/DirectoryFileFilter.java
commons/proper/io/trunk/src/main/java/org/apache/commons/io/filefilter/FalseFileFilter.java
commons/proper/io/trunk/src/main/java/org/apache/commons/io/filefilter/FileFileFilter.java
commons/proper/io/trunk/src/main/java/org/apache/commons/io/filefilter/FileFilterUtils.java
commons/proper/io/trunk/src/main/java/org/apache/commons/io/filefilter/MagicNumberFileFilter.java
commons/proper/io/trunk/src/main/java/org/apache/commons/io/filefilter/NameFileFilter.java
commons/proper/io/trunk/src/main/java/org/apache/commons/io/filefilter/NotFileFilter.java
commons/proper/io/trunk/src/main/java/org/apache/commons/io/filefilter/OrFileFilter.java
commons/proper/io/trunk/src/main/java/org/apache/commons/io/filefilter/PrefixFileFilter.java
commons/proper/io/trunk/src/main/java/org/apache/commons/io/filefilter/SizeFileFilter.java
commons/proper/io/trunk/src/main/java/org/apache/commons/io/filefilter/SuffixFileFilter.java
commons/proper/io/trunk/src/main/java/org/apache/commons/io/filefilter/TrueFileFilter.java
commons/proper/io/trunk/src/main/java/org/apache/commons/io/input/BOMInputStream.java
commons/proper/io/trunk/src/main/java/org/apache/commons/io/monitor/FilesystemObserver.java
commons/proper/io/trunk/src/main/java/org/apache/commons/io/monitor/package.html
Modified: commons/proper/io/trunk/src/main/java/org/apache/commons/io/ByteOrderMark.java
URL: http://svn.apache.org/viewvc/commons/proper/io/trunk/src/main/java/org/apache/commons/io/ByteOrderMark.java?rev=1005099&r1=1005098&r2=1005099&view=diff
==============================================================================
--- commons/proper/io/trunk/src/main/java/org/apache/commons/io/ByteOrderMark.java (original)
+++ commons/proper/io/trunk/src/main/java/org/apache/commons/io/ByteOrderMark.java Wed Oct 6 16:13:01 2010
@@ -19,7 +19,8 @@ package org.apache.commons.io;
import java.io.Serializable;
/**
- * Byte Order Mark (BOM) representation.
+ * Byte Order Mark (BOM) representation -
+ * see {@link org.apache.commons.io.input.BOMInputStream}.
*
* @see org.apache.commons.io.input.BOMInputStream
* @see <a href="http://en.wikipedia.org/wiki/Byte_order_mark">Wikipedia - Byte Order Mark</a>
Modified: commons/proper/io/trunk/src/main/java/org/apache/commons/io/comparator/DirectoryFileComparator.java
URL: http://svn.apache.org/viewvc/commons/proper/io/trunk/src/main/java/org/apache/commons/io/comparator/DirectoryFileComparator.java?rev=1005099&r1=1005098&r2=1005099&view=diff
==============================================================================
--- commons/proper/io/trunk/src/main/java/org/apache/commons/io/comparator/DirectoryFileComparator.java (original)
+++ commons/proper/io/trunk/src/main/java/org/apache/commons/io/comparator/DirectoryFileComparator.java Wed Oct 6 16:13:01 2010
@@ -21,7 +21,7 @@ import java.io.Serializable;
import java.util.Comparator;
/**
- * Compare two files using the <b>default</b> {@link File#isDirectory()} method.
+ * Compare two files using the {@link File#isDirectory()} method.
* <p>
* This comparator can be used to sort lists or arrays by directories and files.
* <p>
Modified: commons/proper/io/trunk/src/main/java/org/apache/commons/io/comparator/package.html
URL: http://svn.apache.org/viewvc/commons/proper/io/trunk/src/main/java/org/apache/commons/io/comparator/package.html?rev=1005099&r1=1005098&r2=1005099&view=diff
==============================================================================
--- commons/proper/io/trunk/src/main/java/org/apache/commons/io/comparator/package.html (original)
+++ commons/proper/io/trunk/src/main/java/org/apache/commons/io/comparator/package.html Wed Oct 6 16:13:01 2010
@@ -20,6 +20,169 @@ limitations under the License.
<p>This package provides various {@link java.util.Comparator} implementations
for {@link java.io.File}s.
</p>
+<h3>Sorting</h3>
+<p>
+ All the compartors include <i>convenience</i> utility <code>sort(File...)</code> and
+ <code>sort(List)</code> methods.
+</p>
+<p>
+ For example, to sort the files in a directory by name:
+</p>
+ <pre>
+ File[] files = dir.listFiles();
+ NameFileComparator.NAME_COMPARATOR.sort(files);
+ </pre>
+<p>
+ ...alternatively you can do this in one line:
+</p>
+<p>
+ <pre>
+ File[] files = NameFileComparator.NAME_COMPARATOR.sort(dir.listFiles());
+ </pre>
+</p>
+
+<h3>Composite Comparator</h3>
+<p>
+ The <a href="CompositeFileComparator.html">CompositeFileComparator</a> can be used
+ to compare (and sort lists or arrays of files) by combining a number other comparators.
+</p>
+<p>
+ For example, to sort an array of files by type (i.e. directory or file)
+ and then by name:
+</p>
+<p>
+ <pre>
+ CompositeFileComparator comparator =
+ new CompositeFileComparator(
+ DirectoryFileComparator.DIRECTORY_COMPARATOR,
+ NameFileComparator.NAME_COMPARATOR);
+ File[] files = dir.listFiles();
+ comparator.sort(files);
+ </pre>
+</p>
+
+<h3>Singleton Instances (thread-safe)</h3>
+<p>
+ The {@link java.util.Comparator} implementations have some <i>convenience</i>
+ singleton(<i>thread-safe</i>) instances ready to use:
+ <ul>
+ <li><a href="DefaultFileComparator.html">DefaultFileComparator</a> - default file compare:
+ <ul>
+ <li><a href="DefaultFileComparator.html#DEFAULT_COMPARATOR">DEFAULT_COMPARATOR</a>
+ - Compare using <code>File.compareTo(File)</code> method.
+ </li>
+ <li><a href="DefaultFileComparator.html#DEFAULT_REVERSE">DEFAULT_REVERSE</a>
+ - Reverse compare of <code>File.compareTo(File)</code> method.
+ </li>
+ </ul>
+ </li>
+ <li><a href="DirectoryFileComparator.html">DirectoryFileComparator</a> - compare by type (directory or file):
+ <ul>
+ <li><a href="DirectoryFileComparator.html#DIRECTORY_COMPARATOR">DIRECTORY_COMPARATOR</a>
+ - Compare using <code>File.isDirectory()</code> method (directories < files).
+ </li>
+ <li><a href="DirectoryFileComparator.html#DIRECTORY_REVERSE">DIRECTORY_REVERSE</a>
+ - Reverse compare of <code>File.isDirectory()</code> method (directories > files).
+ </li>
+ </ul>
+ </li>
+ <li><a href="ExtensionFileComparator.html">ExtensionFileComparator</a> - compare file extenstions:
+ <ul>
+ <li><a href="ExtensionFileComparator.html#EXTENSION_COMPARATOR">EXTENSION_COMPARATOR</a>
+ - Compare using <code>FilenameUtils.getExtension(String)</code> method.
+ </li>
+ <li><a href="ExtensionFileComparator.html#EXTENSION_REVERSE">EXTENSION_REVERSE</a>
+ - Reverse compare of <code>FilenameUtils.getExtension(String)</code> method.
+ </li>
+ <li><a href="ExtensionFileComparator.html#EXTENSION_INSENSITIVE_COMPARATOR">EXTENSION_INSENSITIVE_COMPARATOR</a>
+ - Case-insensitive compare using <code>FilenameUtils.getExtension(String)</code> method.
+ </li>
+ <li><a href="ExtensionFileComparator.html#EXTENSION_INSENSITIVE_REVERSE">EXTENSION_INSENSITIVE_REVERSE</a>
+ - Reverse case-insensitive compare of <code>FilenameUtils.getExtension(String)</code> method.
+ </li>
+ <li><a href="ExtensionFileComparator.html#EXTENSION_SYSTEM_COMPARATOR">EXTENSION_SYSTEM_COMPARATOR</a>
+ - System sensitive compare using <code>FilenameUtils.getExtension(String)</code> method.
+ </li>
+ <li><a href="ExtensionFileComparator.html#EXTENSION_SYSTEM_REVERSE">EXTENSION_SYSTEM_REVERSE</a>
+ - Reverse system sensitive compare of <code>FilenameUtils.getExtension(String)</code> method.
+ </li>
+ </ul>
+ </li>
+ <li><a href="LastModifiedFileComparator.html">LastModifiedFileComparator</a>
+ - compare the file's last modified date/time:
+ <ul>
+ <li><a href="LastModifiedFileComparator.html#LASTMODIFIED_COMPARATOR">LASTMODIFIED_COMPARATOR</a>
+ - Compare using <code>File.lastModified()</code> method.
+ </li>
+ <li><a href="LastModifiedFileComparator.html#LASTMODIFIED_REVERSE">LASTMODIFIED_REVERSE</a>
+ - Reverse compare of <code>File.lastModified()</code> method.
+ </li>
+ </ul>
+ </li>
+ <li><a href="NameFileComparator.html">NameFileComparator</a> - compare file names:
+ <ul>
+ <li><a href="NameFileComparator.html#NAME_COMPARATOR">NAME_COMPARATOR</a>
+ - Compare using <code>File.getName()</code> method.
+ </li>
+ <li><a href="NameFileComparator.html#NAME_REVERSE">NAME_REVERSE</a>
+ - Reverse compare of <code>File.getName()</code> method.
+ </li>
+ <li><a href="NameFileComparator.html#NAME_INSENSITIVE_COMPARATOR">NAME_INSENSITIVE_COMPARATOR</a>
+ - Case-insensitive compare using <code>File.getName()</code> method.
+ </li>
+ <li><a href="NameFileComparator.html#NAME_INSENSITIVE_REVERSE">NAME_INSENSITIVE_REVERSE</a>
+ - Reverse case-insensitive compare of <code>File.getName()</code> method.
+ </li>
+ <li><a href="NameFileComparator.html#NAME_SYSTEM_COMPARATOR">NAME_SYSTEM_COMPARATOR</a>
+ - System sensitive compare using <code>File.getName()</code> method.
+ </li>
+ <li><a href="NameFileComparator.html#NAME_SYSTEM_REVERSE">NAME_SYSTEM_REVERSE</a>
+ - Reverse system sensitive compare of <code>File.getName()</code> method.
+ </li>
+ </ul>
+ </li>
+ <li><a href="PathFileComparator.html">PathFileComparator</a> - compare file paths:
+ <ul>
+ <li><a href="PathFileComparator.html#PATH_COMPARATOR">PATH_COMPARATOR</a>
+ - Compare using <code>File.getPath()</code> method.
+ </li>
+ <li><a href="PathFileComparator.html#PATH_REVERSE">PATH_REVERSE</a>
+ - Reverse compare of <code>File.getPath()</code> method.
+ </li>
+ <li><a href="PathFileComparator.html#PATH_INSENSITIVE_COMPARATOR">PATH_INSENSITIVE_COMPARATOR</a>
+ - Case-insensitive compare using <code>File.getPath()</code> method.
+ </li>
+ <li><a href="PathFileComparator.html#PATH_INSENSITIVE_REVERSE">PATH_INSENSITIVE_REVERSE</a>
+ - Reverse case-insensitive compare of <code>File.getPath()</code> method.
+ </li>
+ <li><a href="PathFileComparator.html#PATH_SYSTEM_COMPARATOR">PATH_SYSTEM_COMPARATOR</a>
+ - System sensitive compare using <code>File.getPath()</code> method.
+ </li>
+ <li><a href="PathFileComparator.html#PATH_SYSTEM_REVERSE">PATH_SYSTEM_REVERSE</a>
+ - Reverse system sensitive compare of <code>File.getPath()</code> method.
+ </li>
+ </ul>
+ </li>
+ <li><a href="SizeFileComparator.html">SizeFileComparator</a> - compare the file's size:
+ <ul>
+ <li><a href="SizeFileComparator.html#SIZE_COMPARATOR">SIZE_COMPARATOR</a>
+ - Compare using <code>File.length()</code> method (directories treated as zero length).
+ </li>
+ <li><a href="SizeFileComparator.html#SIZE_REVERSE">LASTMODIFIED_REVERSE</a>
+ - Reverse compare of <code>File.length()</code> method (directories treated as zero length).
+ </li>
+ <li><a href="SizeFileComparator.html#SIZE_SUMDIR_COMPARATOR">SIZE_SUMDIR_COMPARATOR</a>
+ - Compare using <code>FileUtils.sizeOfDirectory(File)</code> method
+ (sums the size of a directory's contents).
+ </li>
+ <li><a href="SizeFileComparator.html#SIZE_SUMDIR_REVERSE">SIZE_SUMDIR_REVERSE</a>
+ - Reverse compare of <code>FileUtils.sizeOfDirectory(File)</code> method
+ (sums the size of a directory's contents).
+ </li>
+ </ul>
+ </li>
+ </ul>
+</p>
</body>
</html>
Modified: commons/proper/io/trunk/src/main/java/org/apache/commons/io/filefilter/AgeFileFilter.java
URL: http://svn.apache.org/viewvc/commons/proper/io/trunk/src/main/java/org/apache/commons/io/filefilter/AgeFileFilter.java?rev=1005099&r1=1005098&r2=1005099&view=diff
==============================================================================
--- commons/proper/io/trunk/src/main/java/org/apache/commons/io/filefilter/AgeFileFilter.java (original)
+++ commons/proper/io/trunk/src/main/java/org/apache/commons/io/filefilter/AgeFileFilter.java Wed Oct 6 16:13:01 2010
@@ -41,6 +41,12 @@ import org.apache.commons.io.FileUtils;
*
* @author Rahul Akolkar
* @version $Id$
+ * @see FileFilterUtils#ageFileFilter(Date)
+ * @see FileFilterUtils#ageFileFilter(File)
+ * @see FileFilterUtils#ageFileFilter(long)
+ * @see FileFilterUtils#ageFileFilter(Date, boolean)
+ * @see FileFilterUtils#ageFileFilter(File, boolean)
+ * @see FileFilterUtils#ageFileFilter(long, boolean)
* @since Commons IO 1.2
*/
public class AgeFileFilter extends AbstractFileFilter implements Serializable {
Modified: commons/proper/io/trunk/src/main/java/org/apache/commons/io/filefilter/AndFileFilter.java
URL: http://svn.apache.org/viewvc/commons/proper/io/trunk/src/main/java/org/apache/commons/io/filefilter/AndFileFilter.java?rev=1005099&r1=1005098&r2=1005099&view=diff
==============================================================================
--- commons/proper/io/trunk/src/main/java/org/apache/commons/io/filefilter/AndFileFilter.java (original)
+++ commons/proper/io/trunk/src/main/java/org/apache/commons/io/filefilter/AndFileFilter.java Wed Oct 6 16:13:01 2010
@@ -33,6 +33,7 @@ import java.util.List;
* @version $Revision$ $Date$
*
* @author Steven Caswell
+ * @see FileFilterUtils#and(IOFileFilter...)
*/
public class AndFileFilter
extends AbstractFileFilter
Modified: commons/proper/io/trunk/src/main/java/org/apache/commons/io/filefilter/DelegateFileFilter.java
URL: http://svn.apache.org/viewvc/commons/proper/io/trunk/src/main/java/org/apache/commons/io/filefilter/DelegateFileFilter.java?rev=1005099&r1=1005098&r2=1005099&view=diff
==============================================================================
--- commons/proper/io/trunk/src/main/java/org/apache/commons/io/filefilter/DelegateFileFilter.java (original)
+++ commons/proper/io/trunk/src/main/java/org/apache/commons/io/filefilter/DelegateFileFilter.java Wed Oct 6 16:13:01 2010
@@ -28,6 +28,8 @@ import java.io.Serializable;
* @version $Revision$ $Date$
*
* @author Stephen Colebourne
+ * @see FileFilterUtils#asFileFilter(FileFilter)
+ * @see FileFilterUtils#asFileFilter(FilenameFilter)
*/
public class DelegateFileFilter extends AbstractFileFilter implements Serializable {
Modified: commons/proper/io/trunk/src/main/java/org/apache/commons/io/filefilter/DirectoryFileFilter.java
URL: http://svn.apache.org/viewvc/commons/proper/io/trunk/src/main/java/org/apache/commons/io/filefilter/DirectoryFileFilter.java?rev=1005099&r1=1005098&r2=1005099&view=diff
==============================================================================
--- commons/proper/io/trunk/src/main/java/org/apache/commons/io/filefilter/DirectoryFileFilter.java (original)
+++ commons/proper/io/trunk/src/main/java/org/apache/commons/io/filefilter/DirectoryFileFilter.java Wed Oct 6 16:13:01 2010
@@ -38,6 +38,7 @@ import java.io.Serializable;
*
* @author Stephen Colebourne
* @author Peter Donald
+ * @see FileFilterUtils#directoryFileFilter()
*/
public class DirectoryFileFilter extends AbstractFileFilter implements Serializable {
Modified: commons/proper/io/trunk/src/main/java/org/apache/commons/io/filefilter/FalseFileFilter.java
URL: http://svn.apache.org/viewvc/commons/proper/io/trunk/src/main/java/org/apache/commons/io/filefilter/FalseFileFilter.java?rev=1005099&r1=1005098&r2=1005099&view=diff
==============================================================================
--- commons/proper/io/trunk/src/main/java/org/apache/commons/io/filefilter/FalseFileFilter.java (original)
+++ commons/proper/io/trunk/src/main/java/org/apache/commons/io/filefilter/FalseFileFilter.java Wed Oct 6 16:13:01 2010
@@ -26,6 +26,7 @@ import java.io.Serializable;
* @version $Revision$ $Date$
*
* @author Stephen Colebourne
+ * @see FileFilterUtils#falseFileFilter()
*/
public class FalseFileFilter implements IOFileFilter, Serializable {
Modified: commons/proper/io/trunk/src/main/java/org/apache/commons/io/filefilter/FileFileFilter.java
URL: http://svn.apache.org/viewvc/commons/proper/io/trunk/src/main/java/org/apache/commons/io/filefilter/FileFileFilter.java?rev=1005099&r1=1005098&r2=1005099&view=diff
==============================================================================
--- commons/proper/io/trunk/src/main/java/org/apache/commons/io/filefilter/FileFileFilter.java (original)
+++ commons/proper/io/trunk/src/main/java/org/apache/commons/io/filefilter/FileFileFilter.java Wed Oct 6 16:13:01 2010
@@ -35,6 +35,7 @@ import java.io.Serializable;
*
* @since Commons IO 1.3
* @version $Revision:587916 $ $Date$
+ * @see FileFilterUtils#fileFileFilter()
*/
public class FileFileFilter extends AbstractFileFilter implements Serializable {
Modified: commons/proper/io/trunk/src/main/java/org/apache/commons/io/filefilter/FileFilterUtils.java
URL: http://svn.apache.org/viewvc/commons/proper/io/trunk/src/main/java/org/apache/commons/io/filefilter/FileFilterUtils.java?rev=1005099&r1=1005098&r2=1005099&view=diff
==============================================================================
--- commons/proper/io/trunk/src/main/java/org/apache/commons/io/filefilter/FileFilterUtils.java (original)
+++ commons/proper/io/trunk/src/main/java/org/apache/commons/io/filefilter/FileFilterUtils.java Wed Oct 6 16:13:01 2010
@@ -293,6 +293,7 @@ public class FileFilterUtils {
*
* @param prefix the filename prefix
* @return a prefix checking filter
+ * @see PrefixFileFilter
*/
public static IOFileFilter prefixFileFilter(String prefix) {
return new PrefixFileFilter(prefix);
@@ -304,6 +305,7 @@ public class FileFilterUtils {
* @param prefix the filename prefix
* @param caseSensitivity how to handle case sensitivity, null means case-sensitive
* @return a prefix checking filter
+ * @see PrefixFileFilter
* @since Commons IO 2.0
*/
public static IOFileFilter prefixFileFilter(String prefix, IOCase caseSensitivity) {
@@ -315,6 +317,7 @@ public class FileFilterUtils {
*
* @param suffix the filename suffix
* @return a suffix checking filter
+ * @see SuffixFileFilter
*/
public static IOFileFilter suffixFileFilter(String suffix) {
return new SuffixFileFilter(suffix);
@@ -326,6 +329,7 @@ public class FileFilterUtils {
* @param suffix the filename suffix
* @param caseSensitivity how to handle case sensitivity, null means case-sensitive
* @return a suffix checking filter
+ * @see SuffixFileFilter
* @since Commons IO 2.0
*/
public static IOFileFilter suffixFileFilter(String suffix, IOCase caseSensitivity) {
@@ -337,6 +341,7 @@ public class FileFilterUtils {
*
* @param name the filename
* @return a name checking filter
+ * @see NameFileFilter
*/
public static IOFileFilter nameFileFilter(String name) {
return new NameFileFilter(name);
@@ -348,6 +353,7 @@ public class FileFilterUtils {
* @param name the filename
* @param caseSensitivity how to handle case sensitivity, null means case-sensitive
* @return a name checking filter
+ * @see NameFileFilter
* @since Commons IO 2.0
*/
public static IOFileFilter nameFileFilter(String name, IOCase caseSensitivity) {
@@ -358,6 +364,7 @@ public class FileFilterUtils {
* Returns a filter that checks if the file is a directory.
*
* @return file filter that accepts only directories and not files
+ * @see DirectoryFileFilter#DIRECTORY
*/
public static IOFileFilter directoryFileFilter() {
return DirectoryFileFilter.DIRECTORY;
@@ -367,6 +374,7 @@ public class FileFilterUtils {
* Returns a filter that checks if the file is a file (and not a directory).
*
* @return file filter that accepts only files and not directories
+ * @see FileFileFilter#FILE
*/
public static IOFileFilter fileFileFilter() {
return FileFileFilter.FILE;
@@ -379,6 +387,8 @@ public class FileFilterUtils {
* @param filter1 the first filter
* @param filter2 the second filter
* @return a filter that ANDs the two specified filters
+ * @see #and(IOFileFilter...)
+ * @see AndFileFilter
* @deprecated use {@link #and(IOFileFilter...)}
*/
@Deprecated
@@ -392,6 +402,8 @@ public class FileFilterUtils {
* @param filter1 the first filter
* @param filter2 the second filter
* @return a filter that ORs the two specified filters
+ * @see #or(IOFileFilter...)
+ * @see OrFileFilter
* @deprecated use {@link #or(IOFileFilter...)}
*/
@Deprecated
@@ -407,6 +419,7 @@ public class FileFilterUtils {
*
* @throws IllegalArgumentException if the filters are null or contain a
* null value.
+ * @see AndFileFilter
* @since Commons IO 2.0
*/
public static IOFileFilter and(IOFileFilter... filters) {
@@ -421,6 +434,7 @@ public class FileFilterUtils {
*
* @throws IllegalArgumentException if the filters are null or contain a
* null value.
+ * @see OrFileFilter
* @since Commons IO 2.0
*/
public static IOFileFilter or(IOFileFilter... filters) {
@@ -455,6 +469,7 @@ public class FileFilterUtils {
*
* @param filter the filter to invert
* @return a filter that NOTs the specified filter
+ * @see NotFileFilter
*/
public static IOFileFilter notFileFilter(IOFileFilter filter) {
return new NotFileFilter(filter);
@@ -465,6 +480,7 @@ public class FileFilterUtils {
* Returns a filter that always returns true.
*
* @return a true filter
+ * @see TrueFileFilter#TRUE
*/
public static IOFileFilter trueFileFilter() {
return TrueFileFilter.TRUE;
@@ -474,6 +490,7 @@ public class FileFilterUtils {
* Returns a filter that always returns false.
*
* @return a false filter
+ * @see FalseFileFilter#FALSE
*/
public static IOFileFilter falseFileFilter() {
return FalseFileFilter.FALSE;
@@ -486,6 +503,7 @@ public class FileFilterUtils {
*
* @param filter the filter to be wrapped
* @return a new filter that implements IOFileFilter
+ * @see DelegateFileFilter
*/
public static IOFileFilter asFileFilter(FileFilter filter) {
return new DelegateFileFilter(filter);
@@ -497,6 +515,7 @@ public class FileFilterUtils {
*
* @param filter the filter to be wrapped
* @return a new filter that implements IOFileFilter
+ * @see DelegateFileFilter
*/
public static IOFileFilter asFileFilter(FilenameFilter filter) {
return new DelegateFileFilter(filter);
@@ -509,6 +528,7 @@ public class FileFilterUtils {
*
* @param cutoff the time threshold
* @return an appropriately configured age file filter
+ * @see AgeFileFilter
* @since Commons IO 1.2
*/
public static IOFileFilter ageFileFilter(long cutoff) {
@@ -521,6 +541,7 @@ public class FileFilterUtils {
* @param cutoff the time threshold
* @param acceptOlder if true, older files get accepted, if false, newer
* @return an appropriately configured age file filter
+ * @see AgeFileFilter
* @since Commons IO 1.2
*/
public static IOFileFilter ageFileFilter(long cutoff, boolean acceptOlder) {
@@ -533,6 +554,7 @@ public class FileFilterUtils {
*
* @param cutoffDate the time threshold
* @return an appropriately configured age file filter
+ * @see AgeFileFilter
* @since Commons IO 1.2
*/
public static IOFileFilter ageFileFilter(Date cutoffDate) {
@@ -545,6 +567,7 @@ public class FileFilterUtils {
* @param cutoffDate the time threshold
* @param acceptOlder if true, older files get accepted, if false, newer
* @return an appropriately configured age file filter
+ * @see AgeFileFilter
* @since Commons IO 1.2
*/
public static IOFileFilter ageFileFilter(Date cutoffDate, boolean acceptOlder) {
@@ -558,6 +581,7 @@ public class FileFilterUtils {
* @param cutoffReference the file whose last modification
* time is usesd as the threshold age of the files
* @return an appropriately configured age file filter
+ * @see AgeFileFilter
* @since Commons IO 1.2
*/
public static IOFileFilter ageFileFilter(File cutoffReference) {
@@ -571,6 +595,7 @@ public class FileFilterUtils {
* time is usesd as the threshold age of the files
* @param acceptOlder if true, older files get accepted, if false, newer
* @return an appropriately configured age file filter
+ * @see AgeFileFilter
* @since Commons IO 1.2
*/
public static IOFileFilter ageFileFilter(File cutoffReference, boolean acceptOlder) {
@@ -583,6 +608,7 @@ public class FileFilterUtils {
*
* @param threshold the file size threshold
* @return an appropriately configured SizeFileFilter
+ * @see SizeFileFilter
* @since Commons IO 1.2
*/
public static IOFileFilter sizeFileFilter(long threshold) {
@@ -595,6 +621,7 @@ public class FileFilterUtils {
* @param threshold the file size threshold
* @param acceptLarger if true, larger files get accepted, if false, smaller
* @return an appropriately configured SizeFileFilter
+ * @see SizeFileFilter
* @since Commons IO 1.2
*/
public static IOFileFilter sizeFileFilter(long threshold, boolean acceptLarger) {
@@ -608,6 +635,7 @@ public class FileFilterUtils {
* @param minSizeInclusive the minimum file size (inclusive)
* @param maxSizeInclusive the maximum file size (inclusive)
* @return an appropriately configured IOFileFilter
+ * @see SizeFileFilter
* @since Commons IO 1.3
*/
public static IOFileFilter sizeRangeFileFilter(long minSizeInclusive, long maxSizeInclusive ) {
@@ -628,6 +656,7 @@ public class FileFilterUtils {
*
* @throws IllegalArgumentException if <code>magicNumber</code> is
* <code>null</code> or the empty String.
+ * @see MagicNumberFileFilter
* @since Commons IO 2.0
*/
public static IOFileFilter magicNumberFileFilter(String magicNumber) {
@@ -648,6 +677,7 @@ public class FileFilterUtils {
* @throws IllegalArgumentException if <code>magicNumber</code> is
* <code>null</code> or the empty String, or if offset is a
* negative number.
+ * @see MagicNumberFileFilter
* @since Commons IO 2.0
*/
public static IOFileFilter magicNumberFileFilter(String magicNumber, long offset) {
@@ -666,6 +696,7 @@ public class FileFilterUtils {
*
* @throws IllegalArgumentException if <code>magicNumber</code> is
* <code>null</code> or is of length zero.
+ * @see MagicNumberFileFilter
* @since Commons IO 2.0
*/
public static IOFileFilter magicNumberFileFilter(byte[] magicNumber) {
@@ -686,6 +717,7 @@ public class FileFilterUtils {
* @throws IllegalArgumentException if <code>magicNumber</code> is
* <code>null</code>, or contains no bytes, or <code>offset</code>
* is a negative number.
+ * @see MagicNumberFileFilter
* @since Commons IO 2.0
*/
public static IOFileFilter magicNumberFileFilter(byte[] magicNumber, long offset) {
@@ -741,6 +773,7 @@ public class FileFilterUtils {
*
* @param filter the filter to decorate, null means an unrestricted filter
* @return the decorated filter, never null
+ * @see DirectoryFileFilter#DIRECTORY
* @since Commons IO 1.3
*/
public static IOFileFilter makeDirectoryOnly(IOFileFilter filter) {
@@ -755,6 +788,7 @@ public class FileFilterUtils {
*
* @param filter the filter to decorate, null means an unrestricted filter
* @return the decorated filter, never null
+ * @see FileFileFilter#FILE
* @since Commons IO 1.3
*/
public static IOFileFilter makeFileOnly(IOFileFilter filter) {
Modified: commons/proper/io/trunk/src/main/java/org/apache/commons/io/filefilter/MagicNumberFileFilter.java
URL: http://svn.apache.org/viewvc/commons/proper/io/trunk/src/main/java/org/apache/commons/io/filefilter/MagicNumberFileFilter.java?rev=1005099&r1=1005098&r2=1005099&view=diff
==============================================================================
--- commons/proper/io/trunk/src/main/java/org/apache/commons/io/filefilter/MagicNumberFileFilter.java (original)
+++ commons/proper/io/trunk/src/main/java/org/apache/commons/io/filefilter/MagicNumberFileFilter.java Wed Oct 6 16:13:01 2010
@@ -59,6 +59,10 @@ import org.apache.commons.io.IOUtils;
* }
* </pre></code>
* @since Commons IO 2.0
+ * @see FileFilterUtils#magicNumberFileFilter(byte[])
+ * @see FileFilterUtils#magicNumberFileFilter(String)
+ * @see FileFilterUtils#magicNumberFileFilter(byte[], long)
+ * @see FileFilterUtils#magicNumberFileFilter(String, long)
*/
public class MagicNumberFileFilter extends AbstractFileFilter implements
Serializable {
Modified: commons/proper/io/trunk/src/main/java/org/apache/commons/io/filefilter/NameFileFilter.java
URL: http://svn.apache.org/viewvc/commons/proper/io/trunk/src/main/java/org/apache/commons/io/filefilter/NameFileFilter.java?rev=1005099&r1=1005098&r2=1005099&view=diff
==============================================================================
--- commons/proper/io/trunk/src/main/java/org/apache/commons/io/filefilter/NameFileFilter.java (original)
+++ commons/proper/io/trunk/src/main/java/org/apache/commons/io/filefilter/NameFileFilter.java Wed Oct 6 16:13:01 2010
@@ -43,6 +43,8 @@ import org.apache.commons.io.IOCase;
* @author Federico Barbieri
* @author Serge Knystautas
* @author Peter Donald
+ * @see FileFilterUtils#nameFileFilter(String)
+ * @see FileFilterUtils#nameFileFilter(String, IOCase)
*/
public class NameFileFilter extends AbstractFileFilter implements Serializable {
Modified: commons/proper/io/trunk/src/main/java/org/apache/commons/io/filefilter/NotFileFilter.java
URL: http://svn.apache.org/viewvc/commons/proper/io/trunk/src/main/java/org/apache/commons/io/filefilter/NotFileFilter.java?rev=1005099&r1=1005098&r2=1005099&view=diff
==============================================================================
--- commons/proper/io/trunk/src/main/java/org/apache/commons/io/filefilter/NotFileFilter.java (original)
+++ commons/proper/io/trunk/src/main/java/org/apache/commons/io/filefilter/NotFileFilter.java Wed Oct 6 16:13:01 2010
@@ -26,6 +26,7 @@ import java.io.Serializable;
* @version $Revision$ $Date$
*
* @author Stephen Colebourne
+ * @see FileFilterUtils#notFileFilter(IOFileFilter)
*/
public class NotFileFilter extends AbstractFileFilter implements Serializable {
Modified: commons/proper/io/trunk/src/main/java/org/apache/commons/io/filefilter/OrFileFilter.java
URL: http://svn.apache.org/viewvc/commons/proper/io/trunk/src/main/java/org/apache/commons/io/filefilter/OrFileFilter.java?rev=1005099&r1=1005098&r2=1005099&view=diff
==============================================================================
--- commons/proper/io/trunk/src/main/java/org/apache/commons/io/filefilter/OrFileFilter.java (original)
+++ commons/proper/io/trunk/src/main/java/org/apache/commons/io/filefilter/OrFileFilter.java Wed Oct 6 16:13:01 2010
@@ -33,6 +33,7 @@ import java.util.List;
* @version $Revision$ $Date$
*
* @author Steven Caswell
+ * @see FileFilterUtils#or(IOFileFilter...)
*/
public class OrFileFilter
extends AbstractFileFilter
Modified: commons/proper/io/trunk/src/main/java/org/apache/commons/io/filefilter/PrefixFileFilter.java
URL: http://svn.apache.org/viewvc/commons/proper/io/trunk/src/main/java/org/apache/commons/io/filefilter/PrefixFileFilter.java?rev=1005099&r1=1005098&r2=1005099&view=diff
==============================================================================
--- commons/proper/io/trunk/src/main/java/org/apache/commons/io/filefilter/PrefixFileFilter.java (original)
+++ commons/proper/io/trunk/src/main/java/org/apache/commons/io/filefilter/PrefixFileFilter.java Wed Oct 6 16:13:01 2010
@@ -43,6 +43,8 @@ import org.apache.commons.io.IOCase;
* @author Federico Barbieri
* @author Serge Knystautas
* @author Peter Donald
+ * @see FileFilterUtils#prefixFileFilter(String)
+ * @see FileFilterUtils#prefixFileFilter(String, IOCase)
*/
public class PrefixFileFilter extends AbstractFileFilter implements Serializable {
Modified: commons/proper/io/trunk/src/main/java/org/apache/commons/io/filefilter/SizeFileFilter.java
URL: http://svn.apache.org/viewvc/commons/proper/io/trunk/src/main/java/org/apache/commons/io/filefilter/SizeFileFilter.java?rev=1005099&r1=1005098&r2=1005099&view=diff
==============================================================================
--- commons/proper/io/trunk/src/main/java/org/apache/commons/io/filefilter/SizeFileFilter.java (original)
+++ commons/proper/io/trunk/src/main/java/org/apache/commons/io/filefilter/SizeFileFilter.java Wed Oct 6 16:13:01 2010
@@ -37,6 +37,9 @@ import java.io.Serializable;
* @author Rahul Akolkar
* @version $Id$
* @since Commons IO 1.2
+ * @see FileFilterUtils#sizeFileFilter(long)
+ * @see FileFilterUtils#sizeFileFilter(long, boolean)
+ * @see FileFilterUtils#sizeRangeFileFilter(long, long)
*/
public class SizeFileFilter extends AbstractFileFilter implements Serializable {
Modified: commons/proper/io/trunk/src/main/java/org/apache/commons/io/filefilter/SuffixFileFilter.java
URL: http://svn.apache.org/viewvc/commons/proper/io/trunk/src/main/java/org/apache/commons/io/filefilter/SuffixFileFilter.java?rev=1005099&r1=1005098&r2=1005099&view=diff
==============================================================================
--- commons/proper/io/trunk/src/main/java/org/apache/commons/io/filefilter/SuffixFileFilter.java (original)
+++ commons/proper/io/trunk/src/main/java/org/apache/commons/io/filefilter/SuffixFileFilter.java Wed Oct 6 16:13:01 2010
@@ -44,6 +44,8 @@ import org.apache.commons.io.IOCase;
* @author Federico Barbieri
* @author Serge Knystautas
* @author Peter Donald
+ * @see FileFilterUtils#suffixFileFilter(String)
+ * @see FileFilterUtils#suffixFileFilter(String, IOCase)
*/
public class SuffixFileFilter extends AbstractFileFilter implements Serializable {
Modified: commons/proper/io/trunk/src/main/java/org/apache/commons/io/filefilter/TrueFileFilter.java
URL: http://svn.apache.org/viewvc/commons/proper/io/trunk/src/main/java/org/apache/commons/io/filefilter/TrueFileFilter.java?rev=1005099&r1=1005098&r2=1005099&view=diff
==============================================================================
--- commons/proper/io/trunk/src/main/java/org/apache/commons/io/filefilter/TrueFileFilter.java (original)
+++ commons/proper/io/trunk/src/main/java/org/apache/commons/io/filefilter/TrueFileFilter.java Wed Oct 6 16:13:01 2010
@@ -26,6 +26,7 @@ import java.io.Serializable;
* @version $Revision$ $Date$
*
* @author Stephen Colebourne
+ * @see FileFilterUtils#trueFileFilter()
*/
public class TrueFileFilter implements IOFileFilter, Serializable {
Modified: commons/proper/io/trunk/src/main/java/org/apache/commons/io/input/BOMInputStream.java
URL: http://svn.apache.org/viewvc/commons/proper/io/trunk/src/main/java/org/apache/commons/io/input/BOMInputStream.java?rev=1005099&r1=1005098&r2=1005099&view=diff
==============================================================================
--- commons/proper/io/trunk/src/main/java/org/apache/commons/io/input/BOMInputStream.java (original)
+++ commons/proper/io/trunk/src/main/java/org/apache/commons/io/input/BOMInputStream.java Wed Oct 6 16:13:01 2010
@@ -27,8 +27,16 @@ import org.apache.commons.io.ByteOrderMa
* This class is used to wrap a stream that includes an encoded
* {@link ByteOrderMark} as its first bytes.
*
- * This class detects these bytes and, if required, can automatically skip these bytes
- * and return the subsequent byte as the first byte in the stream.
+ * This class detects these bytes and, if required, can automatically skip them
+ * and return the subsequent byte as the first byte in the stream.
+ *
+ * The {@link ByteOrderMark} implementation has the following pre-defined BOMs:
+ * <ul>
+ * <li>UTF-8 - {@link ByteOrderMark#UTF_8}</li>
+ * <li>UTF-16BE - {@link ByteOrderMark#UTF_16LE}</li>
+ * <li>UTF-16LE - {@link ByteOrderMark#UTF_16BE}</li>
+ * </ul>
+ *
*
* <h3>Example 1 - Detect and exclude a UTF-8 BOM</h3>
* <pre>
@@ -47,7 +55,7 @@ import org.apache.commons.io.ByteOrderMa
* }
* </pre>
*
- * <h3>Example 3 - Multiple BOMs</h3>
+ * <h3>Example 3 - Detect Multiple BOMs</h3>
* <pre>
* BOMInputStream bomIn = new BOMInputStream(in, ByteOrderMark.UTF_16LE, ByteOrderMark.UTF_16BE);
* if (bomIn.hasBOM() == false) {
@@ -85,7 +93,7 @@ public class BOMInputStream extends Prox
/**
* Constructs a new BOM InputStream that detects a
- * a {@link ByteOrderMark#UTF_8} and optionally excludes it.
+ * a {@link ByteOrderMark#UTF_8} and optionally includes it.
* @param delegate the InputStream to delegate to
* @param include true to include the UTF-8 BOM or
* false to exclude it
@@ -106,7 +114,7 @@ public class BOMInputStream extends Prox
/**
* Constructs a new BOM InputStream that detects the
- * specified BOMs and optionally excludes them.
+ * specified BOMs and optionally includes them.
* @param delegate the InputStream to delegate to
* @param include true to include the specified BOMs or
* false to exclude them
Modified: commons/proper/io/trunk/src/main/java/org/apache/commons/io/monitor/FilesystemObserver.java
URL: http://svn.apache.org/viewvc/commons/proper/io/trunk/src/main/java/org/apache/commons/io/monitor/FilesystemObserver.java?rev=1005099&r1=1005098&r2=1005099&view=diff
==============================================================================
--- commons/proper/io/trunk/src/main/java/org/apache/commons/io/monitor/FilesystemObserver.java (original)
+++ commons/proper/io/trunk/src/main/java/org/apache/commons/io/monitor/FilesystemObserver.java Wed Oct 6 16:13:01 2010
@@ -82,7 +82,7 @@ import org.apache.commons.io.comparator.
* <p>
* <a href="http://commons.apache.org/io/">Commons IO</a> has a good range of
* useful, ready made
- * <a href="apidocs/org/apache/commons/io/filefilter/package-summary.html">File Filter</a>
+ * <a href="../filefilter/package-summary.html">File Filter</a>
* implementations for this purpose.
* <p>
* For example, to only observe 1) visible directories and 2) files with a ".java" suffix
@@ -107,12 +107,17 @@ import org.apache.commons.io.comparator.
* </pre>
*
* <h2>File Comparator</h2>
+ * <p>
+ * <a href="http://commons.apache.org/io/">Commons IO</a> has a range of
+ * useful, ready made <a href="../comparator/package-summary.html">Comparator</a>
+ * implementations for this purpose.
+ * <p>
* This implementation works by comparing the file names of the current contents of
* a directory with the previous contents using the <i>case-sensitive</i>
* {@link NameFileComparator#NAME_COMPARATOR} to determine which files have been created,
* deleted or still exist. However a custom {@link Comparator} can be specified and
* one example usage would be to compare file names in a <i>case-insensitive</i>
- * manner (@link {@link NameFileComparator#NAME_INSENSITIVE_COMPARATOR} could be used
+ * manner ({@link NameFileComparator#NAME_INSENSITIVE_COMPARATOR} could be used
* to do that).
*
* <h2>FilesystemEntry</h2>
Modified: commons/proper/io/trunk/src/main/java/org/apache/commons/io/monitor/package.html
URL: http://svn.apache.org/viewvc/commons/proper/io/trunk/src/main/java/org/apache/commons/io/monitor/package.html?rev=1005099&r1=1005098&r2=1005099&view=diff
==============================================================================
--- commons/proper/io/trunk/src/main/java/org/apache/commons/io/monitor/package.html (original)
+++ commons/proper/io/trunk/src/main/java/org/apache/commons/io/monitor/package.html Wed Oct 6 16:13:01 2010
@@ -19,7 +19,7 @@ limitations under the License.
<body>
<p>
This package provides a component for monitoring file system events
-(i.e. directory and file create, update and delete events).
+(directory and file create, update and delete events).
</p>
</body>
</html>