org.codehaus.plexus.archiver

Class AbstractArchiver

public abstract class AbstractArchiver extends AbstractLogEnabled implements Archiver, Contextualizable, FilterEnabled, FinalizerEnabled

Version: $Id: AbstractArchiver.java 8217 2009-05-27 00:56:55Z jdcasey $

Method Summary
voidaddArchivedFileSet(ArchivedFileSet fileSet)
voidaddArchivedFileSet(File archiveFile, String prefix, String[] includes, String[] excludes)
voidaddArchivedFileSet(File archiveFile, String prefix)
voidaddArchivedFileSet(File archiveFile, String[] includes, String[] excludes)
voidaddArchivedFileSet(File archiveFile)
voidaddArchiveFinalizer(ArchiveFinalizer finalizer)
voidaddDirectory(File directory)
voidaddDirectory(File directory, String prefix)
voidaddDirectory(File directory, String[] includes, String[] excludes)
voidaddDirectory(File directory, String prefix, String[] includes, String[] excludes)
voidaddFile(File inputFile, String destFileName)
voidaddFile(File inputFile, String destFileName, int permissions)
voidaddFileSet(FileSet fileSet)
voidaddResource(PlexusIoResource resource, String destFileName, int permissions)
voidaddResources(PlexusIoResourceCollection collection)
Adds a resource collection to the archive.
protected ArchiveEntryasArchiveEntry(PlexusIoResource resource, String destFileName, int permissions)
protected ArchiveEntryasArchiveEntry(PlexusIoResourceCollection collection, PlexusIoResource resource)
protected PlexusIoResourceCollectionasResourceCollection(ArchivedFileSet fileSet)
protected booleancheckForced()
protected voidcleanUp()
protected abstract voidclose()
voidcontextualize(Context context)
Allows us to pull the ArchiverManager instance out of the container without causing a chicken-and-egg instantiation/composition problem.
voidcreateArchive()
protected abstract voidexecute()
protected ListgetArchiveFinalizers()
protected abstract StringgetArchiveType()
intgetDefaultDirectoryMode()
intgetDefaultFileMode()
FilegetDestFile()
intgetDirectoryMode()
MapgetDirs()
StringgetDuplicateBehavior()
intgetFileMode()
MapgetFiles()
booleangetIncludeEmptyDirs()
protected LoggergetLogger()
intgetOverrideDirectoryMode()
intgetOverrideFileMode()
intgetRawDefaultDirectoryMode()
intgetRawDefaultFileMode()
ResourceIteratorgetResources()
protected booleanhasVirtualFiles()
booleanisForced()
booleanisSupportingForced()
protected booleanisUptodate()
protected booleanrevert(StringBuffer messageBuffer)
protected voidrunArchiveFinalizers()
voidsetArchiveFilters(List filters)
voidsetArchiveFinalizers(List archiveFinalizers)
voidsetDefaultDirectoryMode(int mode)
voidsetDefaultFileMode(int mode)
voidsetDestFile(File destFile)
voidsetDirectoryMode(int mode)
voidsetDotFileDirectory(File dotFileDirectory)
voidsetDuplicateBehavior(String duplicate)
voidsetFileMode(int mode)
voidsetForced(boolean forced)
voidsetIncludeEmptyDirs(boolean includeEmptyDirs)
protected voidvalidate()

Method Detail

addArchivedFileSet

public void addArchivedFileSet(ArchivedFileSet fileSet)

addArchivedFileSet

public void addArchivedFileSet(File archiveFile, String prefix, String[] includes, String[] excludes)

Since: 1.0-alpha-7

addArchivedFileSet

public void addArchivedFileSet(File archiveFile, String prefix)

Since: 1.0-alpha-7

addArchivedFileSet

public void addArchivedFileSet(File archiveFile, String[] includes, String[] excludes)

Since: 1.0-alpha-7

addArchivedFileSet

public void addArchivedFileSet(File archiveFile)

Since: 1.0-alpha-7

addArchiveFinalizer

public void addArchiveFinalizer(ArchiveFinalizer finalizer)

addDirectory

public void addDirectory(File directory)

addDirectory

public void addDirectory(File directory, String prefix)

addDirectory

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

addDirectory

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

addFile

public void addFile(File inputFile, String destFileName)

addFile

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

addFileSet

public void addFileSet(FileSet fileSet)

addResource

public void addResource(PlexusIoResource resource, String destFileName, int permissions)

addResources

public void addResources(PlexusIoResourceCollection collection)
Adds a resource collection to the archive.

asArchiveEntry

protected ArchiveEntry asArchiveEntry(PlexusIoResource resource, String destFileName, int permissions)

asArchiveEntry

protected ArchiveEntry asArchiveEntry(PlexusIoResourceCollection collection, PlexusIoResource resource)

asResourceCollection

protected PlexusIoResourceCollection asResourceCollection(ArchivedFileSet fileSet)

checkForced

protected boolean checkForced()

cleanUp

protected void cleanUp()

close

protected abstract void close()

contextualize

public void contextualize(Context context)
Allows us to pull the ArchiverManager instance out of the container without causing a chicken-and-egg instantiation/composition problem.

createArchive

public final void createArchive()

execute

protected abstract void execute()

getArchiveFinalizers

protected List getArchiveFinalizers()

getArchiveType

protected abstract String getArchiveType()

getDefaultDirectoryMode

public final int getDefaultDirectoryMode()

getDefaultFileMode

public final int getDefaultFileMode()

getDestFile

public File getDestFile()

getDirectoryMode

public final int getDirectoryMode()

getDirs

public Map getDirs()

getDuplicateBehavior

public String getDuplicateBehavior()

getFileMode

public final int getFileMode()

getFiles

public Map getFiles()

getIncludeEmptyDirs

public boolean getIncludeEmptyDirs()

getLogger

protected Logger getLogger()

getOverrideDirectoryMode

public final int getOverrideDirectoryMode()

getOverrideFileMode

public final int getOverrideFileMode()

getRawDefaultDirectoryMode

public final int getRawDefaultDirectoryMode()

Deprecated: Use getDefaultDirectoryMode.

getRawDefaultFileMode

public final int getRawDefaultFileMode()

Deprecated: Use getDefaultFileMode.

getResources

public ResourceIterator getResources()

hasVirtualFiles

protected boolean hasVirtualFiles()

isForced

public boolean isForced()

isSupportingForced

public boolean isSupportingForced()

isUptodate

protected boolean isUptodate()

revert

protected boolean revert(StringBuffer messageBuffer)

runArchiveFinalizers

protected void runArchiveFinalizers()

setArchiveFilters

public void setArchiveFilters(List filters)

setArchiveFinalizers

public void setArchiveFinalizers(List archiveFinalizers)

setDefaultDirectoryMode

public final void setDefaultDirectoryMode(int mode)

setDefaultFileMode

public final void setDefaultFileMode(int mode)

setDestFile

public void setDestFile(File destFile)

setDirectoryMode

public final void setDirectoryMode(int mode)

setDotFileDirectory

public void setDotFileDirectory(File dotFileDirectory)

setDuplicateBehavior

public void setDuplicateBehavior(String duplicate)

setFileMode

public final void setFileMode(int mode)

setForced

public void setForced(boolean forced)

setIncludeEmptyDirs

public void setIncludeEmptyDirs(boolean includeEmptyDirs)

validate

protected void validate()
Copyright © 2001-2009 Codehaus. All Rights Reserved.