Javadoc.

garydgregory · garydgregory · commit e997b9c670fb · 2020-05-04T10:29:31.000-04:00
diff --git a/src/main/java/org/apache/commons/io/monitor/FileAlterationMonitor.java b/src/main/java/org/apache/commons/io/monitor/FileAlterationMonitor.java
@@ -36,14 +36,14 @@ public final class FileAlterationMonitor implements Runnable {
     private volatile boolean running = false;
 
     /**
-     * Construct a monitor with a default interval of 10 seconds.
+     * Constructs a monitor with a default interval of 10 seconds.
      */
     public FileAlterationMonitor() {
         this(10000);
     }
 
     /**
-     * Construct a monitor with the specified interval.
+     * Constructs a monitor with the specified interval.
      *
      * @param interval The amount of time in milliseconds to wait between
      * checks of the file system
@@ -53,7 +53,7 @@ public FileAlterationMonitor(final long interval) {
     }
 
     /**
-     * Construct a monitor with the specified interval and set of observers.
+     * Constructs a monitor with the specified interval and set of observers.
      *
      * @param interval The amount of time in milliseconds to wait between
      * checks of the file system
@@ -69,7 +69,7 @@ public FileAlterationMonitor(final long interval, final FileAlterationObserver..
     }
 
     /**
-     * Return the interval.
+     * Returns the interval.
      *
      * @return the interval
      */
@@ -78,7 +78,7 @@ public long getInterval() {
     }
 
     /**
-     * Set the thread factory.
+     * Sets the thread factory.
      *
      * @param threadFactory the thread factory
      */
@@ -87,7 +87,7 @@ public synchronized void setThreadFactory(final ThreadFactory threadFactory) {
     }
 
     /**
-     * Add a file system observer to this monitor.
+     * Adds a file system observer to this monitor.
      *
      * @param observer The file system observer to add
      */
@@ -98,13 +98,14 @@ public void addObserver(final FileAlterationObserver observer) {
     }
 
     /**
-     * Remove a file system observer from this monitor.
+     * Removes a file system observer from this monitor.
      *
      * @param observer The file system observer to remove
      */
     public void removeObserver(final FileAlterationObserver observer) {
         if (observer != null) {
             while (observers.remove(observer)) {
+                // empty
             }
         }
     }
@@ -120,7 +121,7 @@ public Iterable<FileAlterationObserver> getObservers() {
     }
 
     /**
-     * Start monitoring.
+     * Starts monitoring.
      *
      * @throws Exception if an error occurs initializing the observer
      */
@@ -141,7 +142,7 @@ public synchronized void start() throws Exception {
     }
 
     /**
-     * Stop monitoring.
+     * Stops monitoring.
      *
      * @throws Exception if an error occurs initializing the observer
      */
@@ -150,7 +151,7 @@ public synchronized void stop() throws Exception {
     }
 
     /**
-     * Stop monitoring.
+     * Stops monitoring.
      *
      * @param stopInterval the amount of time in milliseconds to wait for the thread to finish.
      * A value of zero will wait until the thread is finished (see {@link Thread#join(long)}).
@@ -174,7 +175,7 @@ public synchronized void stop(final long stopInterval) throws Exception {
     }
 
     /**
-     * Run.
+     * Runs this monitor.
      */
     @Override
     public void run() {
diff --git a/src/main/java/org/apache/commons/io/monitor/FileAlterationObserver.java b/src/main/java/org/apache/commons/io/monitor/FileAlterationObserver.java
@@ -128,7 +128,7 @@ public class FileAlterationObserver implements Serializable {
     private final Comparator<File> comparator;
 
     /**
-     * Construct an observer for the specified directory.
+     * Constructs an observer for the specified directory.
      *
      * @param directoryName the name of the directory to observe
      */
@@ -137,7 +137,7 @@ public FileAlterationObserver(final String directoryName) {
     }
 
     /**
-     * Construct an observer for the specified directory and file filter.
+     * Constructs an observer for the specified directory and file filter.
      *
      * @param directoryName the name of the directory to observe
      * @param fileFilter The file filter or null if none
@@ -160,7 +160,7 @@ public FileAlterationObserver(final String directoryName, final FileFilter fileF
     }
 
     /**
-     * Construct an observer for the specified directory.
+     * Constructs an observer for the specified directory.
      *
      * @param directory the directory to observe
      */
@@ -169,7 +169,7 @@ public FileAlterationObserver(final File directory) {
     }
 
     /**
-     * Construct an observer for the specified directory and file filter.
+     * Constructs an observer for the specified directory and file filter.
      *
      * @param directory the directory to observe
      * @param fileFilter The file filter or null if none
@@ -179,7 +179,7 @@ public FileAlterationObserver(final File directory, final FileFilter fileFilter)
     }
 
     /**
-     * Construct an observer for the specified directory, file filter and
+     * Constructs an observer for the specified directory, file filter and
      * file comparator.
      *
      * @param directory the directory to observe
@@ -191,7 +191,7 @@ public FileAlterationObserver(final File directory, final FileFilter fileFilter,
     }
 
     /**
-     * Construct an observer for the specified directory, file filter and
+     * Constructs an observer for the specified directory, file filter and
      * file comparator.
      *
      * @param rootEntry the root directory to observe
@@ -218,7 +218,7 @@ protected FileAlterationObserver(final FileEntry rootEntry, final FileFilter fil
     }
 
     /**
-     * Return the directory being observed.
+     * Returns the directory being observed.
      *
      * @return the directory being observed
      */
@@ -227,7 +227,7 @@ public File getDirectory() {
     }
 
     /**
-     * Return the fileFilter.
+     * Returns the fileFilter.
      *
      * @return the fileFilter
      * @since 2.1
@@ -237,7 +237,7 @@ public FileFilter getFileFilter() {
     }
 
     /**
-     * Add a file system listener.
+     * Adds a file system listener.
      *
      * @param listener The file system listener
      */
@@ -248,13 +248,14 @@ public void addListener(final FileAlterationListener listener) {
     }
 
     /**
-     * Remove a file system listener.
+     * Removes a file system listener.
      *
      * @param listener The file system listener
      */
     public void removeListener(final FileAlterationListener listener) {
         if (listener != null) {
             while (listeners.remove(listener)) {
+                // empty
             }
         }
     }
@@ -269,7 +270,7 @@ public Iterable<FileAlterationListener> getListeners() {
     }
 
     /**
-     * Initialize the observer.
+     * Initializes the observer.
      *
      * @throws Exception if an error occurs
      */
@@ -289,7 +290,7 @@ public void destroy() throws Exception {
     }
 
     /**
-     * Check whether the file and its children have been created, modified or deleted.
+     * Checks whether the file and its children have been created, modified or deleted.
      */
     public void checkAndNotify() {
 
@@ -315,7 +316,7 @@ public void checkAndNotify() {
     }
 
     /**
-     * Compare two file lists for files which have been created, modified or deleted.
+     * Compares two file lists for files which have been created, modified or deleted.
      *
      * @param parent The parent entry
      * @param previous The original list of files
@@ -348,7 +349,7 @@ private void checkAndNotify(final FileEntry parent, final FileEntry[] previous,
     }
 
     /**
-     * Create a new file entry for the specified file.
+     * Creates a new file entry for the specified file.
      *
      * @param parent The parent file entry
      * @param file The file to create an entry for
@@ -363,7 +364,7 @@ private FileEntry createFileEntry(final FileEntry parent, final File file) {
     }
 
     /**
-     * List the files
+     * Lists the files
      * @param file The file to list files for
      * @param entry the parent entry
      * @return The child files
@@ -378,7 +379,7 @@ private FileEntry[] doListFiles(final File file, final FileEntry entry) {
     }
 
     /**
-     * Fire directory/file created events to the registered listeners.
+     * Fires directory/file created events to the registered listeners.
      *
      * @param entry The file entry
      */
@@ -397,7 +398,7 @@ private void doCreate(final FileEntry entry) {
     }
 
     /**
-     * Fire directory/file change events to the registered listeners.
+     * Fires directory/file change events to the registered listeners.
      *
      * @param entry The previous file system entry
      * @param file The current file
@@ -415,7 +416,7 @@ private void doMatch(final FileEntry entry, final File file) {
     }
 
     /**
-     * Fire directory/file delete events to the registered listeners.
+     * Fires directory/file delete events to the registered listeners.
      *
      * @param entry The file entry
      */
@@ -430,7 +431,7 @@ private void doDelete(final FileEntry entry) {
     }
 
     /**
-     * List the contents of a directory
+     * Lists the contents of a directory
      *
      * @param file The file to list the contents of
      * @return the directory contents or a zero length array if
@@ -451,7 +452,7 @@ private File[] listFiles(final File file) {
     }
 
     /**
-     * Provide a String representation of this observer.
+     * Returns a String representation of this observer.
      *
      * @return a String representation of this observer
      */

Original file line number	Diff line number	Diff line change
`@@ -36,14 +36,14 @@ public final class FileAlterationMonitor implements Runnable {`
`36`	`36`	`private volatile boolean running = false;`
`37`	`37`
`38`	`38`	`/**`
`39`		`- * Construct a monitor with a default interval of 10 seconds.`
	`39`	`+ * Constructs a monitor with a default interval of 10 seconds.`
`40`	`40`	`*/`
`41`	`41`	`public FileAlterationMonitor() {`
`42`	`42`	`this(10000);`
`43`	`43`	`}`
`44`	`44`
`45`	`45`	`/**`
`46`		`- * Construct a monitor with the specified interval.`
	`46`	`+ * Constructs a monitor with the specified interval.`
`47`	`47`	`*`
`48`	`48`	`* @param interval The amount of time in milliseconds to wait between`
`49`	`49`	`* checks of the file system`
`@@ -53,7 +53,7 @@ public FileAlterationMonitor(final long interval) {`
`53`	`53`	`}`
`54`	`54`
`55`	`55`	`/**`
`56`		`- * Construct a monitor with the specified interval and set of observers.`
	`56`	`+ * Constructs a monitor with the specified interval and set of observers.`
`57`	`57`	`*`
`58`	`58`	`* @param interval The amount of time in milliseconds to wait between`
`59`	`59`	`* checks of the file system`
`@@ -69,7 +69,7 @@ public FileAlterationMonitor(final long interval, final FileAlterationObserver..`
`69`	`69`	`}`
`70`	`70`
`71`	`71`	`/**`
`72`		`- * Return the interval.`
	`72`	`+ * Returns the interval.`
`73`	`73`	`*`
`74`	`74`	`* @return the interval`
`75`	`75`	`*/`
`@@ -78,7 +78,7 @@ public long getInterval() {`
`78`	`78`	`}`
`79`	`79`
`80`	`80`	`/**`
`81`		`- * Set the thread factory.`
	`81`	`+ * Sets the thread factory.`
`82`	`82`	`*`
`83`	`83`	`* @param threadFactory the thread factory`
`84`	`84`	`*/`
`@@ -87,7 +87,7 @@ public synchronized void setThreadFactory(final ThreadFactory threadFactory) {`
`87`	`87`	`}`
`88`	`88`
`89`	`89`	`/**`
`90`		`- * Add a file system observer to this monitor.`
	`90`	`+ * Adds a file system observer to this monitor.`
`91`	`91`	`*`
`92`	`92`	`* @param observer The file system observer to add`
`93`	`93`	`*/`
`@@ -98,13 +98,14 @@ public void addObserver(final FileAlterationObserver observer) {`
`98`	`98`	`}`
`99`	`99`
`100`	`100`	`/**`
`101`		`- * Remove a file system observer from this monitor.`
	`101`	`+ * Removes a file system observer from this monitor.`
`102`	`102`	`*`
`103`	`103`	`* @param observer The file system observer to remove`
`104`	`104`	`*/`
`105`	`105`	`public void removeObserver(final FileAlterationObserver observer) {`
`106`	`106`	`if (observer != null) {`
`107`	`107`	`while (observers.remove(observer)) {`
	`108`	`+ // empty`
`108`	`109`	`}`
`109`	`110`	`}`
`110`	`111`	`}`
`@@ -120,7 +121,7 @@ public Iterable<FileAlterationObserver> getObservers() {`
`120`	`121`	`}`
`121`	`122`
`122`	`123`	`/**`
`123`		`- * Start monitoring.`
	`124`	`+ * Starts monitoring.`
`124`	`125`	`*`
`125`	`126`	`* @throws Exception if an error occurs initializing the observer`
`126`	`127`	`*/`
`@@ -141,7 +142,7 @@ public synchronized void start() throws Exception {`
`141`	`142`	`}`
`142`	`143`
`143`	`144`	`/**`
`144`		`- * Stop monitoring.`
	`145`	`+ * Stops monitoring.`
`145`	`146`	`*`
`146`	`147`	`* @throws Exception if an error occurs initializing the observer`
`147`	`148`	`*/`
`@@ -150,7 +151,7 @@ public synchronized void stop() throws Exception {`
`150`	`151`	`}`
`151`	`152`
`152`	`153`	`/**`
`153`		`- * Stop monitoring.`
	`154`	`+ * Stops monitoring.`
`154`	`155`	`*`
`155`	`156`	`* @param stopInterval the amount of time in milliseconds to wait for the thread to finish.`
`156`	`157`	`* A value of zero will wait until the thread is finished (see {@link Thread#join(long)}).`
`@@ -174,7 +175,7 @@ public synchronized void stop(final long stopInterval) throws Exception {`
`174`	`175`	`}`
`175`	`176`
`176`	`177`	`/**`
`177`		`- * Run.`
	`178`	`+ * Runs this monitor.`
`178`	`179`	`*/`
`179`	`180`	`@Override`
`180`	`181`	`public void run() {`
Original file line number	Diff line number	Diff line change
`@@ -128,7 +128,7 @@ public class FileAlterationObserver implements Serializable {`
`128`	`128`	`private final Comparator<File> comparator;`
`129`	`129`
`130`	`130`	`/**`
`131`		`- * Construct an observer for the specified directory.`
	`131`	`+ * Constructs an observer for the specified directory.`
`132`	`132`	`*`
`133`	`133`	`* @param directoryName the name of the directory to observe`
`134`	`134`	`*/`
`@@ -137,7 +137,7 @@ public FileAlterationObserver(final String directoryName) {`
`137`	`137`	`}`
`138`	`138`
`139`	`139`	`/**`
`140`		`- * Construct an observer for the specified directory and file filter.`
	`140`	`+ * Constructs an observer for the specified directory and file filter.`
`141`	`141`	`*`
`142`	`142`	`* @param directoryName the name of the directory to observe`
`143`	`143`	`* @param fileFilter The file filter or null if none`
`@@ -160,7 +160,7 @@ public FileAlterationObserver(final String directoryName, final FileFilter fileF`
`160`	`160`	`}`
`161`	`161`
`162`	`162`	`/**`
`163`		`- * Construct an observer for the specified directory.`
	`163`	`+ * Constructs an observer for the specified directory.`
`164`	`164`	`*`
`165`	`165`	`* @param directory the directory to observe`
`166`	`166`	`*/`
`@@ -169,7 +169,7 @@ public FileAlterationObserver(final File directory) {`
`169`	`169`	`}`
`170`	`170`
`171`	`171`	`/**`
`172`		`- * Construct an observer for the specified directory and file filter.`
	`172`	`+ * Constructs an observer for the specified directory and file filter.`
`173`	`173`	`*`
`174`	`174`	`* @param directory the directory to observe`
`175`	`175`	`* @param fileFilter The file filter or null if none`
`@@ -179,7 +179,7 @@ public FileAlterationObserver(final File directory, final FileFilter fileFilter)`
`179`	`179`	`}`
`180`	`180`
`181`	`181`	`/**`
`182`		`- * Construct an observer for the specified directory, file filter and`
	`182`	`+ * Constructs an observer for the specified directory, file filter and`
`183`	`183`	`* file comparator.`
`184`	`184`	`*`
`185`	`185`	`* @param directory the directory to observe`
`@@ -191,7 +191,7 @@ public FileAlterationObserver(final File directory, final FileFilter fileFilter,`
`191`	`191`	`}`
`192`	`192`
`193`	`193`	`/**`
`194`		`- * Construct an observer for the specified directory, file filter and`
	`194`	`+ * Constructs an observer for the specified directory, file filter and`
`195`	`195`	`* file comparator.`
`196`	`196`	`*`
`197`	`197`	`* @param rootEntry the root directory to observe`
`@@ -218,7 +218,7 @@ protected FileAlterationObserver(final FileEntry rootEntry, final FileFilter fil`
`218`	`218`	`}`
`219`	`219`
`220`	`220`	`/**`
`221`		`- * Return the directory being observed.`
	`221`	`+ * Returns the directory being observed.`
`222`	`222`	`*`
`223`	`223`	`* @return the directory being observed`
`224`	`224`	`*/`
`@@ -227,7 +227,7 @@ public File getDirectory() {`
`227`	`227`	`}`
`228`	`228`
`229`	`229`	`/**`
`230`		`- * Return the fileFilter.`
	`230`	`+ * Returns the fileFilter.`
`231`	`231`	`*`
`232`	`232`	`* @return the fileFilter`
`233`	`233`	`* @since 2.1`
`@@ -237,7 +237,7 @@ public FileFilter getFileFilter() {`
`237`	`237`	`}`
`238`	`238`
`239`	`239`	`/**`
`240`		`- * Add a file system listener.`
	`240`	`+ * Adds a file system listener.`
`241`	`241`	`*`
`242`	`242`	`* @param listener The file system listener`
`243`	`243`	`*/`
`@@ -248,13 +248,14 @@ public void addListener(final FileAlterationListener listener) {`
`248`	`248`	`}`
`249`	`249`
`250`	`250`	`/**`
`251`		`- * Remove a file system listener.`
	`251`	`+ * Removes a file system listener.`
`252`	`252`	`*`
`253`	`253`	`* @param listener The file system listener`
`254`	`254`	`*/`
`255`	`255`	`public void removeListener(final FileAlterationListener listener) {`
`256`	`256`	`if (listener != null) {`
`257`	`257`	`while (listeners.remove(listener)) {`
	`258`	`+ // empty`
`258`	`259`	`}`
`259`	`260`	`}`
`260`	`261`	`}`
`@@ -269,7 +270,7 @@ public Iterable<FileAlterationListener> getListeners() {`
`269`	`270`	`}`
`270`	`271`
`271`	`272`	`/**`
`272`		`- * Initialize the observer.`
	`273`	`+ * Initializes the observer.`
`273`	`274`	`*`
`274`	`275`	`* @throws Exception if an error occurs`
`275`	`276`	`*/`
`@@ -289,7 +290,7 @@ public void destroy() throws Exception {`
`289`	`290`	`}`
`290`	`291`
`291`	`292`	`/**`
`292`		`- * Check whether the file and its children have been created, modified or deleted.`
	`293`	`+ * Checks whether the file and its children have been created, modified or deleted.`
`293`	`294`	`*/`
`294`	`295`	`public void checkAndNotify() {`
`295`	`296`
`@@ -315,7 +316,7 @@ public void checkAndNotify() {`
`315`	`316`	`}`
`316`	`317`
`317`	`318`	`/**`
`318`		`- * Compare two file lists for files which have been created, modified or deleted.`
	`319`	`+ * Compares two file lists for files which have been created, modified or deleted.`
`319`	`320`	`*`
`320`	`321`	`* @param parent The parent entry`
`321`	`322`	`* @param previous The original list of files`
`@@ -348,7 +349,7 @@ private void checkAndNotify(final FileEntry parent, final FileEntry[] previous,`
`348`	`349`	`}`
`349`	`350`
`350`	`351`	`/**`
`351`		`- * Create a new file entry for the specified file.`
	`352`	`+ * Creates a new file entry for the specified file.`
`352`	`353`	`*`
`353`	`354`	`* @param parent The parent file entry`
`354`	`355`	`* @param file The file to create an entry for`
`@@ -363,7 +364,7 @@ private FileEntry createFileEntry(final FileEntry parent, final File file) {`
`363`	`364`	`}`
`364`	`365`
`365`	`366`	`/**`
`366`		`- * List the files`
	`367`	`+ * Lists the files`
`367`	`368`	`* @param file The file to list files for`
`368`	`369`	`* @param entry the parent entry`
`369`	`370`	`* @return The child files`
`@@ -378,7 +379,7 @@ private FileEntry[] doListFiles(final File file, final FileEntry entry) {`
`378`	`379`	`}`
`379`	`380`
`380`	`381`	`/**`
`381`		`- * Fire directory/file created events to the registered listeners.`
	`382`	`+ * Fires directory/file created events to the registered listeners.`
`382`	`383`	`*`
`383`	`384`	`* @param entry The file entry`
`384`	`385`	`*/`
`@@ -397,7 +398,7 @@ private void doCreate(final FileEntry entry) {`
`397`	`398`	`}`
`398`	`399`
`399`	`400`	`/**`
`400`		`- * Fire directory/file change events to the registered listeners.`
	`401`	`+ * Fires directory/file change events to the registered listeners.`
`401`	`402`	`*`
`402`	`403`	`* @param entry The previous file system entry`
`403`	`404`	`* @param file The current file`
`@@ -415,7 +416,7 @@ private void doMatch(final FileEntry entry, final File file) {`
`415`	`416`	`}`
`416`	`417`
`417`	`418`	`/**`
`418`		`- * Fire directory/file delete events to the registered listeners.`
	`419`	`+ * Fires directory/file delete events to the registered listeners.`
`419`	`420`	`*`
`420`	`421`	`* @param entry The file entry`
`421`	`422`	`*/`
`@@ -430,7 +431,7 @@ private void doDelete(final FileEntry entry) {`
`430`	`431`	`}`
`431`	`432`
`432`	`433`	`/**`
`433`		`- * List the contents of a directory`
	`434`	`+ * Lists the contents of a directory`
`434`	`435`	`*`
`435`	`436`	`* @param file The file to list the contents of`
`436`	`437`	`* @return the directory contents or a zero length array if`
`@@ -451,7 +452,7 @@ private File[] listFiles(final File file) {`
`451`	`452`	`}`
`452`	`453`
`453`	`454`	`/**`
`454`		`- * Provide a String representation of this observer.`
	`455`	`+ * Returns a String representation of this observer.`
`455`	`456`	`*`
`456`	`457`	`* @return a String representation of this observer`
`457`	`458`	`*/`