Holger's
Java API

com.antelmann.io
Class Backup

java.lang.Object
  extended by com.antelmann.io.Backup
All Implemented Interfaces:
Licensed, Runnable

public class Backup
extends Object
implements Runnable, Licensed

allows to easily backup directories. Copied are only those files that do not exist or have a modification date after the one that exists or have a different file length. Other existing files in the target directory remain there.

Author:
Holger Antelmann
See Also:
MyFile.synchronizeDir(File), BackupFrame

Constructor Summary
Backup(File originDir, File destinationDir)
           
Backup(File originDir, File destinationDir, FileFilter filter)
           
Backup(File originDir, File destinationDir, FileFilter filter, boolean deleteAtTarget)
           
Backup(File originDir, File destinationDir, FileFilter filter, boolean deleteAtTarget, Monitor monitor, Logger logger)
           
 
Method Summary
 void cancel()
           
 TimerTask createTimerTask()
           
 boolean getDeleteAtTarget()
           
 File getDestinationDir()
           
 FileFilter getFilter()
           
 Logger getLogger()
           
 Monitor getMonitor()
           
 File getOriginDir()
           
 boolean isRunning()
           
static void main(String[] args)
           
 void run()
          performs the backup operation
 void setDeleteAtTarget(boolean flag)
           
 void setDestinationDir(File destinationDir)
           
 void setExcludeFiles(File[] excludeList)
          replaces any previous filter; the path matching is case-insensitive
 void setFilter(FileFilter filter)
           
 void setLogger(Logger logger)
          the logger may not be set while the backup is running
 void setMonitor(Monitor monitor)
           
 void setNoSubDirsFilter()
          replaces any previous filter
 void setOriginDir(File originDir)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Backup

public Backup(File originDir,
              File destinationDir)

Backup

public Backup(File originDir,
              File destinationDir,
              FileFilter filter)

Backup

public Backup(File originDir,
              File destinationDir,
              FileFilter filter,
              boolean deleteAtTarget)

Backup

public Backup(File originDir,
              File destinationDir,
              FileFilter filter,
              boolean deleteAtTarget,
              Monitor monitor,
              Logger logger)
Method Detail

setNoSubDirsFilter

public void setNoSubDirsFilter()
                        throws IllegalStateException
replaces any previous filter

Throws:
IllegalStateException

setExcludeFiles

public void setExcludeFiles(File[] excludeList)
                     throws IllegalArgumentException
replaces any previous filter; the path matching is case-insensitive

Throws:
IllegalArgumentException

isRunning

public boolean isRunning()

createTimerTask

public TimerTask createTimerTask()

run

public void run()
performs the backup operation

Specified by:
run in interface Runnable

cancel

public void cancel()

getDeleteAtTarget

public boolean getDeleteAtTarget()

getMonitor

public Monitor getMonitor()

getLogger

public Logger getLogger()

getFilter

public FileFilter getFilter()

setDeleteAtTarget

public void setDeleteAtTarget(boolean flag)

setLogger

public void setLogger(Logger logger)
               throws IllegalStateException
the logger may not be set while the backup is running

Throws:
IllegalStateException

setMonitor

public void setMonitor(Monitor monitor)
                throws IllegalStateException
Throws:
IllegalStateException

setFilter

public void setFilter(FileFilter filter)
               throws IllegalStateException
Throws:
IllegalStateException

setOriginDir

public void setOriginDir(File originDir)
                  throws IllegalStateException
Throws:
IllegalStateException

setDestinationDir

public void setDestinationDir(File destinationDir)
                       throws IllegalStateException
Throws:
IllegalStateException

getOriginDir

public File getOriginDir()

getDestinationDir

public File getDestinationDir()

main

public static void main(String[] args)
                 throws IOException
Throws:
IOException


(c) 2001-2006 Holger Antelmann - all rights reserved (contact: info@antelmann.com)
see www.antelmann.com/developer for further details and available downloads