org.at4j.util.archive

Class PrintingEntryExtractor

java.lang.Object

org.at4j.util.archive.PrintingEntryExtractor

All Implemented Interfaces:

EntryExtractionStrategy

public class PrintingEntryExtractor
extends Object
implements EntryExtractionStrategy

This entry extraction strategy just prints the location and types of the entries that it encounters to a PrintStream (System.out, for instance). It does not extract anything.

Since:

1.0

Author:

Karl Gustafsson

Constructor Summary

Constructors

Constructor and Description
PrintingEntryExtractor() Create a printing entry extractor that prints to System.out.
PrintingEntryExtractor(PrintStream out) Create a printing entry extractor that prints to the supplied stream.

Method Summary

Methods

Modifier and Type	Method and Description
org.entityfs.Directory	extractDirectory(ArchiveDirectoryEntry<?,?> dir, PotentialDirectory target, ExtractSpecification spec) Extract a directory entry to the target directory.
void	extractFile(ArchiveFileEntry<?,?> f, PotentialDirectory target, ExtractSpecification spec) Extract a file entry to the target directory.
void	extractSymbolicLink(ArchiveSymbolicLinkEntry<?,?> l, PotentialDirectory target, ExtractSpecification spec) Extract a symbolic link entry to the target directory.
void	postProcessDirectory(ArchiveDirectoryEntry<?,?> dir, org.entityfs.Directory target, ExtractSpecification spec) Post-process an extracted directory after all of its child entries have been extracted.

Methods inherited from class java.lang.Object

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

Constructor Detail

PrintingEntryExtractor

public PrintingEntryExtractor()

Create a printing entry extractor that prints to System.out.

PrintingEntryExtractor

public PrintingEntryExtractor(PrintStream out)

Create a printing entry extractor that prints to the supplied stream.

Parameters:

out - The stream to print to.

Method Detail

extractDirectory

public org.entityfs.Directory extractDirectory(ArchiveDirectoryEntry<?,?> dir,
                                      PotentialDirectory target,
                                      ExtractSpecification spec)

Description copied from interface: EntryExtractionStrategy

Extract a directory entry to the target directory.

Specified by:

extractDirectory in interface EntryExtractionStrategy

Parameters:

dir - The directory entry.

target - The target directory.

spec - The extraction specification.

Returns:

The new directory or a previously existing directory if there already was a directory at the target location. If this operation did not result in there being a directory at the target location (if the target was occupied by a file that the overwrite strategy did not allow us to overwrite, for instance), this method returns null.

See Also:

EntryExtractionStrategy.postProcessDirectory(ArchiveDirectoryEntry, Directory, ExtractSpecification)

postProcessDirectory

public void postProcessDirectory(ArchiveDirectoryEntry<?,?> dir,
                        org.entityfs.Directory target,
                        ExtractSpecification spec)

Description copied from interface: EntryExtractionStrategy

Post-process an extracted directory after all of its child entries have been extracted. This can be used to set the directory's last modification time.

Specified by:

postProcessDirectory in interface EntryExtractionStrategy

Parameters:

dir - The directory entry.

target - The extracted directory.

spec - The extraction specification.

See Also:

EntryExtractionStrategy.extractDirectory(ArchiveDirectoryEntry, PotentialDirectory, ExtractSpecification)

extractFile

public void extractFile(ArchiveFileEntry<?,?> f,
               PotentialDirectory target,
               ExtractSpecification spec)

Description copied from interface: EntryExtractionStrategy

Extract a file entry to the target directory.

Specified by:

extractFile in interface EntryExtractionStrategy

Parameters:

f - The file entry.

target - The target directory.

spec - The extraction specification.

extractSymbolicLink

public void extractSymbolicLink(ArchiveSymbolicLinkEntry<?,?> l,
                       PotentialDirectory target,
                       ExtractSpecification spec)

Description copied from interface: EntryExtractionStrategy

Extract a symbolic link entry to the target directory.

Specified by:

extractSymbolicLink in interface EntryExtractionStrategy

Parameters:

l - The symbolic link entry.

target - The target directory.

spec - The extraction specification.