FolderWatcher (Fiji Javadocs 0-SNAPSHOT API)

java.lang.Object
- java.util.TimerTask
- - fsalign.FolderWatcher

All Implemented Interfaces:

Runnable
```
public class FolderWatcher
extends TimerTask
```
Author:

Larry Lindsey

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class FolderWatcher.FolderFilter
A FileFilter that accepts all folders that are not a trakem2 cache folder.

Nested Classes
Modifier and Type	Class and Description
`static class`	`FolderWatcher.FolderFilter` A FileFilter that accepts all folders that are not a trakem2 cache folder.

Constructor Summary

Constructors
Constructor and Description
`FolderWatcher(String folderName, long inInterval)`
`FolderWatcher(String folderName, long inInterval, FileFilter filter)`
`FolderWatcher(String folderName, long inInterval, FileFilter filter)` Watch the folder at the given location for changes, polling at a given interval, ignoring all files but those accepted by the given filter.
`FolderWatcher(String folderName, long inInterval, String... extension)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addListener(FileListener fl)`
`boolean`	`cancel()` Stop this FolderWatcher/TimerTask, cancel()'ing all FileListeners as well.
`Vector<File>`	`getFileList()` Returns a list of all files seen.
`Vector<File>`	`getFreshFileList()` Returns a list of file newly seen since the last poll epoch.
`static void`	`main(String[] args)` Because who doesn't like a main method?
`void`	`run()`
`void`	`start()`

Methods inherited from class java.util.TimerTask
scheduledExecutionTime

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - FolderWatcher
```
public FolderWatcher(String folderName,
                     long inInterval)
```
  - FolderWatcher
```
public FolderWatcher(String folderName,
                     long inInterval,
                     String... extension)
```
  - FolderWatcher
```
public FolderWatcher(String folderName,
                     long inInterval,
                     FileFilter filter)
```
  - FolderWatcher
```
public FolderWatcher(String folderName,
                     long inInterval,
                     FileFilter filter)
```
    Watch the folder at the given location for changes, polling at a given interval, ignoring all files but those accepted by the given filter. Does not start() automatically.
    
    Parameters:
    
    folderName - the String path to the folder in question
    
    inInterval - the poll interval in milliseconds
    
    filter - a filter to accept the files that we're interested in.
- Method Detail
  - addListener
```
public void addListener(FileListener fl)
```
  - start
```
public void start()
           throws IOException
```
    Throws:
    
    IOException
  - getFileList
```
public Vector<File> getFileList()
```
    Returns a list of all files seen.
    
    Returns:
    
    a list of all files seen.
  - getFreshFileList
```
public Vector<File> getFreshFileList()
```
    Returns a list of file newly seen since the last poll epoch.
    
    Returns:
    
    a list of file newly seen since the last poll epoch.
  - cancel
```
public boolean cancel()
```
    Stop this FolderWatcher/TimerTask, cancel()'ing all FileListeners as well.
    
    Overrides:
    
    cancel in class TimerTask
    
    Returns:
    
    super.cancel()
  - run
```
public void run()
```
    Specified by:
    
    run in interface Runnable
    
    Specified by:
    
    run in class TimerTask
  - main
```
public static void main(String[] args)
                 throws IOException
```
    Because who doesn't like a main method?
    
    Parameters:
    
    args - looks at args[0] for a folder to watch.
    
    Throws:
    
    IOException

Class FolderWatcher

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.util.TimerTask

Methods inherited from class java.lang.Object

Constructor Detail

FolderWatcher

FolderWatcher

FolderWatcher

FolderWatcher

Method Detail

addListener

start

getFileList

getFreshFileList

cancel

run

main