org.sonar.api.batch.fs

Interface IndexedFile

All Superinterfaces:

InputComponent, InputPath

All Known Subinterfaces:

InputFile

All Known Implementing Classes:

DefaultIndexedFile, DefaultInputFile

public interface IndexedFile
extends InputPath

Represents the indexed view of an InputFile. Accessing any of data exposed here won't trigger the expensive generation of metadata for the InputFile.

Since:

6.3

Method Summary

Modifier and Type	Method and Description
String	absolutePath() Normalized absolute path.
File	file() The underlying absolute File.
InputStream	inputStream() Creates a stream of the file's contents.
String	language() Language, for example "java" or "php".
Path	path() The underlying absolute Path.
String	relativePath() Path relative to module base directory.
InputFile.Type	type() Does it contain main or test code ?

Methods inherited from interface org.sonar.api.batch.fs.InputComponent

isFile, key

Method Detail

relativePath

String relativePath()

Path relative to module base directory. Path is unique and identifies file within given FileSystem. File separator is the forward slash ('/'), even on Microsoft Windows.
Returns src/main/java/com/Foo.java if module base dir is /path/to/module and if file is /path/to/module/src/main/java/com/Foo.java.
Relative path is not null and is normalized ('foo/../foo' is replaced by 'foo').

Specified by:

relativePath in interface InputPath

See Also:

InputFile.relativePath(), InputDir.relativePath()

absolutePath

String absolutePath()

Normalized absolute path. File separator is forward slash ('/'), even on Microsoft Windows.
This is not canonical path. Symbolic links are not resolved. For example if /project/src links to /tmp/src and basedir is /project, then this method returns /project/src/index.php. Use file().getCanonicalPath() to resolve symbolic link.

Specified by:

absolutePath in interface InputPath

See Also:

InputFile.absolutePath(), InputDir.absolutePath()

file

File file()

The underlying absolute File. It should not be used to read the file in the filesystem.

Specified by:

file in interface InputPath

See Also:

#contents(), inputStream()

path

Path path()

The underlying absolute Path. It should not be used to read the file in the filesystem.

Specified by:

path in interface InputPath

Since:

5.1

See Also:

#contents(), inputStream()

language

@CheckForNull
String language()

Language, for example "java" or "php". Can be null if indexation of all files is enabled and no language claims to support the file.

type

InputFile.Type type()

Does it contain main or test code ?

inputStream

InputStream inputStream()
                 throws IOException

Creates a stream of the file's contents. Depending on the runtime context, the source might be a file in a physical or virtual filesystem. Typically, it won't be buffered. The stream must be closed by the caller.

Throws:

IOException

Since:

6.2