Package org.sonar.api.config.internal

Class MapSettings

java.lang.Object

org.sonar.api.config.Settings

org.sonar.api.config.internal.Settings

org.sonar.api.config.internal.MapSettings

public class MapSettings
extends Settings

In-memory map-based implementation of Settings. It must be used only for unit tests. This is not the implementation deployed at runtime, so non-test code must never cast Settings to MapSettings.

Since:

6.1

Constructor Summary

Constructors

Constructor	Description
MapSettings()
MapSettings(org.sonar.api.config.PropertyDefinitions definitions)

Method Summary

Modifier and Type	Method	Description
org.sonar.api.config.Configuration	asConfig()
MapSettings	clear()	Delete all properties
protected Optional<String>	get(String key)
Map<String,String>	getProperties()	Immutable map of the properties that have non-default values.
protected void	remove(String key)
protected void	set(String key, String value)	Add the settings with the specified key and value, both are trimmed and neither can be null.
MapSettings	setProperty(String key, Boolean value)
MapSettings	setProperty(String key, Integer value)
MapSettings	setProperty(String key, Long value)
MapSettings	setProperty(String key, String value)	Change a property value in a restricted scope only, depending on execution context.

Methods inherited from class org.sonar.api.config.internal.Settings

addProperties, addProperties, appendProperty, getBoolean, getDate, getDateTime, getDefaultValue, getDefinition, getDefinitions, getDouble, getEncryption, getFloat, getInt, getKeysStartingWith, getLong, getRawString, getString, getStringArray, getStringArrayBySeparator, getStringLines, hasDefaultValue, hasKey, removeProperty, setProperty, setProperty, setProperty, setProperty, setProperty

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

MapSettings

public MapSettings()

MapSettings

public MapSettings(org.sonar.api.config.PropertyDefinitions definitions)

Method Details

get

protected Optional<String> get(String key)

Specified by:

get in class Settings

set

protected void set(String key,
 String value)

Description copied from class: Settings

Add the settings with the specified key and value, both are trimmed and neither can be null.

Specified by:

set in class Settings

remove

protected void remove(String key)

Specified by:

remove in class Settings

getProperties

public Map<String,String> getProperties()

Description copied from class: Settings

Immutable map of the properties that have non-default values. The default values defined by PropertyDefinitions are ignored, so the returned values are not the effective values. Basically only the non-empty results of Settings.getRawString(String) are returned.

Values are not decrypted if they are encrypted with a secret key.

Specified by:

getProperties in class Settings

clear

public MapSettings clear()

Delete all properties

setProperty

public MapSettings setProperty(String key,
 String value)

Description copied from class: Settings

Change a property value in a restricted scope only, depending on execution context. New value is never persisted. New value is ephemeral and kept in memory only:

• during current analysis in the case of scanner stack
• during processing of current HTTP request in the case of web server stack
• during execution of current task in the case of Compute Engine stack

Property is temporarily removed if the parameter value is null

Overrides:

setProperty in class Settings

setProperty

public MapSettings setProperty(String key,
 Integer value)

Overrides:

setProperty in class Settings

See Also:

• Settings.setProperty(String, String)

setProperty

public MapSettings setProperty(String key,
 Boolean value)

Overrides:

setProperty in class Settings

See Also:

• Settings.setProperty(String, String)

setProperty

public MapSettings setProperty(String key,
 Long value)

Overrides:

setProperty in class Settings

See Also:

• Settings.setProperty(String, String)

asConfig

public org.sonar.api.config.Configuration asConfig()

Returns:

a Configuration proxy on top of this existing Settings implementation. Changes are reflected in the Configuration object.

Since:

6.5