ProjectDefinition (SonarQube :: Plugin API 5.3 API)

java.lang.Object
- org.sonar.api.batch.bootstrap.ProjectDefinition

```
public class ProjectDefinition
extends Object
```
Defines project metadata (key, name, source directories, ...). It's generally used by the extension point and must not be used by other standard extensions.

Since:

2.9

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`BINARIES_PROPERTY` Deprecated. since 4.5.1 use SonarQube Java specific API
`static String`	`BUILD_DIR_PROPERTY`
`static String`	`LIBRARIES_PROPERTY` Deprecated. since 4.5.1 use SonarQube Java specific API
`static String`	`SOURCE_DIRS_PROPERTY` Deprecated. since 4.5 use `SOURCES_PROPERTY`
`static String`	`SOURCE_FILES_PROPERTY` Deprecated. since 4.5 use `SOURCES_PROPERTY`
`static String`	`SOURCES_PROPERTY`
`static String`	`TEST_DIRS_PROPERTY` Deprecated. since 4.5 use `TESTS_PROPERTY`
`static String`	`TEST_FILES_PROPERTY` Deprecated. since 4.5 use `TESTS_PROPERTY`
`static String`	`TESTS_PROPERTY`

Method Summary

Methods
Modifier and Type	Method and Description
`ProjectDefinition`	`addBinaryDir(File f)` Deprecated. since 4.5.1 use SonarQube Java specific API
`ProjectDefinition`	`addBinaryDir(String path)` Deprecated. since 4.5.1 use SonarQube Java specific API
`void`	`addLibrary(String path)` Deprecated. since 4.5.1 use SonarQube Java specific API
`ProjectDefinition`	`addSourceDirs(File... dirs)` Deprecated. since 4.5 use `addSources(File...)`
`ProjectDefinition`	`addSourceDirs(String... paths)` Deprecated. since 4.5 use `addSources(String...)`
`ProjectDefinition`	`addSourceFiles(File... files)` Deprecated. since 4.5 use `addSources(File...)`
`ProjectDefinition`	`addSourceFiles(String... paths)` Deprecated. since 4.5 use `addSources(File...)`
`ProjectDefinition`	`addSources(File... fileOrDirs)`
`ProjectDefinition`	`addSources(String... paths)`
`ProjectDefinition`	`addSubProject(ProjectDefinition child)`
`ProjectDefinition`	`addTestDirs(File... dirs)` Deprecated. since 4.5 use `addTests(File...)`
`ProjectDefinition`	`addTestDirs(String... paths)` Deprecated. since 4.5 use `addTests(String...)`
`ProjectDefinition`	`addTestFiles(File... files)` Deprecated. since 4.5 use `addTests(File...)`
`ProjectDefinition`	`addTestFiles(String... paths)` Deprecated. since 4.5 use `addTests(String...)`
`ProjectDefinition`	`addTests(File... fileOrDirs)`
`ProjectDefinition`	`addTests(String... paths)`
`static ProjectDefinition`	`create()`
`static ProjectDefinition`	`create(Properties properties)` Deprecated. in 2.12, because it uses external object to represent internal state. To ensure backward-compatibility with Ant task this method cannot clone properties, so other callers must explicitly make clone of properties before passing into this method. Thus better to use `create()` with combination of other methods like `setProperties(Properties)` and `setProperty(String, String)`.
`boolean`	`equals(Object o)`
`File`	`getBaseDir()`
`List<String>`	`getBinaries()` Deprecated. since 4.5.1 use SonarQube Java specific API
`String`	`getBranch()`
`File`	`getBuildDir()`
`String`	`getDescription()`
`String`	`getKey()`
`String`	`getKeyWithBranch()`
`List<String>`	`getLibraries()` Deprecated. since 4.5.1 use SonarQube Java specific API
`String`	`getName()`
`ProjectDefinition`	`getParent()`
`Properties`	`getProperties()` Deprecated. since 5.0 use `properties()`
`List<String>`	`getSourceDirs()` Deprecated. since 4.5 use `sources()`
`List<String>`	`getSourceFiles()` Deprecated. since 4.5 use `sources()`
`List<ProjectDefinition>`	`getSubProjects()`
`List<String>`	`getTestDirs()` Deprecated. since 4.5 use `tests()`
`List<String>`	`getTestFiles()` Deprecated. since 4.5 use `tests()`
`String`	`getVersion()`
`File`	`getWorkDir()`
`int`	`hashCode()`
`Map<String,String>`	`properties()`
`void`	`remove()`
`ProjectDefinition`	`resetSourceDirs()` Deprecated. since 4.5 use `resetSources()`
`ProjectDefinition`	`resetSources()`
`ProjectDefinition`	`resetTestDirs()` Deprecated. since 4.5 use `resetTests()`
`ProjectDefinition`	`resetTests()`
`ProjectDefinition`	`setBaseDir(File baseDir)`
`ProjectDefinition`	`setBuildDir(File d)`
`ProjectDefinition`	`setDescription(String s)`
`ProjectDefinition`	`setKey(String key)`
`ProjectDefinition`	`setName(String s)`
`ProjectDefinition`	`setProperties(Map<String,String> properties)`
`ProjectDefinition`	`setProperties(Properties properties)` Deprecated. since 5.0 use `setProperties(Map)`
`ProjectDefinition`	`setProperty(String key, String value)`
`ProjectDefinition`	`setSourceDirs(File... dirs)` Deprecated. since 4.5 use `setSources(File...)`
`ProjectDefinition`	`setSourceDirs(String... paths)` Deprecated. since 4.5 use `setSources(String...)`
`ProjectDefinition`	`setSources(File... filesOrDirs)`
`ProjectDefinition`	`setSources(String... paths)`
`ProjectDefinition`	`setTestDirs(File... dirs)` Deprecated. since 4.5 use `setTests(File...)`
`ProjectDefinition`	`setTestDirs(String... paths)` Deprecated. since 4.5 use `setTests(String...)`
`ProjectDefinition`	`setTests(File... fileOrDirs)`
`ProjectDefinition`	`setTests(String... paths)`
`ProjectDefinition`	`setVersion(String s)`
`ProjectDefinition`	`setWorkDir(File workDir)`
`List<String>`	`sources()`
`List<String>`	`tests()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail
- SOURCES_PROPERTY
```
public static final String SOURCES_PROPERTY
```
  See Also:
  Constant Field Values
- SOURCE_DIRS_PROPERTY
```
@Deprecated
public static final String SOURCE_DIRS_PROPERTY
```
  Deprecated. since 4.5 use SOURCES_PROPERTY
  
  See Also:
  Constant Field Values
- SOURCE_FILES_PROPERTY
```
@Deprecated
public static final String SOURCE_FILES_PROPERTY
```
  Deprecated. since 4.5 use SOURCES_PROPERTY
  
  See Also:
  Constant Field Values
- TESTS_PROPERTY
```
public static final String TESTS_PROPERTY
```
  See Also:
  Constant Field Values
- TEST_DIRS_PROPERTY
```
@Deprecated
public static final String TEST_DIRS_PROPERTY
```
  Deprecated. since 4.5 use TESTS_PROPERTY
  
  See Also:
  Constant Field Values
- TEST_FILES_PROPERTY
```
@Deprecated
public static final String TEST_FILES_PROPERTY
```
  Deprecated. since 4.5 use TESTS_PROPERTY
  
  See Also:
  Constant Field Values
- BINARIES_PROPERTY
```
@Deprecated
public static final String BINARIES_PROPERTY
```
  Deprecated. since 4.5.1 use SonarQube Java specific API
  
  See Also:
  Constant Field Values
- LIBRARIES_PROPERTY
```
@Deprecated
public static final String LIBRARIES_PROPERTY
```
  Deprecated. since 4.5.1 use SonarQube Java specific API
  
  See Also:
  Constant Field Values
- BUILD_DIR_PROPERTY
```
public static final String BUILD_DIR_PROPERTY
```
  See Also:
  Constant Field Values

Method Detail

create
```
@Deprecated
public static ProjectDefinition create(Properties properties)
```
Deprecated. in 2.12, because it uses external object to represent internal state. To ensure backward-compatibility with Ant task this method cannot clone properties, so other callers must explicitly make clone of properties before passing into this method. Thus better to use create() with combination of other methods like setProperties(Properties) and setProperty(String, String).

create

public static ProjectDefinition create()

setBaseDir

public ProjectDefinition setBaseDir(File baseDir)

getBaseDir
```
public File getBaseDir()
```

setWorkDir

public ProjectDefinition setWorkDir(File workDir)

getWorkDir
```
public File getWorkDir()
```

setBuildDir

public ProjectDefinition setBuildDir(File d)

getBuildDir
```
public File getBuildDir()
```

getProperties

@Deprecated
public Properties getProperties()

Deprecated. since 5.0 use properties()

properties

public Map<String,String> properties()

setProperties
```
@Deprecated
public ProjectDefinition setProperties(Properties properties)
```
Deprecated. since 5.0 use setProperties(Map)

Copies specified properties into this object.

Since:

2.12

setProperties

public ProjectDefinition setProperties(Map<String,String> properties)

setProperty

public ProjectDefinition setProperty(String key,
                            String value)

setKey

public ProjectDefinition setKey(String key)

setVersion

public ProjectDefinition setVersion(String s)

setName

public ProjectDefinition setName(String s)

setDescription

public ProjectDefinition setDescription(String s)

getKey
```
public String getKey()
```

getKeyWithBranch
```
public String getKeyWithBranch()
```
Since:

4.5

getBranch

@CheckForNull
public String getBranch()

getVersion
```
public String getVersion()
```

getName
```
public String getName()
```

getDescription
```
public String getDescription()
```

sources
```
public List<String> sources()
```
Returns:
Source files and folders.

getSourceDirs

@Deprecated
public List<String> getSourceDirs()

Deprecated. since 4.5 use sources()

addSources
```
public ProjectDefinition addSources(String... paths)
```
Parameters:
paths - paths to file or directory with main sources. They can be absolute or relative to project base directory.

addSourceDirs

@Deprecated
public ProjectDefinition addSourceDirs(String... paths)

Deprecated. since 4.5 use addSources(String...)

addSources

public ProjectDefinition addSources(File... fileOrDirs)

addSourceDirs

@Deprecated
public ProjectDefinition addSourceDirs(File... dirs)

Deprecated. since 4.5 use addSources(File...)

resetSources

public ProjectDefinition resetSources()

resetSourceDirs

@Deprecated
public ProjectDefinition resetSourceDirs()

Deprecated. since 4.5 use resetSources()

setSources

public ProjectDefinition setSources(String... paths)

setSourceDirs

@Deprecated
public ProjectDefinition setSourceDirs(String... paths)

Deprecated. since 4.5 use setSources(String...)

setSources

public ProjectDefinition setSources(File... filesOrDirs)

setSourceDirs

@Deprecated
public ProjectDefinition setSourceDirs(File... dirs)

Deprecated. since 4.5 use setSources(File...)

addSourceFiles

@Deprecated
public ProjectDefinition addSourceFiles(String... paths)

Deprecated. since 4.5 use addSources(File...)

addSourceFiles

@Deprecated
public ProjectDefinition addSourceFiles(File... files)

Deprecated. since 4.5 use addSources(File...)

getSourceFiles

@Deprecated
public List<String> getSourceFiles()

Deprecated. since 4.5 use sources()

tests
```
public List<String> tests()
```

getTestDirs

@Deprecated
public List<String> getTestDirs()

Deprecated. since 4.5 use tests()

addTests
```
public ProjectDefinition addTests(String... paths)
```
Parameters:
paths - path to files or directories with test sources. It can be absolute or relative to project directory.

addTestDirs

@Deprecated
public ProjectDefinition addTestDirs(String... paths)

Deprecated. since 4.5 use addTests(String...)

addTests

public ProjectDefinition addTests(File... fileOrDirs)

addTestDirs

@Deprecated
public ProjectDefinition addTestDirs(File... dirs)

Deprecated. since 4.5 use addTests(File...)

setTests

public ProjectDefinition setTests(String... paths)

setTestDirs

@Deprecated
public ProjectDefinition setTestDirs(String... paths)

Deprecated. since 4.5 use setTests(String...)

setTests

public ProjectDefinition setTests(File... fileOrDirs)

setTestDirs

@Deprecated
public ProjectDefinition setTestDirs(File... dirs)

Deprecated. since 4.5 use setTests(File...)

resetTests
```
public ProjectDefinition resetTests()
```

resetTestDirs

@Deprecated
public ProjectDefinition resetTestDirs()

Deprecated. since 4.5 use resetTests()

addTestFiles

@Deprecated
public ProjectDefinition addTestFiles(String... paths)

Deprecated. since 4.5 use addTests(String...)

addTestFiles

@Deprecated
public ProjectDefinition addTestFiles(File... files)

Deprecated. since 4.5 use addTests(File...)

getTestFiles

@Deprecated
public List<String> getTestFiles()

Deprecated. since 4.5 use tests()

getBinaries
```
@Deprecated
public List<String> getBinaries()
```
Deprecated. since 4.5.1 use SonarQube Java specific API

addBinaryDir
```
@Deprecated
public ProjectDefinition addBinaryDir(String path)
```
Deprecated. since 4.5.1 use SonarQube Java specific API

Parameters:
path - path to directory with compiled source. In case of Java this is directory with class files. It can be absolute or relative to project directory.

addBinaryDir

@Deprecated
public ProjectDefinition addBinaryDir(File f)

Deprecated. since 4.5.1 use SonarQube Java specific API

getLibraries
```
@Deprecated
public List<String> getLibraries()
```
Deprecated. since 4.5.1 use SonarQube Java specific API

addLibrary
```
@Deprecated
public void addLibrary(String path)
```
Deprecated. since 4.5.1 use SonarQube Java specific API

Parameters:
path - path to file with third-party library. In case of Java this is path to jar file. It can be absolute or relative to project directory.

addSubProject

public ProjectDefinition addSubProject(ProjectDefinition child)

Since:: 2.8

getParent
```
public ProjectDefinition getParent()
```

remove
```
public void remove()
```

getSubProjects

public List<ProjectDefinition> getSubProjects()

Since:: 2.8

equals
```
public boolean equals(Object o)
```
Overrides:

equals in class Object

hashCode
```
public int hashCode()
```
Overrides:

hashCode in class Object

Class ProjectDefinition

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SOURCES_PROPERTY

SOURCE_DIRS_PROPERTY

SOURCE_FILES_PROPERTY

TESTS_PROPERTY

TEST_DIRS_PROPERTY

TEST_FILES_PROPERTY

BINARIES_PROPERTY

LIBRARIES_PROPERTY

BUILD_DIR_PROPERTY

Method Detail

create

create

setBaseDir

getBaseDir

setWorkDir

getWorkDir

setBuildDir

getBuildDir

getProperties

properties

setProperties

setProperties

setProperty

setKey

setVersion

setName

setDescription

getKey

getKeyWithBranch

getBranch

getVersion

getName

getDescription

sources

getSourceDirs

addSources

addSourceDirs

addSources

addSourceDirs

resetSources

resetSourceDirs

setSources

setSourceDirs

setSources

setSourceDirs

addSourceFiles

addSourceFiles

getSourceFiles

tests

getTestDirs

addTests

addTestDirs

addTests

addTestDirs

setTests

setTestDirs

setTests

setTestDirs

resetTests

resetTestDirs

addTestFiles

addTestFiles

getTestFiles

getBinaries

addBinaryDir

addBinaryDir

getLibraries

addLibrary

addSubProject

getParent

remove

getSubProjects

equals

hashCode