uk.org.retep.util.io.zip
Class ZipFileVisitor

java.lang.Object
  uk.org.retep.util.io.AbstractFileVisitor
      uk.org.retep.util.io.zip.ZipFileVisitor

All Implemented Interfaces:

FileVisitor

public class ZipFileVisitor
extends AbstractFileVisitor

Author:

peter

Constructor Summary

ZipFileVisitor(Log log, java.lang.String message, java.util.zip.ZipOutputStream zos)
Construct a visitor with a Log and a message to log whenever an action is performed and returns true.

ZipFileVisitor(Log log, java.lang.String message, java.util.zip.ZipOutputStream zos, java.io.File baseDir)
Construct a visitor with a Log and a message to log whenever an action is performed and returns true.

ZipFileVisitor(Log log, java.util.zip.ZipOutputStream zos)
Equivalent to new AbstractFileVisitor( log, "Modified %s" );

ZipFileVisitor(Log log, java.util.zip.ZipOutputStream zos, java.io.File baseDir)
Equivalent to new AbstractFileVisitor( log, "Modified %s" );

ZipFileVisitor(java.util.zip.ZipOutputStream zos)
Create a visitor with no logging

ZipFileVisitor(java.util.zip.ZipOutputStream zos, java.io.File baseDir)
Create a visitor with no logging

Method Summary

protected boolean	execute(java.io.File file) Subclasses implement this method to perform an action on a File.
void	setBaseDir(java.io.File baseDir)
void	setBaseDir(java.lang.String baseDir)
void	setDirPrefix(java.lang.String dirPrefix)

Methods inherited from class uk.org.retep.util.io.AbstractFileVisitor

error, fatal, info, visit, warn

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ZipFileVisitor

public ZipFileVisitor(java.util.zip.ZipOutputStream zos)

Create a visitor with no logging

Parameters:

zos - ZipOutputStream to write to

ZipFileVisitor

public ZipFileVisitor(Log log,
                      java.util.zip.ZipOutputStream zos)

Equivalent to new AbstractFileVisitor( log, "Modified %s" );

Parameters:

log - Log to use, ignored if null

zos - ZipOutputStream to write to

ZipFileVisitor

public ZipFileVisitor(Log log,
                      java.lang.String message,
                      java.util.zip.ZipOutputStream zos)

Construct a visitor with a Log and a message to log whenever an action is performed and returns true.

Parameters:

log - Log to use, ignored if null

message - The message to log when an action is performed and log is not null. One instance of %s is permitted, which is replaced by File.getPath()

zos - ZipOutputStream to write to

ZipFileVisitor

public ZipFileVisitor(java.util.zip.ZipOutputStream zos,
                      java.io.File baseDir)
               throws java.io.IOException

Create a visitor with no logging

Parameters:

zos - ZipOutputStream to write to

baseDir -

Throws:

java.io.IOException

ZipFileVisitor

public ZipFileVisitor(Log log,
                      java.util.zip.ZipOutputStream zos,
                      java.io.File baseDir)
               throws java.io.IOException

Equivalent to new AbstractFileVisitor( log, "Modified %s" );

Parameters:

log - Log to use, ignored if null

zos - ZipOutputStream to write to

baseDir -

Throws:

java.io.IOException

ZipFileVisitor

public ZipFileVisitor(Log log,
                      java.lang.String message,
                      java.util.zip.ZipOutputStream zos,
                      java.io.File baseDir)
               throws java.io.IOException

Construct a visitor with a Log and a message to log whenever an action is performed and returns true.

Parameters:

log - Log to use, ignored if null

message - The message to log when an action is performed and log is not null. One instance of %s is permitted, which is replaced by File.getPath()

zos - ZipOutputStream to write to

baseDir -

Throws:

java.io.IOException

Method Detail

setDirPrefix

public void setDirPrefix(java.lang.String dirPrefix)

setBaseDir

public void setBaseDir(java.lang.String baseDir)

setBaseDir

public void setBaseDir(java.io.File baseDir)
                throws java.io.IOException

Throws:

java.io.IOException

execute

protected boolean execute(java.io.File file)
                   throws java.io.IOException

Description copied from class: AbstractFileVisitor

Subclasses implement this method to perform an action on a File.

Specified by:

execute in class AbstractFileVisitor

Parameters:

file - File to visit

Returns:

true if an operation succeded, false if it did not perform

Throws:

java.io.IOException - when an error occurs