Package org.codehaus.plexus.archiver.tar

Class TarUnArchiver

java.lang.Object

org.codehaus.plexus.logging.AbstractLogEnabled

org.codehaus.plexus.archiver.AbstractUnArchiver

org.codehaus.plexus.archiver.tar.TarUnArchiver

All Implemented Interfaces:

FinalizerEnabled, UnArchiver, org.codehaus.plexus.logging.LogEnabled

Direct Known Subclasses:

TarBZip2UnArchiver, TarGZipUnArchiver, TarSnappyUnArchiver, TarXZUnArchiver

public class TarUnArchiver
extends AbstractUnArchiver

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TarUnArchiver.UntarCompressionMethod	Valid Modes for Compression attribute to Untar Task

Field Summary

Fields

Modifier and Type	Field	Description
private TarUnArchiver.UntarCompressionMethod	compression	compression method

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

ROLE

Constructor Summary

Constructors

Constructor	Description
TarUnArchiver()
TarUnArchiver(java.io.File sourceFile)

Method Summary

Modifier and Type	Method	Description
private java.io.InputStream	decompress(TarUnArchiver.UntarCompressionMethod compression, java.io.File file, java.io.InputStream istream)	This method wraps the input stream with the corresponding decompression method
protected void	execute()
protected void	execute(java.io.File sourceFile, java.io.File destDirectory, org.codehaus.plexus.components.io.filemappers.FileMapper[] fileMappers)
protected void	execute(java.lang.String path, java.io.File outputDirectory)
void	setCompression(TarUnArchiver.UntarCompressionMethod method)	Set decompression algorithm to use; default=none.
void	setEncoding(java.lang.String encoding)	No encoding support in Untar.

Methods inherited from class org.codehaus.plexus.archiver.AbstractUnArchiver

addArchiveFinalizer, extract, extract, extractFile, getDestDirectory, getDestFile, getFileMappers, getFileSelectors, getSourceFile, isIgnorePermissions, isOverwrite, isSelected, isUseJvmChmod, setArchiveFinalizers, setDestDirectory, setDestFile, setFileMappers, setFileSelectors, setIgnorePermissions, setOverwrite, setSourceFile, setUseJvmChmod, validate, 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

Field Detail

compression

private TarUnArchiver.UntarCompressionMethod compression

compression method

Constructor Detail

TarUnArchiver

public TarUnArchiver()

TarUnArchiver

public TarUnArchiver(java.io.File sourceFile)

Method Detail

setCompression

public void setCompression(TarUnArchiver.UntarCompressionMethod method)

Set decompression algorithm to use; default=none.

Allowable values are

• none - no compression
• gzip - Gzip compression
• bzip2 - Bzip2 compression
• snappy - Snappy compression
• xz - Xz compression

Parameters:

method - compression method

setEncoding

public void setEncoding(java.lang.String encoding)

No encoding support in Untar.

execute

protected void execute()
                throws ArchiverException

Specified by:

execute in class AbstractUnArchiver

Throws:

ArchiverException

execute

protected void execute(java.lang.String path,
                       java.io.File outputDirectory)

Specified by:

execute in class AbstractUnArchiver

execute

protected void execute(java.io.File sourceFile,
                       java.io.File destDirectory,
                       org.codehaus.plexus.components.io.filemappers.FileMapper[] fileMappers)
                throws ArchiverException

Throws:

ArchiverException

decompress

private java.io.InputStream decompress(TarUnArchiver.UntarCompressionMethod compression,
                                       java.io.File file,
                                       java.io.InputStream istream)
                                throws java.io.IOException,
                                       ArchiverException

This method wraps the input stream with the corresponding decompression method

Parameters:

file - provides location information for BuildException

istream - input stream

Returns:

input stream with on-the-fly decompression

Throws:

java.io.IOException - thrown by GZIPInputStream constructor

ArchiverException