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 and Description
DefaultInputDir(String moduleKey, String relativePath)

Method Summary

Methods

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

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultInputDir

public DefaultInputDir(String moduleKey,
               String relativePath)

Method Detail

relativePath

public 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 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 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 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 String moduleKey()

key

public String key()

Description copied from interface: InputComponent

Component key shared by all part of SonarQube (batch, server, WS...)

Specified by:

key in interface InputComponent

setModuleBaseDir

public DefaultInputDir setModuleBaseDir(Path moduleBaseDir)

For testing purpose. Will be automaticall 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(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