net.datacrow.filerenamer
Class FileRenamer

java.lang.Object
  extended by net.datacrow.filerenamer.FileRenamer

public class FileRenamer
extends java.lang.Object

A file renamer is capable of renaming physical files using file patterns.

Author:
Robert Jan van der Waals
See Also:
FilePattern

Method Summary
 void cancel()
          Cancels the current task.
static FileRenamer getInstance()
          Returns the instance.
 boolean isRunning()
          Indicates a task is running.
 void start(IFileRenamerListener listener, java.io.File baseDir, FilePattern pattern, java.util.Collection<DcObject> objects)
          Start the renaming process.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getInstance

public static FileRenamer getInstance()
Returns the instance.


start

public void start(IFileRenamerListener listener,
                  java.io.File baseDir,
                  FilePattern pattern,
                  java.util.Collection<DcObject> objects)
Start the renaming process.

Parameters:
listener - The listener to update on events and results.
baseDir - The base directory.
pattern - The file pattern to use.
objects - The items for which the files will be renamed.

isRunning

public boolean isRunning()
Indicates a task is running.

Returns:

cancel

public void cancel()
Cancels the current task.