org.sonar.api.resources

Interface InputFile

All Known Implementing Classes:

DefaultInputFile

Deprecated.

in 4.2. Replaced by InputFile

@Deprecated
public interface InputFile

Since:

2.6

Method Summary

Modifier and Type	Method and Description
File	getFile() Deprecated. Get the underlying file.
File	getFileBaseDir() Deprecated. The source base directory, different than the project basedir.
InputStream	getInputStream() Deprecated. Get an InputStream that reads from the file.
String	getRelativePath() Deprecated. Path relative to basedir.

Method Detail

getFileBaseDir

File getFileBaseDir()

Deprecated.

The source base directory, different than the project basedir.

For example in maven projects, the basedir of a source file stored in src/main/java/org/foo/ is the directory src/main/java.

getFile

File getFile()

Deprecated.

Get the underlying file.

Returns:

the file

getRelativePath

String getRelativePath()

Deprecated.

Path relative to basedir. Directory separator is slash '/', whatever the platform.

Example on windows: if file basedir is c:\project\src\ and file is c:\project\src\org\foo\Bar.java, then relative path is org/foo/Bar.java

Example on unix: if file basedir is /project/src and file is /project/src/org/foo/Bar.java, then relative path is org/foo/Bar.java as well.

getInputStream

InputStream getInputStream()
                    throws FileNotFoundException

Deprecated.

Get an InputStream that reads from the file.

The returned stream is buffered so there is no need to use a BufferedInputStream

Returns:

the stream

Throws:

FileNotFoundException - if the file is not found

Since:

3.1