org.codehaus.plexus.archiver

Class AbstractArchiveContentLister

java.lang.Object

org.codehaus.plexus.logging.AbstractLogEnabled

org.codehaus.plexus.archiver.AbstractArchiveContentLister

All Implemented Interfaces:

ArchiveContentLister, org.codehaus.plexus.logging.LogEnabled

Direct Known Subclasses:

AbstractZipArchiveContentLister, BZip2ArchiveContentLister, GZipArchiveContentLister, SnappyArchiveContentLister, TarArchiveContentLister

public abstract class AbstractArchiveContentLister
extends org.codehaus.plexus.logging.AbstractLogEnabled
implements ArchiveContentLister

Version:

$Revision$ $Date$

Author:

Franck Bonin

Field Summary

Fields inherited from interface org.codehaus.plexus.archiver.ArchiveContentLister

ROLE

Constructor Summary

Constructors

Constructor and Description
AbstractArchiveContentLister()
AbstractArchiveContentLister(File sourceFile)

Method Summary

Modifier and Type	Method and Description
protected abstract List<ArchiveContentEntry>	execute()
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.
File	getSourceFile()
protected boolean	isSelected(String fileName, org.codehaus.plexus.components.io.fileselectors.FileInfo fileInfo)
List<ArchiveContentEntry>	list() list the archive content.
void	setFileSelectors(org.codehaus.plexus.components.io.fileselectors.FileSelector[] fileSelectors) Sets a set of FileSelector instances, which may be used to select the files to extract from the archive.
void	setSourceFile(File sourceFile)
protected void	validate()

Methods inherited from class org.codehaus.plexus.logging.AbstractLogEnabled

enableLogging, getLogger, setupLogger, setupLogger, setupLogger

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractArchiveContentLister

public AbstractArchiveContentLister()

AbstractArchiveContentLister

public AbstractArchiveContentLister(File sourceFile)

Method Detail

getSourceFile

public File getSourceFile()

Specified by:

getSourceFile in interface ArchiveContentLister

setSourceFile

public void setSourceFile(File sourceFile)

Specified by:

setSourceFile in interface ArchiveContentLister

list

public final List<ArchiveContentEntry> list()
                                     throws org.codehaus.plexus.archiver.ArchiverException

Description copied from interface: ArchiveContentLister

list the archive content.

Specified by:

list in interface ArchiveContentLister

Throws:

ArchiverException

validate

protected void validate()
                 throws org.codehaus.plexus.archiver.ArchiverException

Throws:

org.codehaus.plexus.archiver.ArchiverException

setFileSelectors

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

Description copied from interface: ArchiveContentLister

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.

Specified by:

setFileSelectors in interface ArchiveContentLister

getFileSelectors

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

Description copied from interface: ArchiveContentLister

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.

Specified by:

getFileSelectors in interface ArchiveContentLister

isSelected

protected boolean isSelected(String fileName,
                             org.codehaus.plexus.components.io.fileselectors.FileInfo fileInfo)
                      throws org.codehaus.plexus.archiver.ArchiverException

Throws:

org.codehaus.plexus.archiver.ArchiverException

execute

protected abstract List<ArchiveContentEntry> execute()
                                              throws org.codehaus.plexus.archiver.ArchiverException

Throws:

org.codehaus.plexus.archiver.ArchiverException