Package org.sonarqube.gradle.properties

Class SonarProperty

java.lang.Object

org.sonarqube.gradle.properties.SonarProperty

public class SonarProperty
extends Object

Full identifier of a sonar property, they are passed to the analyzers. Some properties are only global and other can be scoped within a subproject. The full identifier consists of subproject + property name.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ANDROID_LINT_REPORT_PATHS
static final String	BINARIES	Kept for backward compatibility
static final String	GRADLE_SCAN_ALL
static final String	GROOVY_BINARIES
static final String	JACOCO_XML_REPORT_PATHS
static final String	JAVA_BINARIES
static final String	JAVA_ENABLE_PREVIEW
static final String	JAVA_JDK_HOME
static final String	JAVA_LIBRARIES
static final String	JAVA_SOURCE
static final String	JAVA_TARGET
static final String	JAVA_TEST_BINARIES
static final String	JAVA_TEST_LIBRARIES
static final String	JUNIT_REPORT_PATHS
static final String	JUNIT_REPORTS_PATH	Kept for backward compatibility
static final String	KOTLIN_GRADLE_PROJECT_ROOT
static final String	LIBRARIES	Kept for backward compatibility
static final String	MODULE_KEY
static final String	MODULES
static final String	PROJECT_BASE_DIR
static final String	PROJECT_DESCRIPTION
static final String	PROJECT_KEY
static final String	PROJECT_NAME
static final String	PROJECT_SOURCE_DIRS
static final String	PROJECT_TEST_DIRS
static final String	PROJECT_VERSION
static final String	SKIP
static final String	SOURCE_ENCODING
static final String	SUREFIRE_REPORTS_PATH	Kept for backward compatibility
static final String	VERBOSE
static final String	WORKING_DIRECTORY

Constructor Summary

Constructors

Constructor	Description
SonarProperty(String subproject, String propertyName)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
String	getProperty()
String	getSubproject()
int	hashCode()
static Optional<SonarProperty>	parse(String value)	Parse a property as a string, refer to toString() for the exact format.
static SonarProperty	rootProjectProperty(String property)
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

SKIP

public static final String SKIP

See Also:

• Constant Field Values

GRADLE_SCAN_ALL

public static final String GRADLE_SCAN_ALL

See Also:

• Constant Field Values

VERBOSE

public static final String VERBOSE

See Also:

• Constant Field Values

PROJECT_KEY

public static final String PROJECT_KEY

See Also:

• Constant Field Values

MODULE_KEY

public static final String MODULE_KEY

See Also:

• Constant Field Values

MODULES

public static final String MODULES

See Also:

• Constant Field Values

PROJECT_NAME

public static final String PROJECT_NAME

See Also:

• Constant Field Values

PROJECT_DESCRIPTION

public static final String PROJECT_DESCRIPTION

See Also:

• Constant Field Values

PROJECT_VERSION

public static final String PROJECT_VERSION

See Also:

• Constant Field Values

PROJECT_BASE_DIR

public static final String PROJECT_BASE_DIR

See Also:

• Constant Field Values

WORKING_DIRECTORY

public static final String WORKING_DIRECTORY

See Also:

• Constant Field Values

PROJECT_SOURCE_DIRS

public static final String PROJECT_SOURCE_DIRS

See Also:

• Constant Field Values

PROJECT_TEST_DIRS

public static final String PROJECT_TEST_DIRS

See Also:

• Constant Field Values

SOURCE_ENCODING

public static final String SOURCE_ENCODING

See Also:

• Constant Field Values

JAVA_SOURCE

public static final String JAVA_SOURCE

See Also:

• Constant Field Values

JAVA_TARGET

public static final String JAVA_TARGET

See Also:

• Constant Field Values

JAVA_ENABLE_PREVIEW

public static final String JAVA_ENABLE_PREVIEW

See Also:

• Constant Field Values

JAVA_JDK_HOME

public static final String JAVA_JDK_HOME

See Also:

• Constant Field Values

JAVA_BINARIES

public static final String JAVA_BINARIES

See Also:

• Constant Field Values

JAVA_LIBRARIES

public static final String JAVA_LIBRARIES

See Also:

• Constant Field Values

JAVA_TEST_BINARIES

public static final String JAVA_TEST_BINARIES

See Also:

• Constant Field Values

JAVA_TEST_LIBRARIES

public static final String JAVA_TEST_LIBRARIES

See Also:

• Constant Field Values

LIBRARIES

public static final String LIBRARIES

Kept for backward compatibility

See Also:

• Constant Field Values

GROOVY_BINARIES

public static final String GROOVY_BINARIES

See Also:

• Constant Field Values

KOTLIN_GRADLE_PROJECT_ROOT

public static final String KOTLIN_GRADLE_PROJECT_ROOT

See Also:

• Constant Field Values

JUNIT_REPORT_PATHS

public static final String JUNIT_REPORT_PATHS

See Also:

• Constant Field Values

JUNIT_REPORTS_PATH

public static final String JUNIT_REPORTS_PATH

Kept for backward compatibility

See Also:

• Constant Field Values

SUREFIRE_REPORTS_PATH

public static final String SUREFIRE_REPORTS_PATH

Kept for backward compatibility

See Also:

• Constant Field Values

JACOCO_XML_REPORT_PATHS

public static final String JACOCO_XML_REPORT_PATHS

See Also:

• Constant Field Values

ANDROID_LINT_REPORT_PATHS

public static final String ANDROID_LINT_REPORT_PATHS

See Also:

• Constant Field Values

BINARIES

public static final String BINARIES

Kept for backward compatibility

See Also:

• Constant Field Values

Constructor Details

SonarProperty

public SonarProperty(@Nullable
 String subproject,
 String propertyName)

Method Details

parse

public static Optional<SonarProperty> parse(String value)

Parse a property as a string, refer to toString() for the exact format. The format is approximately "${subproject_name}.{property_name}". parse(prop.toString()).equals(prop) is always true

Note, module names can also contain dots. The only way to parse a property is to verify if it has as suffix one of the properties above.

Parameters:

value - a string that respects the property format

Returns:

parsed property or empty if parsing failed

rootProjectProperty

public static SonarProperty rootProjectProperty(String property)

getSubproject

@Nullable
public String getSubproject()

getProperty

public String getProperty()

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object