org.codehaus.plexus.archiver.diags

Class DryRunArchiver

java.lang.Object

org.codehaus.plexus.archiver.diags.DelgatingArchiver

org.codehaus.plexus.archiver.diags.DryRunArchiver

All Implemented Interfaces:

Archiver

public class DryRunArchiver
extends DelgatingArchiver

A dry run archiver that does nothing. Some methods fall through to the underlying archiver, but no actions are executed.

Field Summary

Fields

Modifier and Type	Field and Description
private org.codehaus.plexus.logging.Logger	logger

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

DEFAULT_DIR_MODE, DEFAULT_FILE_MODE, DEFAULT_SYMLILNK_MODE, DUPLICATES_ADD, DUPLICATES_FAIL, DUPLICATES_PRESERVE, DUPLICATES_SKIP, DUPLICATES_VALID_BEHAVIORS, ROLE

Constructor Summary

Constructors

Constructor and Description
DryRunArchiver(Archiver target, org.codehaus.plexus.logging.Logger logger)

Method Summary

Modifier and Type	Method and Description
void	addArchivedFileSet(ArchivedFileSet fileSet) Adds the given archive file set to the archive.
void	addArchivedFileSet(ArchivedFileSet fileSet, java.nio.charset.Charset charset) Adds the given archive file set to the archive.
void	addArchivedFileSet(java.io.File archiveFile) Obsolete, use Archiver.addArchivedFileSet(ArchivedFileSet).
void	addArchivedFileSet(java.io.File archiveFile, java.lang.String prefix) Obsolete, use Archiver.addArchivedFileSet(ArchivedFileSet).
void	addArchivedFileSet(java.io.File archiveFile, java.lang.String[] includes, java.lang.String[] excludes) Obsolete, use Archiver.addArchivedFileSet(ArchivedFileSet).
void	addArchivedFileSet(java.io.File archiveFile, java.lang.String prefix, java.lang.String[] includes, java.lang.String[] excludes) Obsolete, use Archiver.addArchivedFileSet(ArchivedFileSet).
void	addDirectory(java.io.File directory) Obsolete, use Archiver.addFileSet(FileSet).
void	addDirectory(java.io.File directory, java.lang.String prefix) Obsolete, use Archiver.addFileSet(FileSet).
void	addDirectory(java.io.File directory, java.lang.String[] includes, java.lang.String[] excludes) Obsolete, use Archiver.addFileSet(FileSet).You can use "inline" of this method in your IDE to get the proper implementation for this release.
void	addDirectory(java.io.File directory, java.lang.String prefix, java.lang.String[] includes, java.lang.String[] excludes) Obsolete, use Archiver.addFileSet(FileSet).
void	addFile(java.io.File inputFile, java.lang.String destFileName)
void	addFile(java.io.File inputFile, java.lang.String destFileName, int permissions)
void	addFileSet(FileSet fileSet) Adds the given file set to the archive.
void	addResource(org.codehaus.plexus.components.io.resources.PlexusIoResource resource, java.lang.String destFileName, int permissions) Adds the given resource collection to the archive.
void	addResources(org.codehaus.plexus.components.io.resources.PlexusIoResourceCollection resources) Adds the given resource collection to the archive.
void	addSymlink(java.lang.String symlinkName, int permissions, java.lang.String symlinkDestination)
void	addSymlink(java.lang.String symlinkName, java.lang.String symlinkDestination)
void	createArchive()
private void	debug(java.lang.String message)
private java.lang.String	getMethodName()
void	setDotFileDirectory(java.io.File dotFileDirectory)

Methods inherited from class org.codehaus.plexus.archiver.diags.DelgatingArchiver

getDefaultDirectoryMode, getDefaultFileMode, getDestFile, getDirectoryMode, getDuplicateBehavior, getFileMode, getFiles, getIncludeEmptyDirs, getOverrideDirectoryMode, getOverrideFileMode, getResources, isForced, isIgnorePermissions, isSupportingForced, isUseJvmChmod, setDefaultDirectoryMode, setDefaultFileMode, setDestFile, setDirectoryMode, setDuplicateBehavior, setFileMode, setForced, setIgnorePermissions, setIncludeEmptyDirs, setUseJvmChmod

Methods inherited from class java.lang.Object

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

Field Detail

logger

private final org.codehaus.plexus.logging.Logger logger

Constructor Detail

DryRunArchiver

public DryRunArchiver(Archiver target,
                      org.codehaus.plexus.logging.Logger logger)

Method Detail

addArchivedFileSet

public void addArchivedFileSet(@Nonnull
                               java.io.File archiveFile,
                               java.lang.String prefix,
                               java.lang.String[] includes,
                               java.lang.String[] excludes)

Obsolete, use Archiver.addArchivedFileSet(ArchivedFileSet). You can use "inline" of this method in your IDE to get the proper implementation for this release.

Specified by:

addArchivedFileSet in interface Archiver

Overrides:

addArchivedFileSet in class DelgatingArchiver

debug

private void debug(java.lang.String message)

addArchivedFileSet

public void addArchivedFileSet(@Nonnull
                               java.io.File archiveFile,
                               java.lang.String prefix)
                        throws ArchiverException

Obsolete, use Archiver.addArchivedFileSet(ArchivedFileSet). You can use "inline" of this method in your IDE to get the proper implementation for this release.

Specified by:

addArchivedFileSet in interface Archiver

Overrides:

addArchivedFileSet in class DelgatingArchiver

Throws:

ArchiverException

addArchivedFileSet

public void addArchivedFileSet(java.io.File archiveFile,
                               java.lang.String[] includes,
                               java.lang.String[] excludes)
                        throws ArchiverException

Obsolete, use Archiver.addArchivedFileSet(ArchivedFileSet). You can use "inline" of this method in your IDE to get the proper implementation for this release.

Specified by:

addArchivedFileSet in interface Archiver

Overrides:

addArchivedFileSet in class DelgatingArchiver

Throws:

ArchiverException

addArchivedFileSet

public void addArchivedFileSet(@Nonnull
                               java.io.File archiveFile)
                        throws ArchiverException

Obsolete, use Archiver.addArchivedFileSet(ArchivedFileSet). You can use "inline" of this method in your IDE to get the proper implementation for this release.

Specified by:

addArchivedFileSet in interface Archiver

Overrides:

addArchivedFileSet in class DelgatingArchiver

Throws:

ArchiverException

addDirectory

public void addDirectory(@Nonnull
                         java.io.File directory,
                         java.lang.String prefix,
                         java.lang.String[] includes,
                         java.lang.String[] excludes)
                  throws ArchiverException

Obsolete, use Archiver.addFileSet(FileSet). You can use "inline" of this method in your IDE to get the proper implementation for this release.

Specified by:

addDirectory in interface Archiver

Overrides:

addDirectory in class DelgatingArchiver

Throws:

ArchiverException

addSymlink

public void addSymlink(java.lang.String symlinkName,
                       java.lang.String symlinkDestination)
                throws ArchiverException

Specified by:

addSymlink in interface Archiver

Overrides:

addSymlink in class DelgatingArchiver

Throws:

ArchiverException

addSymlink

public void addSymlink(java.lang.String symlinkName,
                       int permissions,
                       java.lang.String symlinkDestination)
                throws ArchiverException

Specified by:

addSymlink in interface Archiver

Overrides:

addSymlink in class DelgatingArchiver

Throws:

ArchiverException

addDirectory

public void addDirectory(@Nonnull
                         java.io.File directory,
                         java.lang.String prefix)
                  throws ArchiverException

Obsolete, use Archiver.addFileSet(FileSet). You can use "inline" of this method in your IDE to get the proper implementation for this release.

Specified by:

addDirectory in interface Archiver

Overrides:

addDirectory in class DelgatingArchiver

Throws:

ArchiverException

addDirectory

public void addDirectory(@Nonnull
                         java.io.File directory,
                         java.lang.String[] includes,
                         java.lang.String[] excludes)
                  throws ArchiverException

Obsolete, use Archiver.addFileSet(FileSet).You can use "inline" of this method in your IDE to get the proper implementation for this release.

Specified by:

addDirectory in interface Archiver

Overrides:

addDirectory in class DelgatingArchiver

Throws:

ArchiverException

addDirectory

public void addDirectory(@Nonnull
                         java.io.File directory)
                  throws ArchiverException

Obsolete, use Archiver.addFileSet(FileSet). You can use "inline" of this method in your IDE to get the proper implementation for this release.

Specified by:

addDirectory in interface Archiver

Overrides:

addDirectory in class DelgatingArchiver

Throws:

ArchiverException

addFile

public void addFile(@Nonnull
                    java.io.File inputFile,
                    @Nonnull
                    java.lang.String destFileName,
                    int permissions)
             throws ArchiverException

Specified by:

addFile in interface Archiver

Overrides:

addFile in class DelgatingArchiver

Throws:

ArchiverException

addFile

public void addFile(@Nonnull
                    java.io.File inputFile,
                    @Nonnull
                    java.lang.String destFileName)
             throws ArchiverException

Specified by:

addFile in interface Archiver

Overrides:

addFile in class DelgatingArchiver

Throws:

ArchiverException

createArchive

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

Specified by:

createArchive in interface Archiver

Overrides:

createArchive in class DelgatingArchiver

Throws:

ArchiverException

java.io.IOException

setDotFileDirectory

public void setDotFileDirectory(java.io.File dotFileDirectory)

Specified by:

setDotFileDirectory in interface Archiver

Overrides:

setDotFileDirectory in class DelgatingArchiver

addArchivedFileSet

public void addArchivedFileSet(ArchivedFileSet fileSet)
                        throws ArchiverException

Adds the given archive file set to the archive. This method is basically obsoleting Archiver.addArchivedFileSet(File), Archiver.addArchivedFileSet(File, String[], String[]), and Archiver.addArchivedFileSet(File, String, String[], String[]). However, as these methods are in widespread use, they cannot easily be made deprecated. Stream transformers are supported on this method

Specified by:

addArchivedFileSet in interface Archiver

Overrides:

addArchivedFileSet in class DelgatingArchiver

Throws:

ArchiverException

addArchivedFileSet

public void addArchivedFileSet(ArchivedFileSet fileSet,
                               java.nio.charset.Charset charset)
                        throws ArchiverException

Description copied from interface: Archiver

Adds the given archive file set to the archive. This method is basically obsoleting Archiver.addArchivedFileSet(File), Archiver.addArchivedFileSet(File, String[], String[]), and Archiver.addArchivedFileSet(File, String, String[], String[]). However, as these methods are in widespread use, they cannot easily be made deprecated.

Specified by:

addArchivedFileSet in interface Archiver

Overrides:

addArchivedFileSet in class DelgatingArchiver

Parameters:

fileSet - the fileSet to add

charset - the encoding to use, particularly useful to specific non-standard filename encodings for some kinds of archives (for instance zip files) Stream transformers are supported on this method

Throws:

ArchiverException

addFileSet

public void addFileSet(@Nonnull
                       FileSet fileSet)
                throws ArchiverException

Adds the given file set to the archive. This method is basically obsoleting Archiver.addDirectory(File), Archiver.addDirectory(File, String), Archiver.addDirectory(File, String[], String[]), and Archiver.addDirectory(File, String, String[], String[]). However, as these methods are in widespread use, they cannot easily be made deprecated.

Specified by:

addFileSet in interface Archiver

Overrides:

addFileSet in class DelgatingArchiver

Throws:

ArchiverException - Adding the file set failed.

addResource

public void addResource(org.codehaus.plexus.components.io.resources.PlexusIoResource resource,
                        java.lang.String destFileName,
                        int permissions)
                 throws ArchiverException

Description copied from interface: Archiver

Adds the given resource collection to the archive. Stream transformers are *not* supported on this method

Specified by:

addResource in interface Archiver

Overrides:

addResource in class DelgatingArchiver

Throws:

ArchiverException

addResources

public void addResources(org.codehaus.plexus.components.io.resources.PlexusIoResourceCollection resources)
                  throws ArchiverException

Description copied from interface: Archiver

Adds the given resource collection to the archive. Stream transformers are supported om this method

Specified by:

addResources in interface Archiver

Overrides:

addResources in class DelgatingArchiver

Throws:

ArchiverException

getMethodName

private java.lang.String getMethodName()