org.sonar.api.batch.fs

Interface InputFile

All Superinterfaces:

IndexedFile, InputComponent, InputPath

All Known Implementing Classes:

DefaultInputFile

public interface InputFile
extends IndexedFile

This layer over File adds information for code analyzers. For unit testing purpose, use TestInputFileBuilder and initialize the needed fields:

   new TestInputFileBuilder("moduleKey", "relative/path/from/module/baseDir.java")
     .setModuleBaseDir(path)
     .build();
 

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() Deprecated. since 6.6 use inputStream() for file content, IndexedFile.filename() for file name, IndexedFile.uri() for an unique identifier, and toString() for logging
Charset	charset() Charset to be used to decode this specific file.
String	contents() Fetches the entire contents of the file, decoding with the charset().
File	file() Deprecated. since 6.6 use inputStream() for file content, IndexedFile.filename() for file name, IndexedFile.uri() for an unique identifier, and toString() for logging
InputStream	inputStream() Creates a stream of the file's contents.
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() Deprecated. since 6.6 use inputStream() for file content, IndexedFile.filename() for file name, IndexedFile.uri() for an unique identifier, and toString() for logging
String	relativePath() Deprecated. since 6.6 use inputStream() for file content, IndexedFile.filename() for file name, IndexedFile.uri() for an unique identifier, and toString() for logging
TextRange	selectLine(int line) Returns a TextRange in the given file that select the full line.
InputFile.Status	status() Status regarding previous analysis
String	toString() Return a string to identify this file (suitable for logs).
InputFile.Type	type() Does it contain main or test code ?

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

filename, uri

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

isFile, key

Method Detail

relativePath

@Deprecated
String relativePath()

Deprecated. since 6.6 use inputStream() for file content, IndexedFile.filename() for file name, IndexedFile.uri() for an unique identifier, and toString() for logging

Relative path to module (for normal Sensors) or project (for global Sensors) base directory. 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 IndexedFile

Specified by:

relativePath in interface InputPath

See Also:

relativePath(), InputDir.relativePath()

absolutePath

@Deprecated
String absolutePath()

Deprecated. since 6.6 use inputStream() for file content, IndexedFile.filename() for file name, IndexedFile.uri() for an unique identifier, and toString() for logging

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 IndexedFile

Specified by:

absolutePath in interface InputPath

See Also:

absolutePath(), InputDir.absolutePath()

file

@Deprecated
File file()

Deprecated. since 6.6 use inputStream() for file content, IndexedFile.filename() for file name, IndexedFile.uri() for an unique identifier, and toString() for logging

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

Specified by:

file in interface IndexedFile

Specified by:

file in interface InputPath

See Also:

contents(), inputStream()

path

@Deprecated
Path path()

Deprecated. since 6.6 use inputStream() for file content, IndexedFile.filename() for file name, IndexedFile.uri() for an unique identifier, and toString() for logging

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

Specified by:

path in interface IndexedFile

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.

Specified by:

language in interface IndexedFile

type

InputFile.Type type()

Does it contain main or test code ?

Specified by:

type in interface IndexedFile

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. Since 6.4 BOM is automatically filtered out.

Specified by:

inputStream in interface IndexedFile

Throws:

IOException

Since:

6.2

contents

String contents()
         throws IOException

Fetches the entire contents of the file, decoding with the charset(). Since 6.4 BOM is automatically filtered out.

Throws:

IOException

Since:

6.2

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

toString

String toString()

Return a string to identify this file (suitable for logs).

Overrides:

toString in class Object