Package org.sonar.api.batch.fs.internal

Class DefaultInputDir

java.lang.Object

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

org.sonar.api.batch.fs.internal.DefaultInputDir

All Implemented Interfaces:

InputComponent, InputDir, InputPath

public class DefaultInputDir
extends DefaultInputComponent
implements InputDir

Since:

4.5

Constructor Summary

Constructors

Constructor	Description
DefaultInputDir(java.lang.String moduleKey, java.lang.String relativePath)

Method Summary

Modifier and Type	Method	Description
java.lang.String	absolutePath()	Normalized absolute path.
boolean	equals(java.lang.Object o)
java.io.File	file()	The underlying absolute File
int	hashCode()
boolean	isFile()	Is the component an InputFile
java.lang.String	key()	Component key shared by all part of SonarQube (scanner, server, WS...).
java.lang.String	moduleKey()
java.nio.file.Path	path()	The underlying absolute Path
java.lang.String	relativePath()	Path relative to module base directory.
DefaultInputDir	setModuleBaseDir(java.nio.file.Path moduleBaseDir)	For testing purpose.
java.lang.String	toString()
java.net.URI	uri()	Identifier of the component.

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

hasMeasureFor, scannerId, setHasMeasureFor

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultInputDir

public DefaultInputDir(java.lang.String moduleKey,
                       java.lang.String relativePath)

Method Detail

relativePath

public java.lang.String relativePath()

Description copied from interface: InputDir

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

Specified by:

relativePath in interface InputDir

Specified by:

relativePath in interface InputPath

See Also:

InputFile.relativePath(), InputDir.relativePath()

absolutePath

public java.lang.String absolutePath()

Description copied from interface: InputDir

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. Use file().getCanonicalPath() to resolve symbolic link.

Specified by:

absolutePath in interface InputDir

Specified by:

absolutePath in interface InputPath

See Also:

InputFile.absolutePath(), InputDir.absolutePath()

file

public java.io.File file()

Description copied from interface: InputDir

The underlying absolute File

Specified by:

file in interface InputDir

Specified by:

file in interface InputPath

See Also:

InputFile.file(), InputDir.file()

path

public java.nio.file.Path path()

Description copied from interface: InputDir

The underlying absolute Path

Specified by:

path in interface InputDir

Specified by:

path in interface InputPath

See Also:

InputFile.path(), InputDir.path()

moduleKey

public java.lang.String moduleKey()

key

public java.lang.String key()

Description copied from interface: InputComponent

Component key shared by all part of SonarQube (scanner, server, WS...). It doesn't include the branch. Warning. Do not use in SonarLint.

Specified by:

key in interface InputComponent

setModuleBaseDir

public DefaultInputDir setModuleBaseDir(java.nio.file.Path moduleBaseDir)

For testing purpose. Will be automatically set when dir is added to DefaultFileSystem

isFile

public boolean isFile()

Description copied from interface: InputComponent

Is the component an InputFile

Specified by:

isFile in interface InputComponent

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class DefaultInputComponent

hashCode

public int hashCode()

Overrides:

hashCode in class DefaultInputComponent

toString

public java.lang.String toString()

Overrides:

toString in class DefaultInputComponent

uri

public java.net.URI uri()

Description copied from interface: InputPath

Identifier of the component. The only guarantee is that it is unique in the project. You should not assume it is a file:// URI.

Specified by:

uri in interface InputPath