org.sonar.api.batch.fs.internal

Class DefaultIndexedFile

java.lang.Object

org.sonar.api.batch.fs.internal.DefaultInputComponent

org.sonar.api.batch.fs.internal.DefaultIndexedFile

All Implemented Interfaces:

IndexedFile, InputComponent, InputPath

@Immutable
public class DefaultIndexedFile
extends DefaultInputComponent
implements IndexedFile

Since:

6.3

Constructor Summary

Constructors

Constructor and Description
DefaultIndexedFile(String moduleKey, Path moduleBaseDir, String relativePath, InputFile.Type type, String language, int batchId)
DefaultIndexedFile(String moduleKey, Path moduleBaseDir, String relativePath, String language) Testing purposes only!
DefaultIndexedFile(String moduleKey, Path moduleBaseDir, String relativePath, String language, int batchId)

Method Summary

Modifier and Type	Method and Description
String	absolutePath() Normalized absolute path.
boolean	equals(Object o)
File	file() The underlying absolute File.
int	hashCode()
InputStream	inputStream() Creates a stream of the file's contents.
boolean	isFile() Is the component an InputFile
String	key() Component key (without branch).
String	language() Language, for example "java" or "php".
String	moduleKey()
Path	path() The underlying absolute Path.
String	relativePath() Path relative to module base directory.
String	toString()
InputFile.Type	type() Does it contain main or test code ?

Methods inherited from class org.sonar.api.batch.fs.internal.DefaultInputComponent

batchId

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DefaultIndexedFile

public DefaultIndexedFile(String moduleKey,
                          Path moduleBaseDir,
                          String relativePath,
                          @Nullable
                          String language)

Testing purposes only!

DefaultIndexedFile

public DefaultIndexedFile(String moduleKey,
                          Path moduleBaseDir,
                          String relativePath,
                          @Nullable
                          String language,
                          int batchId)

DefaultIndexedFile

public DefaultIndexedFile(String moduleKey,
                          Path moduleBaseDir,
                          String relativePath,
                          InputFile.Type type,
                          @Nullable
                          String language,
                          int batchId)

Method Detail

relativePath

public String relativePath()

Description copied from interface: IndexedFile

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 IndexedFile

Specified by:

relativePath in interface InputPath

See Also:

InputFile.relativePath(), InputDir.relativePath()

absolutePath

public String absolutePath()

Description copied from interface: IndexedFile

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:

InputFile.absolutePath(), InputDir.absolutePath()

file

public File file()

Description copied from interface: IndexedFile

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(), IndexedFile.inputStream()

path

public Path path()

Description copied from interface: IndexedFile

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

See Also:

#contents(), IndexedFile.inputStream()

inputStream

public InputStream inputStream()
                        throws IOException

Description copied from interface: IndexedFile

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.

Specified by:

inputStream in interface IndexedFile

Throws:

IOException

language

@CheckForNull
public String language()

Description copied from interface: IndexedFile

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

public InputFile.Type type()

Description copied from interface: IndexedFile

Does it contain main or test code ?

Specified by:

type in interface IndexedFile

key

public String key()

Component key (without branch).

Specified by:

key in interface InputComponent

moduleKey

public String moduleKey()

equals

public boolean equals(Object o)

Overrides:

equals in class DefaultInputComponent

hashCode

public int hashCode()

Overrides:

hashCode in class DefaultInputComponent

toString

public String toString()

Overrides:

toString in class DefaultInputComponent

isFile

public boolean isFile()

Description copied from interface: InputComponent

Is the component an InputFile

Specified by:

isFile in interface InputComponent