org.sonar.api.batch.fs

Interface InputFile

All Superinterfaces:

InputComponent, InputPath

All Known Implementing Classes:

DefaultInputFile

public interface InputFile
extends InputPath

This layer over File adds information for code analyzers. For unit testing purpose you can create some DefaultInputFile and initialize all fields using

   new DefaultInputFile("moduleKey", "relative/path/from/module/baseDir.java")
     .setModuleBaseDir(path)
     .initMetadata(new FileMetadata().readMetadata(someReader));
 

Since:

4.2

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	InputFile.Status Status regarding previous analysis
static class	InputFile.Type

Method Summary

Modifier and Type	Method and Description
String	absolutePath() Normalized absolute path.
Charset	charset() Charset to be used to decode this specific file.
File	file() The underlying absolute File
boolean	isEmpty() Check if the file content is empty (ignore potential BOM).
String	language() Language, for example "java" or "php".
int	lines() Number of physical lines.
TextPointer	newPointer(int line, int lineOffset) Returns a TextPointer in the given file.
TextRange	newRange(int startLine, int startLineOffset, int endLine, int endLineOffset) Returns a TextRange in the given file.
TextRange	newRange(TextPointer start, TextPointer end) Returns a TextRange in the given file.
Path	path() The underlying absolute Path
String	relativePath() Path relative to module base directory.
TextRange	selectLine(int line) Returns a TextRange in the given file that select the full line.
InputFile.Status	status() Status regarding previous analysis
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:

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:

absolutePath(), InputDir.absolutePath()

file

File file()

The underlying absolute File

Specified by:

file in interface InputPath

See Also:

file(), InputDir.file()

path

Path path()

The underlying absolute Path

Specified by:

path in interface InputPath

Since:

5.1

See Also:

path(), InputDir.path()

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 ?

status

InputFile.Status status()

Status regarding previous analysis

lines

int lines()

Number of physical lines. This method supports all end-of-line characters. Formula is (number of line break + 1).

Returns 1 if the file is empty.
Returns 2 for foo\nbar.
Returns 3 for foo\nbar\n.

isEmpty

boolean isEmpty()

Check if the file content is empty (ignore potential BOM).

Since:

5.2

newPointer

TextPointer newPointer(int line,
                       int lineOffset)

Returns a TextPointer in the given file.

Parameters:

line - Line of the pointer. Start at 1.

lineOffset - Offset in the line. Start at 0.

Throws:

IllegalArgumentException - if line or offset is not valid for the given file.

Since:

5.2

newRange

TextRange newRange(TextPointer start,
                   TextPointer end)

Returns a TextRange in the given file.

Parameters:

start - start pointer

end - end pointer

Throws:

IllegalArgumentException - if start or stop pointers are not valid for the given file.

Since:

5.2

newRange

TextRange newRange(int startLine,
                   int startLineOffset,
                   int endLine,
                   int endLineOffset)

Returns a TextRange in the given file.

• newRange(1, 0, 1, 1) selects the first character at line 1
• newRange(1, 0, 1, 10) selects the 10 first characters at line 1

Throws:

IllegalArgumentException - if start or stop positions are not valid for the given file.

Since:

5.2

selectLine

TextRange selectLine(int line)

Returns a TextRange in the given file that select the full line.

Parameters:

line - Start at 1.

Throws:

IllegalArgumentException - if line is not valid for the given file.

Since:

5.2

charset

Charset charset()

Charset to be used to decode this specific file.

Since:

6.0