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
|
/*
* SonarQube, open source software quality management tool.
* Copyright (C) 2008-2013 SonarSource
* mailto:contact AT sonarsource DOT com
*
* SonarQube 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 3 of the License, or (at your option) any later version.
*
* SonarQube 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
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program; if not, write to the Free Software Foundation,
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
package org.sonar.api.resources;
import java.io.File;
import java.io.FileNotFoundException;
import java.io.InputStream;
/**
* @since 2.6
* @deprecated in 4.2. Replaced by {@link org.sonar.api.batch.fs.InputFile}
*/
@Deprecated
public interface InputFile {
/**
* The source base directory, different than the project basedir.
*
* <p>For example in maven projects, the basedir of a source file stored in
* <code>src/main/java/org/foo/</code> is the directory <code>src/main/java</code>.</p>
*/
File getFileBaseDir();
/**
* Get the underlying file.
*
* @return the file
*/
File getFile();
/**
* Path relative to basedir. Directory separator is slash <code>'/'</code>, whatever the platform.
*
* <p>Example on windows: if file basedir is <code>c:\project\src\</code> and file is <code>c:\project\src\org\foo\Bar.java</code>, then relative path
* is <code>org/foo/Bar.java</code></p>
*
* <p>Example on unix: if file basedir is <code>/project/src</code> and file is <code>/project/src/org/foo/Bar.java</code>, then relative path
* is <code>org/foo/Bar.java</code> as well.</p>
*/
String getRelativePath();
/**
* Get an {@link InputStream} that reads from the file.
*
* <p>The returned stream is buffered so there is no need to use a
* <code>BufferedInputStream</code></p>
*
* @return the stream
* @throws FileNotFoundException if the file is not found
* @since 3.1
*/
InputStream getInputStream() throws FileNotFoundException;
}
|
