ScanProperties (SonarQube Scanner API 2.9.0.887 API)

```
public interface ScanProperties
```
Most commonly used properties for a SonarQube analysis. These properties are passed to EmbeddedScanner.runAnalysis(java.util.Properties). See documentation for more properties.

Since:

2.2

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`MODULE_KEY` Used to define the exact key of each module.
`static String`	`PROJECT_BASEDIR` Property used to specify the base directory of the project to analyse.
`static String`	`PROJECT_DESCRIPTION` Optional description
`static String`	`PROJECT_KEY` Required project key
`static String`	`PROJECT_NAME`
`static String`	`PROJECT_SOURCE_DIRS` Required paths to source directories, separated by commas, for example: "srcDir1,srcDir2"
`static String`	`PROJECT_SOURCE_ENCODING` Encoding of source and test files.
`static String`	`PROJECT_TEST_DIRS` Optional paths to test directories, separated by commas, for example: "testDir1,testDir2"
`static String`	`PROJECT_VERSION`
`static String`	`SCAN_TASK` Default task
`static String`	`SKIP` Skip analysis.

- Field Detail
  - SCAN_TASK
```
static final String SCAN_TASK
```
    Default task
    
    See Also:
    
    ScannerProperties.TASK, Constant Field Values
  - PROJECT_KEY
```
static final String PROJECT_KEY
```
    Required project key
    
    See Also:
    
    Constant Field Values
  - MODULE_KEY
```
static final String MODULE_KEY
```
    Used to define the exact key of each module. If PROJECT_KEY is used instead on a module, then final key of the module will be <parent module key>:<PROJECT_KEY>.
    
    Since:
    
    SonarQube 4.1
    
    See Also:
    
    Constant Field Values
  - PROJECT_NAME
```
static final String PROJECT_NAME
```
    See Also:
    
    Constant Field Values
  - PROJECT_VERSION
```
static final String PROJECT_VERSION
```
    See Also:
    
    Constant Field Values
  - PROJECT_DESCRIPTION
```
static final String PROJECT_DESCRIPTION
```
    Optional description
    
    See Also:
    
    Constant Field Values
  - PROJECT_SOURCE_DIRS
```
static final String PROJECT_SOURCE_DIRS
```
    Required paths to source directories, separated by commas, for example: "srcDir1,srcDir2"
    
    See Also:
    
    Constant Field Values
  - PROJECT_TEST_DIRS
```
static final String PROJECT_TEST_DIRS
```
    Optional paths to test directories, separated by commas, for example: "testDir1,testDir2"
    
    See Also:
    
    Constant Field Values
  - PROJECT_BASEDIR
```
static final String PROJECT_BASEDIR
```
    Property used to specify the base directory of the project to analyse. Default is ".".
    
    See Also:
    
    Constant Field Values
  - PROJECT_SOURCE_ENCODING
```
static final String PROJECT_SOURCE_ENCODING
```
    Encoding of source and test files. By default it's the platform encoding.
    
    See Also:
    
    Constant Field Values
  - SKIP
```
static final String SKIP
```
    Skip analysis.
    
    See Also:
    
    Constant Field Values

Interface ScanProperties

Field Summary

Field Detail

SCAN_TASK

PROJECT_KEY

MODULE_KEY

PROJECT_NAME

PROJECT_VERSION

PROJECT_DESCRIPTION

PROJECT_SOURCE_DIRS

PROJECT_TEST_DIRS

PROJECT_BASEDIR

PROJECT_SOURCE_ENCODING

SKIP