Package soot

Class FoundFile

java.lang.Object

soot.FoundFile

All Implemented Interfaces:

IFoundFile

public class FoundFile
extends Object
implements IFoundFile

Field Summary

Fields

Modifier and Type	Field	Description
protected String	entryName
protected File	file
protected List<InputStream>	openedInputStreams
protected Path	path
protected ZipEntry	zipEntry
protected SharedCloseable<ZipFile>	zipFile

Constructor Summary

Constructors

Constructor	Description
FoundFile(File file)
FoundFile(String archivePath, String entryName)
FoundFile(Path path)

Method Summary

Modifier and Type	Method	Description
void	close()	Closes all opened input streams.
protected void	closeZipFile(List<Exception> errs)
String	getAbsolutePath()	Returns the absolute path to the file or the zip file.
File	getFile()	Returns the concrete file on disk if it is not within a zip file.
String	getFilePath()
ZipFile	getZipFile()	Returns the zip file or null.
InputStream	inputStream()	Opens the file and returns a new input stream containing the file contents.
boolean	isZipFile()	Returns true if and only if this file is contained within a zip file.

Methods inherited from class java.lang.Object

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

Methods inherited from interface soot.IFoundFile

silentClose

Field Detail

openedInputStreams

protected final List<InputStream> openedInputStreams

path

protected Path path

file

protected File file

entryName

protected String entryName

zipFile

protected SharedCloseable<ZipFile> zipFile

zipEntry

protected ZipEntry zipEntry

Constructor Detail

FoundFile

public FoundFile(String archivePath,
                 String entryName)

FoundFile

public FoundFile(File file)

FoundFile

public FoundFile(Path path)

Method Detail

getFilePath

public String getFilePath()

Specified by:

getFilePath in interface IFoundFile

isZipFile

public boolean isZipFile()

Description copied from interface: IFoundFile

Returns true if and only if this file is contained within a zip file.

Specified by:

isZipFile in interface IFoundFile

getZipFile

public ZipFile getZipFile()

Description copied from interface: IFoundFile

Returns the zip file or null.

Specified by:

getZipFile in interface IFoundFile

Returns:

the zip file

getFile

public File getFile()

Description copied from interface: IFoundFile

Returns the concrete file on disk if it is not within a zip file. Otherwise, the returned file is the zip file itself. Note that it may return null in some circumstances.

Specified by:

getFile in interface IFoundFile

Returns:

the file on disk

getAbsolutePath

public String getAbsolutePath()

Description copied from interface: IFoundFile

Returns the absolute path to the file or the zip file.

Specified by:

getAbsolutePath in interface IFoundFile

Returns:

the absolute path to the file or the zip file.

inputStream

public InputStream inputStream()

Description copied from interface: IFoundFile

Opens the file and returns a new input stream containing the file contents.

Specified by:

inputStream in interface IFoundFile

Returns:

a fresh stream

close

public void close()

Description copied from interface: IFoundFile

Closes all opened input streams.

Specified by:

close in interface IFoundFile

closeZipFile

protected void closeZipFile(List<Exception> errs)