uk.org.retep.util.io.tar
Class TarCreateFileVisitor

java.lang.Object
  uk.org.retep.util.io.AbstractFileVisitor
      uk.org.retep.util.io.tar.TarCreateFileVisitor

All Implemented Interfaces:

FileVisitor

public abstract class TarCreateFileVisitor
extends AbstractFileVisitor

A FileVisitor that can write to a TarOutputStream

Author:

peter

Constructor Summary

TarCreateFileVisitor(Log log, java.lang.String message, WritableTar wt)
Equivalent to new AbstractFileVisitor( log, "Modified %s" );

Method Summary

protected abstract void	copyFile(java.io.File file) Copy the File contents into the archive.
static TarCreateFileVisitor	createVisitor(Log log, java.lang.String message, TarOutputStream tos) Returns a TarCreateFileVisitor that will write entries to a TarOutputStream
static TarCreateFileVisitor	createVisitor(Log log, java.lang.String message, WritableTarChannel wt) Returns a TarCreateFileVisitor that will write entries to a WritableTarChannel
static TarCreateFileVisitor	createVisitor(Log log, TarOutputStream tos) Returns a TarCreateFileVisitor that will write entries to a TarOutputStream
static TarCreateFileVisitor	createVisitor(Log log, WritableTarChannel wt) Returns a TarCreateFileVisitor that will write entries to a WritableTarChannel
static TarCreateFileVisitor	createVisitor(TarOutputStream tos) Returns a TarCreateFileVisitor that will write entries to a TarOutputStream
static TarCreateFileVisitor	createVisitor(WritableTarChannel wt) Returns a TarCreateFileVisitor that will write entries to a WritableTarChannel
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

TarCreateFileVisitor

public TarCreateFileVisitor(Log log,
                            java.lang.String message,
                            WritableTar wt)

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

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()

wt - WritableTar representing the archive

Method Detail

createVisitor

public static TarCreateFileVisitor createVisitor(TarOutputStream tos)

Returns a TarCreateFileVisitor that will write entries to a TarOutputStream

Parameters:

tos - TarOutputStream to write to

Returns:

createVisitor

public static TarCreateFileVisitor createVisitor(Log log,
                                                 TarOutputStream tos)

Returns a TarCreateFileVisitor that will write entries to a TarOutputStream

Parameters:

log - Log or null if no logging

tos - TarOutputStream to write to

Returns:

createVisitor

public static TarCreateFileVisitor createVisitor(Log log,
                                                 java.lang.String message,
                                                 TarOutputStream tos)

Returns a TarCreateFileVisitor that will write entries to a TarOutputStream

Parameters:

log - Log or null if no logging

message - if log!=null then the message or null for a default

tos - TarOutputStream to write to

Returns:

createVisitor

public static TarCreateFileVisitor createVisitor(WritableTarChannel wt)

Returns a TarCreateFileVisitor that will write entries to a WritableTarChannel

Parameters:

wt - WritableTarChannel to write to

Returns:

createVisitor

public static TarCreateFileVisitor createVisitor(Log log,
                                                 WritableTarChannel wt)

Returns a TarCreateFileVisitor that will write entries to a WritableTarChannel

Parameters:

log - Log or null if no logging

wt - WritableTarChannel to write to

Returns:

createVisitor

public static TarCreateFileVisitor createVisitor(Log log,
                                                 java.lang.String message,
                                                 WritableTarChannel wt)

Returns a TarCreateFileVisitor that will write entries to a WritableTarChannel

Parameters:

log - Log or null if no logging

message - if log!=null then the message or null for a default

wt - WritableTarChannel to write to

Returns:

copyFile

protected abstract void copyFile(java.io.File file)
                          throws java.io.IOException

Copy the File contents into the archive.

Parameters:

file -

Throws:

java.io.IOException

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