org.codehaus.plexus.archiver.tar
Class TarArchiver

java.lang.Object
  org.codehaus.plexus.logging.AbstractLogEnabled
      org.codehaus.plexus.archiver.AbstractArchiver
          org.codehaus.plexus.archiver.tar.TarArchiver

All Implemented Interfaces:

Archiver, org.codehaus.plexus.personality.plexus.lifecycle.phase.Contextualizable, org.codehaus.plexus.logging.LogEnabled

public class TarArchiver

extends AbstractArchiver

Version:

$Revision: 3651 $ $Date: 2006-08-21 17:05:02 -0400 (Mon, 21 Aug 2006) $

Author:

Emmanuel Venisse

Nested Class Summary

static class	TarArchiver.TarCompressionMethod Valid Modes for Compression attribute to Tar Task
class	TarArchiver.TarOptions Valid Modes for Compression attribute to Tar Task

Field Summary

Fields inherited from class org.codehaus.plexus.archiver.AbstractArchiver

DEFAULT_DIR_MODE, DEFAULT_FILE_MODE

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

ROLE

Constructor Summary

TarArchiver()

Method Summary

void	createArchive()
TarArchiver.TarOptions	getOptions()
boolean	isSupportingForced() Returns, whether the archive supports uptodate checks.
void	setCompression(TarArchiver.TarCompressionMethod mode) Set compression method.
void	setDefaultDirectoryMode(int mode) Override AbstractArchiver.setDefaultDirectoryMode to update TarOptions.
void	setDefaultFileMode(int mode) Override AbstractArchiver.setDefaultFileMode to update TarOptions.
void	setLongfile(TarLongFileMode mode) Set how to handle long files, those with a path>100 chars.
void	setOptions(TarArchiver.TarOptions options) Set all tar options
protected void	tarFile(ArchiveEntry entry, TarOutputStream tOut, java.lang.String vPath) tar a file

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

addArchivedFileSet, addArchivedFileSet, addArchivedFileSet, addArchivedFileSet, addDirectory, addDirectory, addDirectory, addDirectory, addFile, addFile, checkForced, contextualize, getDefaultDirectoryMode, getDefaultFileMode, getDestFile, getDirs, getFiles, getIncludeEmptyDirs, getLogger, isForced, isUptodate, setDestFile, setForced, setIncludeEmptyDirs

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

enableLogging, setupLogger, setupLogger, setupLogger

Methods inherited from class java.lang.Object

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

Constructor Detail

TarArchiver

public TarArchiver()

Method Detail

getOptions

public TarArchiver.TarOptions getOptions()

setOptions

public void setOptions(TarArchiver.TarOptions options)

Set all tar options

Parameters:

options - options

setDefaultFileMode

public void setDefaultFileMode(int mode)

Override AbstractArchiver.setDefaultFileMode to update TarOptions.

Specified by:

setDefaultFileMode in interface Archiver

Overrides:

setDefaultFileMode in class AbstractArchiver

setDefaultDirectoryMode

public void setDefaultDirectoryMode(int mode)

Override AbstractArchiver.setDefaultDirectoryMode to update TarOptions.

Specified by:

setDefaultDirectoryMode in interface Archiver

Overrides:

setDefaultDirectoryMode in class AbstractArchiver

setLongfile

public void setLongfile(TarLongFileMode mode)

Set how to handle long files, those with a path>100 chars. Optional, default=warn.

Allowable values are

• truncate - paths are truncated to the maximum length
• fail - paths greater than the maximum cause a build exception
• warn - paths greater than the maximum cause a warning and GNU is used
• gnu - GNU extensions are used for any paths greater than the maximum.
• omit - paths greater than the maximum are omitted from the archive

Parameters:

mode - the mode to handle long file names.

setCompression

public void setCompression(TarArchiver.TarCompressionMethod mode)

Set compression method. Allowable values are

• none - no compression
• gzip - Gzip compression
• bzip2 - Bzip2 compression

Parameters:

mode - the compression method.

createArchive

public void createArchive()
                   throws ArchiverException,
                          java.io.IOException

Throws:

ArchiverException

java.io.IOException

tarFile

protected void tarFile(ArchiveEntry entry,
                       TarOutputStream tOut,
                       java.lang.String vPath)
                throws ArchiverException,
                       java.io.IOException

tar a file

Parameters:

entry - the file to tar

tOut - the output stream

vPath - the path name of the file to tar

Throws:

java.io.IOException - on error

ArchiverException

isSupportingForced

public boolean isSupportingForced()

Description copied from interface: Archiver

Returns, whether the archive supports uptodate checks. If so, you may set Archiver.setForced(boolean) to true.

Specified by:

isSupportingForced in interface Archiver

Overrides:

isSupportingForced in class AbstractArchiver