Settings (SonarQube :: Plugin API 6.6 API)

java.lang.Object
- org.sonar.api.config.Settings

Direct Known Subclasses:: MapSettings

Deprecated.

since 6.5 use Configuration

@ServerSide
 @ComputeEngineSide
 @ScannerSide
 @SonarLintSide
 @Deprecated
public abstract class Settings
extends Object

Constructor Summary

Constructors
Modifier Constructor and Description

protected Settings(PropertyDefinitions definitions, Encryption encryption)
Deprecated.

Constructors
Modifier	Constructor and Description
`protected`	`Settings(PropertyDefinitions definitions, Encryption encryption)` Deprecated.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`Settings`	`addProperties(Map<String,String> props)` Deprecated.
`Settings`	`addProperties(Properties props)` Deprecated.
`Settings`	`appendProperty(String key, String value)` Deprecated.
`protected abstract Optional<String>`	`get(String key)` Deprecated.
`boolean`	`getBoolean(String key)` Deprecated. Effective value as boolean.
`Date`	`getDate(String key)` Deprecated. Effective value as `Date`, without time fields.
`Date`	`getDateTime(String key)` Deprecated. Effective value as `Date`, with time fields.
`String`	`getDefaultValue(String key)` Deprecated.
`Optional<PropertyDefinition>`	`getDefinition(String key)` Deprecated. The definition related to the specified property.
`PropertyDefinitions`	`getDefinitions()` Deprecated. All the property definitions declared by core and plugins.
`Double`	`getDouble(String key)` Deprecated. Effective value as `Double`.
`Encryption`	`getEncryption()` Deprecated.
`Float`	`getFloat(String key)` Deprecated. Effective value as `Float`.
`int`	`getInt(String key)` Deprecated. Effective value as `int`.
`List<String>`	`getKeysStartingWith(String prefix)` Deprecated.
`long`	`getLong(String key)` Deprecated. Effective value as `long`.
`abstract Map<String,String>`	`getProperties()` Deprecated. Immutable map of the properties that have non-default values.
`Optional<String>`	`getRawString(String key)` Deprecated. The value that overrides the default value.
`String`	`getString(String key)` Deprecated. The effective value of the specified property.
`String[]`	`getStringArray(String key)` Deprecated. Value is split by comma and trimmed.
`String[]`	`getStringArrayBySeparator(String key, String separator)` Deprecated. Value is split and trimmed.
`String[]`	`getStringLines(String key)` Deprecated. Value is split by carriage returns.
`boolean`	`hasDefaultValue(String key)` Deprecated.
`boolean`	`hasKey(String key)` Deprecated.
`protected abstract void`	`remove(String key)` Deprecated.
`Settings`	`removeProperty(String key)` Deprecated.
`protected abstract void`	`set(String key, String value)` Deprecated. Add the settings with the specified key and value, both are trimmed and neither can be null.
`Settings`	`setProperty(String key, Boolean value)` Deprecated.
`Settings`	`setProperty(String key, Date date)` Deprecated.
`Settings`	`setProperty(String key, Date date, boolean includeTime)` Deprecated.
`Settings`	`setProperty(String key, Double value)` Deprecated.
`Settings`	`setProperty(String key, Float value)` Deprecated.
`Settings`	`setProperty(String key, Integer value)` Deprecated.
`Settings`	`setProperty(String key, Long value)` Deprecated.
`Settings`	`setProperty(String key, String value)` Deprecated. Change a property value in a restricted scope only, depending on execution context.
`Settings`	`setProperty(String key, String[] values)` Deprecated.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Settings
```
protected Settings(PropertyDefinitions definitions,
                   Encryption encryption)
```
    Deprecated.
- Method Detail
  - get
```
protected abstract Optional<String> get(String key)
```
    Deprecated.
  - set
```
protected abstract void set(String key,
                            String value)
```
    Deprecated.
    
    Add the settings with the specified key and value, both are trimmed and neither can be null.
    
    Throws:
    
    NullPointerException - if key and/or value is null.
  - remove
```
protected abstract void remove(String key)
```
    Deprecated.
  - getProperties
```
public abstract Map<String,String> getProperties()
```
    Deprecated.
    
    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 getRawString(String) are returned.
    Values are not decrypted if they are encrypted with a secret key.
  - getEncryption
```
public Encryption getEncryption()
```
    Deprecated.
  - getRawString
```
public Optional<String> getRawString(String key)
```
    Deprecated.
    
    The value that overrides the default value. It may be encrypted with a secret key. Use getString(String) to get the effective and decrypted value.
    
    Since:
    
    6.1
  - getDefinitions
```
public PropertyDefinitions getDefinitions()
```
    Deprecated.
    
    All the property definitions declared by core and plugins.
  - getDefinition
```
public Optional<PropertyDefinition> getDefinition(String key)
```
    Deprecated.
    
    The definition related to the specified property. It may be empty.
    
    Since:
    
    6.1
  - hasKey
```
public boolean hasKey(String key)
```
    Deprecated.
    
    Returns:
    
    true if the property has a non-default value, else false.
  - getDefaultValue
```
@CheckForNull
public String getDefaultValue(String key)
```
    Deprecated.
  - hasDefaultValue
```
public boolean hasDefaultValue(String key)
```
    Deprecated.
  - getString
```
@CheckForNull
public String getString(String key)
```
    Deprecated.
    
    The effective value of the specified property. Can return null if the property is not set and has no defined default value.
    If the property is encrypted with a secret key, then the returned value is decrypted.
    
    Throws:
    
    IllegalStateException - if value is encrypted but fails to be decrypted.
  - getBoolean
```
public boolean getBoolean(String key)
```
    Deprecated.
    
    Effective value as boolean. It is false if getString(String) does not return "true", even if it's not a boolean representation.
    
    Returns:
    
    true if the effective value is "true", else false.
  - getInt
```
public int getInt(String key)
```
    Deprecated.
    
    Effective value as int.
    
    Returns:
    
    the value as int. If the property does not have value nor default value, then 0 is returned.
    
    Throws:
    
    NumberFormatException - if value is not empty and is not a parsable integer
  - getLong
```
public long getLong(String key)
```
    Deprecated.
    
    Effective value as long.
    
    Returns:
    
    the value as long. If the property does not have value nor default value, then 0L is returned.
    
    Throws:
    
    NumberFormatException - if value is not empty and is not a parsable long
  - getDate
```
@CheckForNull
public Date getDate(String key)
```
    Deprecated.
    
    Effective value as Date, without time fields. Format is DateUtils.DATE_FORMAT.
    
    Returns:
    
    the value as a Date. If the property does not have value nor default value, then null is returned.
    
    Throws:
    
    RuntimeException - if value is not empty and is not in accordance with DateUtils.DATE_FORMAT.
  - getDateTime
```
@CheckForNull
public Date getDateTime(String key)
```
    Deprecated.
    
    Effective value as Date, with time fields. Format is DateUtils.DATETIME_FORMAT.
    
    Returns:
    
    the value as a Date. If the property does not have value nor default value, then null is returned.
    
    Throws:
    
    RuntimeException - if value is not empty and is not in accordance with DateUtils.DATETIME_FORMAT.
  - getFloat
```
@CheckForNull
public Float getFloat(String key)
```
    Deprecated.
    
    Effective value as Float.
    
    Returns:
    
    the value as Float. If the property does not have value nor default value, then null is returned.
    
    Throws:
    
    NumberFormatException - if value is not empty and is not a parsable number
  - getDouble
```
@CheckForNull
public Double getDouble(String key)
```
    Deprecated.
    
    Effective value as Double.
    
    Returns:
    
    the value as Double. If the property does not have value nor default value, then null is returned.
    
    Throws:
    
    NumberFormatException - if value is not empty and is not a parsable number
  - getStringArray
```
public String[] getStringArray(String key)
```
    Deprecated.
    Value is split by comma and trimmed. Never returns null.
    Examples :
    - "one,two,three " -> ["one", "two", "three"]
    - " one, two, three " -> ["one", "two", "three"]
    - "one, , three" -> ["one", "", "three"]
  - getStringLines
```
public String[] getStringLines(String key)
```
    Deprecated.
    
    Value is split by carriage returns.
    
    Returns:
    
    non-null array of lines. The line termination characters are excluded.
    
    Since:
    
    3.2
  - getStringArrayBySeparator
```
public String[] getStringArrayBySeparator(String key,
                                          String separator)
```
    Deprecated.
    
    Value is split and trimmed.
  - appendProperty
```
public Settings appendProperty(String key,
                               @Nullable
                               String value)
```
    Deprecated.
  - setProperty
```
public Settings setProperty(String key,
                            @Nullable
                            String[] values)
```
    Deprecated.
  - setProperty
```
public Settings setProperty(String key,
                            @Nullable
                            String value)
```
    Deprecated.
    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
  - setProperty
```
public Settings setProperty(String key,
                            @Nullable
                            Boolean value)
```
    Deprecated.
    
    See Also:
    
    setProperty(String, String)
  - setProperty
```
public Settings setProperty(String key,
                            @Nullable
                            Integer value)
```
    Deprecated.
    
    See Also:
    
    setProperty(String, String)
  - setProperty
```
public Settings setProperty(String key,
                            @Nullable
                            Long value)
```
    Deprecated.
    
    See Also:
    
    setProperty(String, String)
  - setProperty
```
public Settings setProperty(String key,
                            @Nullable
                            Double value)
```
    Deprecated.
    
    See Also:
    
    setProperty(String, String)
  - setProperty
```
public Settings setProperty(String key,
                            @Nullable
                            Float value)
```
    Deprecated.
    
    See Also:
    
    setProperty(String, String)
  - setProperty
```
public Settings setProperty(String key,
                            @Nullable
                            Date date)
```
    Deprecated.
    
    See Also:
    
    setProperty(String, String)
  - addProperties
```
public Settings addProperties(Map<String,String> props)
```
    Deprecated.
  - addProperties
```
public Settings addProperties(Properties props)
```
    Deprecated.
  - setProperty
```
public Settings setProperty(String key,
                            @Nullable
                            Date date,
                            boolean includeTime)
```
    Deprecated.
    
    See Also:
    
    setProperty(String, String)
  - removeProperty
```
public Settings removeProperty(String key)
```
    Deprecated.
  - getKeysStartingWith
```
public List<String> getKeysStartingWith(String prefix)
```
    Deprecated.

Class Settings

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Settings

Method Detail

get

set

remove

getProperties

getEncryption

getRawString

getDefinitions

getDefinition

hasKey

getDefaultValue

hasDefaultValue

getString

getBoolean

getInt

getLong

getDate

getDateTime

getFloat

getDouble

getStringArray

getStringLines

getStringArrayBySeparator

appendProperty

setProperty

setProperty

setProperty

setProperty

setProperty

setProperty

setProperty

setProperty

addProperties

addProperties

setProperty

removeProperty

getKeysStartingWith