Package io.freefair.gradle.plugins.compress.tree

Class AbstractArchiveFileTreeElement

java.lang.Object

org.gradle.api.internal.file.AbstractFileTreeElement

io.freefair.gradle.plugins.compress.tree.AbstractArchiveFileTreeElement

All Implemented Interfaces:

FileTreeElement, FileVisitDetails

Direct Known Subclasses:

ArFileTree.ArArchiveEntryFileTreeElement, ArjFileTree.ArjArchiveEntryFileTreeElement, DumpFileTree.DumpArchiveEntryFileTreeElement, SevenZipFileTree.SevenZArchiveEntryFileTreeElement

public abstract class AbstractArchiveFileTreeElement
extends org.gradle.api.internal.file.AbstractFileTreeElement
implements FileVisitDetails

An implementation of FileTreeElement meant for use with archive files when subclassing AbstractFileTree.

This implementation extracts the files from the archive to the supplied expansion directory.

See Also:

AbstractArchiveFileTreeElement

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractArchiveFileTreeElement(org.gradle.internal.file.Chmod chmod, java.io.File expandedDir, java.util.concurrent.atomic.AtomicBoolean stopFlag)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
protected abstract org.apache.commons.compress.archivers.ArchiveEntry	getArchiveEntry()	Returns the archive entry for this element.
protected abstract java.lang.String	getEntryName()	Returns unsafe name for the name of a file contained in the archive.
java.io.File	getFile()
long	getLastModified()
RelativePath	getRelativePath()
long	getSize()
boolean	isDirectory()
protected java.lang.String	safeEntryName()	Returns a safe name for the name of a file contained in the archive.
void	stopVisiting()

Methods inherited from class org.gradle.api.internal.file.AbstractFileTreeElement

copyTo, copyTo, getChmod, getDisplayName, getMode, getName, getPath, getPermissions, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.gradle.api.file.FileTreeElement

copyTo, copyTo, getMode, getName, getPath, getPermissions, open

Constructor Detail

AbstractArchiveFileTreeElement

protected AbstractArchiveFileTreeElement(org.gradle.internal.file.Chmod chmod,
                                         java.io.File expandedDir,
                                         java.util.concurrent.atomic.AtomicBoolean stopFlag)

Creates a new instance.

Parameters:

chmod - the chmod instance to use

expandedDir - the directory to extract the archived file to

stopFlag - the stop flag to use

Method Detail

getArchiveEntry

protected abstract org.apache.commons.compress.archivers.ArchiveEntry getArchiveEntry()

Returns the archive entry for this element.

Returns:

the archive entry

safeEntryName

protected java.lang.String safeEntryName()

Returns a safe name for the name of a file contained in the archive.

See Also:

PathTraversalChecker.safePathName(String)

getEntryName

protected abstract java.lang.String getEntryName()

Returns unsafe name for the name of a file contained in the archive.

See Also:

AbstractArchiveFileTreeElement.safeEntryName()

getFile

public java.io.File getFile()

Specified by:

getFile in interface FileTreeElement

getRelativePath

public RelativePath getRelativePath()

Specified by:

getRelativePath in interface FileTreeElement

getLastModified

public long getLastModified()

Specified by:

getLastModified in interface FileTreeElement

isDirectory

public boolean isDirectory()

Specified by:

isDirectory in interface FileTreeElement

getSize

public long getSize()

Specified by:

getSize in interface FileTreeElement

stopVisiting

public void stopVisiting()

Specified by:

stopVisiting in interface FileVisitDetails