forked from soot-oss/soot
-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathIFoundFile.java
More file actions
97 lines (85 loc) · 2.51 KB
/
IFoundFile.java
File metadata and controls
97 lines (85 loc) · 2.51 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
package soot;
/*-
* #%L
* Soot - a J*va Optimization Framework
* %%
* Copyright (C) 1997 - 2018 Raja Vallée-Rai and others
* %%
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation, either version 2.1 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Lesser Public License for more details.
*
* You should have received a copy of the GNU General Lesser Public
* License along with this program. If not, see
* <http://www.gnu.org/licenses/lgpl-2.1.html>.
* #L%
*/
import java.io.File;
import java.io.InputStream;
import java.util.zip.ZipFile;
import org.slf4j.LoggerFactory;
/**
* This abstraction allows to use different a implementation of file access. It contains essentially the same methods as
* {@link FoundFile}.
*
* @author Marc Miltenberger
*/
public interface IFoundFile {
@Deprecated
/**
* 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.
*
* @return the file on disk
*/
public String getFilePath();
/**
* Returns true if and only if this file is contained within a zip file.
*/
public boolean isZipFile();
/**
* Returns the zip file or null.
*
* @return the zip file
*/
public ZipFile getZipFile();
/**
* 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.
*
* @return the file on disk
*/
public File getFile();
/**
* Returns the absolute path to the file or the zip file.
*
* @return the absolute path to the file or the zip file.
*/
public String getAbsolutePath();
/**
* Opens the file and returns a new input stream containing the file contents.
*
* @return a fresh stream
*/
public InputStream inputStream();
/**
* Closes all opened input streams.
*/
public void close();
/**
* Closes the instance without throwing an exception.
*/
public default void silentClose() {
try {
close();
} catch (Exception e) {
LoggerFactory.getLogger(getClass()).debug(e.getMessage(), e);
}
}
}