A C D E F H J M O P R S T U V W

A

addExtensions(Object...) - Method in class org.sonar.runner.api.EmbeddedRunner

addJvmArguments(String...) - Method in class org.sonar.runner.api.ForkedRunner

See ForkedRunner.addJvmArguments(java.util.List)

addJvmArguments(List<String>) - Method in class org.sonar.runner.api.ForkedRunner

JVM arguments, for example "-Xmx512m"

addJvmEnvVariables(Map<String, String>) - Method in class org.sonar.runner.api.ForkedRunner

Add some JVM environment variables.

addProperties(Properties) - Method in class org.sonar.runner.api.Runner

Declare Sonar properties, for example sonar.projectKey=>foo.

app() - Method in class org.sonar.runner.api.Runner

appVersion() - Method in class org.sonar.runner.api.Runner

C

consumeLine(String) - Method in class org.sonar.runner.api.PrintStreamConsumer

consumeLine(String) - Method in interface org.sonar.runner.api.StreamConsumer

create() - Static method in class org.sonar.runner.api.EmbeddedRunner

Create a new instance.

create() - Static method in class org.sonar.runner.api.ForkedRunner

Create new instance.

create(ProcessMonitor) - Static method in class org.sonar.runner.api.ForkedRunner

Create new instance.

D

doExecute() - Method in class org.sonar.runner.api.EmbeddedRunner

doExecute() - Method in class org.sonar.runner.api.ForkedRunner

doExecute() - Method in class org.sonar.runner.api.Runner

E

EmbeddedRunner - Class in org.sonar.runner.api

Implementation of Runner that is executed in the same JVM.

execute() - Method in class org.sonar.runner.api.Runner

F

ForkedRunner - Class in org.sonar.runner.api

Runner executed in a new JVM.

H

HOST_URL - Static variable in interface org.sonar.runner.api.RunnerProperties

HTTP URL of Sonar server, "http://localhost:9000" by default

J

jvmArguments() - Method in class org.sonar.runner.api.ForkedRunner

M

mask(String) - Method in class org.sonar.runner.api.EmbeddedRunner

MODULE_KEY - Static variable in interface org.sonar.runner.api.ScanProperties

Used to define the exact key of each module.

O

org.sonar.runner.api - package org.sonar.runner.api

P

PrintStreamConsumer - Class in org.sonar.runner.api

Implementation of StreamConsumer that prints lines to PrintStream.

PrintStreamConsumer(PrintStream) - Constructor for class org.sonar.runner.api.PrintStreamConsumer

ProcessMonitor - Interface in org.sonar.runner.api

To be used with ForkedRunner

PROJECT_BASEDIR - Static variable in interface org.sonar.runner.api.ScanProperties

Property used to specify the base directory of the project to analyse.

PROJECT_BINARY_DIRS - Static variable in interface org.sonar.runner.api.ScanProperties

Optional paths to binaries, for example to declare the directory of Java bytecode.

PROJECT_DATE - Static variable in interface org.sonar.runner.api.ScanProperties

It becomes quickly necessary to input historical data and to highlight some events.

PROJECT_DESCRIPTION - Static variable in interface org.sonar.runner.api.ScanProperties

Optional description

PROJECT_KEY - Static variable in interface org.sonar.runner.api.ScanProperties

Required project key

PROJECT_LANGUAGE - Static variable in interface org.sonar.runner.api.ScanProperties

PROJECT_LIBRARIES - Static variable in interface org.sonar.runner.api.ScanProperties

Optional comma-separated list of paths to libraries.

PROJECT_NAME - Static variable in interface org.sonar.runner.api.ScanProperties

PROJECT_SOURCE_DIRS - Static variable in interface org.sonar.runner.api.ScanProperties

Required paths to source directories, separated by commas, for example: "srcDir1,srcDir2"

PROJECT_SOURCE_ENCODING - Static variable in interface org.sonar.runner.api.ScanProperties

Encoding of source and test files.

PROJECT_TEST_DIRS - Static variable in interface org.sonar.runner.api.ScanProperties

Optional paths to test directories, separated by commas, for example: "testDir1,testDir2"

PROJECT_VERSION - Static variable in interface org.sonar.runner.api.ScanProperties

properties() - Method in class org.sonar.runner.api.Runner

property(String, String) - Method in class org.sonar.runner.api.Runner

R

Runner<T extends Runner> - Class in org.sonar.runner.api

Runner() - Constructor for class org.sonar.runner.api.Runner

RunnerProperties - Interface in org.sonar.runner.api

Mostly used properties that can be injected in Runner.setProperty(String, String).

RunnerVersion - Enum in org.sonar.runner.api

Version of this sonar-runner API.

S

SCAN_TASK - Static variable in interface org.sonar.runner.api.ScanProperties

Default task

ScanProperties - Interface in org.sonar.runner.api

Most commonly used properties of the task "scan".

setApp(String, String) - Method in class org.sonar.runner.api.Runner

User-agent used in the HTTP requests to the Sonar server

setJavaExecutable(String) - Method in class org.sonar.runner.api.ForkedRunner

Path to the java executable.

setJvmEnvVariable(String, String) - Method in class org.sonar.runner.api.ForkedRunner

Set a JVM environment variable.

setProperty(String, String) - Method in class org.sonar.runner.api.Runner

Declare a Sonar property.

setStdErr(StreamConsumer) - Method in class org.sonar.runner.api.ForkedRunner

Subscribe to the error output.

setStdOut(StreamConsumer) - Method in class org.sonar.runner.api.ForkedRunner

Subscribe to the standard output.

setUnmaskedPackages(String...) - Method in class org.sonar.runner.api.EmbeddedRunner

Deprecated. since 2.3 use EmbeddedRunner.unmask(String)

stop() - Method in interface org.sonar.runner.api.ProcessMonitor

ForkedRunner will poll this method periodically and if true is returned then forked SonarQube Runner process will be killed.

StreamConsumer - Interface in org.sonar.runner.api

T

TASK - Static variable in interface org.sonar.runner.api.RunnerProperties

Task to execute, "scan" by default

U

unmask(String) - Method in class org.sonar.runner.api.EmbeddedRunner

Sonar is executed in an almost fully isolated classloader (mask everything by default).

V

valueOf(String) - Static method in enum org.sonar.runner.api.RunnerVersion

Returns the enum constant of this type with the specified name.

values() - Static method in enum org.sonar.runner.api.RunnerVersion

Returns an array containing the constants of this enum type, in the order they are declared.

version() - Static method in enum org.sonar.runner.api.RunnerVersion

W

WORK_DIR - Static variable in interface org.sonar.runner.api.RunnerProperties

Working directory containing generated reports and temporary data.

A C D E F H J M O P R S T U V W