org.codehaus.plexus.archiver

Interface Archiver

Known Implementing Classes:
AbstractArchiver, AbstractZipArchiver, BZip2Archiver, DirectoryArchiver, EarArchiver, GZipArchiver, JarArchiver, TarArchiver, WarArchiver, ZipArchiver

public interface Archiver

Version:
$Revision: 2989 $ $Date: 2006-01-06 20:56:51 -0500 (Fri, 06 Jan 2006) $

Field Summary

static String
ROLE

Method Summary

void
addDirectory(File directory)
void
addDirectory(File directory, String prefix)
void
addDirectory(File directory, String prefix, String[] includes, String[] excludes)
void
addDirectory(File directory, String[] includes, String[] excludes)
void
addFile(File inputFile, String destFileName)
void
addFile(File inputFile, String destFileName, int permissions)
void
createArchive()
int
getDefaultDirectoryMode()
int
getDefaultFileMode()
File
getDestFile()
Map
getFiles()
boolean
getIncludeEmptyDirs()
void
setDefaultDirectoryMode(int mode)
void
setDefaultFileMode(int mode)
void
setDestFile(File destFile)
void
setIncludeEmptyDirs(boolean includeEmptyDirs)

Field Details

ROLE

public static final String ROLE

Method Details

addDirectory

public void addDirectory(File directory)
            throws ArchiverException

addDirectory

public void addDirectory(File directory,
                         String prefix)
            throws ArchiverException

addDirectory

public void addDirectory(File directory,
                         String prefix,
                         String[] includes,
                         String[] excludes)
            throws ArchiverException

addDirectory

public void addDirectory(File directory,
                         String[] includes,
                         String[] excludes)
            throws ArchiverException

addFile

public void addFile(File inputFile,
                    String destFileName)
            throws ArchiverException

addFile

public void addFile(File inputFile,
                    String destFileName,
                    int permissions)
            throws ArchiverException

createArchive

public void createArchive()
            throws ArchiverException,
                   IOException

getDefaultDirectoryMode

public int getDefaultDirectoryMode()

getDefaultFileMode

public int getDefaultFileMode()

getDestFile

public File getDestFile()

getFiles

public Map getFiles()

getIncludeEmptyDirs

public boolean getIncludeEmptyDirs()

setDefaultDirectoryMode

public void setDefaultDirectoryMode(int mode)

setDefaultFileMode

public void setDefaultFileMode(int mode)

setDestFile

public void setDestFile(File destFile)

setIncludeEmptyDirs

public void setIncludeEmptyDirs(boolean includeEmptyDirs)