org.sonar.runner.api
Interface ScanProperties

public interface ScanProperties

Most commonly used properties of the task "scan". These properties are injected in Runner.setProperty(String, String). See documentation for more properties.

Since:

2.2

Field Summary

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_BINARY_DIRS Optional paths to binaries, for example to declare the directory of Java bytecode.
static String	PROJECT_DATE It becomes quickly necessary to input historical data and to highlight some events.
static String	PROJECT_DESCRIPTION Optional description
static String	PROJECT_KEY Required project key
static String	PROJECT_LANGUAGE
static String	PROJECT_LIBRARIES Optional comma-separated list of paths to libraries.
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

Field Detail

SCAN_TASK

static final String SCAN_TASK

Default task

See Also:

RunnerProperties.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 :.

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_BINARY_DIRS

static final String PROJECT_BINARY_DIRS

Optional paths to binaries, for example to declare the directory of Java bytecode. Example : "binDir"

See Also:

Constant Field Values

PROJECT_LIBRARIES

static final String PROJECT_LIBRARIES

Optional comma-separated list of paths to libraries. Example : path/to/library/*.jar,path/to/specific/library/myLibrary.jar,parent/*.jar

See Also:

Constant Field Values

PROJECT_LANGUAGE

static final String PROJECT_LANGUAGE

See Also:

Constant Field Values

PROJECT_DATE

static final String PROJECT_DATE

It becomes quickly necessary to input historical data and to highlight some events. It is possible by going for example in a subversion tag and use this property. Format is yyyy-MM-dd, for example 2010-12-25.

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