org.codehaus.plexus.archiver
Interface UnArchiver

All Known Implementing Classes:

AbstractUnArchiver

public interface UnArchiver

Version:

$Revision: 6257 $ $Date: 2007-04-01 16:58:14 -0400 (Sun, 01 Apr 2007) $

Field Summary

static java.lang.String

ROLE

Method Summary

void	extract() Extract the archive.
void	extract(java.lang.String path, java.io.File outputDirectory) Take a patch into the archive and extract it to the specified directory.
java.io.File	getDestDirectory()
java.io.File	getDestFile()
org.codehaus.plexus.components.io.fileselectors.FileSelector[]	getFileSelectors() Returns a set of FileSelector instances, which may be used to select the files to extract from the archive.
java.io.File	getSourceFile()
void	setDestDirectory(java.io.File destDirectory)
void	setDestFile(java.io.File destFile)
void	setFileSelectors(org.codehaus.plexus.components.io.fileselectors.FileSelector[] selectors) Sets a set of FileSelector instances, which may be used to select the files to extract from the archive.
void	setOverwrite(boolean b) Should we overwrite files in dest, even if they are newer than the corresponding entries in the archive?
void	setSourceFile(java.io.File sourceFile)

Field Detail

ROLE

public static final java.lang.String ROLE

Method Detail

extract

public void extract()
             throws ArchiverException

Extract the archive.

Throws:

ArchiverException

extract

public void extract(java.lang.String path,
                    java.io.File outputDirectory)
             throws ArchiverException

Take a patch into the archive and extract it to the specified directory.

Parameters:

path - Path inside the archive to be extracted.

outputDirectory - Directory to extract to.

Throws:

ArchiverException

getDestDirectory

public java.io.File getDestDirectory()

setDestDirectory

public void setDestDirectory(java.io.File destDirectory)

getDestFile

public java.io.File getDestFile()

setDestFile

public void setDestFile(java.io.File destFile)

getSourceFile

public java.io.File getSourceFile()

setSourceFile

public void setSourceFile(java.io.File sourceFile)

setOverwrite

public void setOverwrite(boolean b)

Should we overwrite files in dest, even if they are newer than the corresponding entries in the archive?

setFileSelectors

public void setFileSelectors(org.codehaus.plexus.components.io.fileselectors.FileSelector[] selectors)

Sets a set of FileSelector instances, which may be used to select the files to extract from the archive. If file selectors are present, then a file is only extracted, if it is confirmed by all file selectors.

getFileSelectors

public org.codehaus.plexus.components.io.fileselectors.FileSelector[] getFileSelectors()

Returns a set of FileSelector instances, which may be used to select the files to extract from the archive. If file selectors are present, then a file is only extracted, if it is confirmed by all file selectors.