soot

Interface IFoundFile

All Known Implementing Classes:

ClassLoaderFoundFile, FoundFile

public interface IFoundFile

This abstraction allows to use different a implementation of file access. It contains essentially the same methods as FoundFile.

Author:

Marc Miltenberger

Method Summary

Modifier and Type	Method and Description
void	close() Closes all opened input streams.
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() Deprecated.
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.
default void	silentClose() Closes the instance without throwing an exception.

Method Detail

getFilePath

@Deprecated
String getFilePath()

Deprecated.

isZipFile

boolean isZipFile()

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

getZipFile

ZipFile getZipFile()

Returns the zip file or null.

Returns:

the zip file

getFile

File getFile()

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.

Returns:

the file on disk

getAbsolutePath

String getAbsolutePath()

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

Returns:

the absolute path to the file or the zip file.

inputStream

InputStream inputStream()

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

Returns:

a fresh stream

close

void close()

Closes all opened input streams.

silentClose

default void silentClose()

Closes the instance without throwing an exception.