org.sonar.api.config

Class PropertyDefinitions

java.lang.Object

org.sonar.api.config.PropertyDefinitions

@ScannerSide
 @ServerSide
 @ComputeEngineSide
public final class PropertyDefinitions
extends Object

Metadata of all the properties declared by plugins

Since:

2.12

Constructor Summary

Constructors

Constructor and Description
PropertyDefinitions(Collection<PropertyDefinition> components)
PropertyDefinitions(Object... components)

Method Summary

Modifier and Type	Method and Description
PropertyDefinitions	addComponent(Object object)
PropertyDefinitions	addComponent(Object component, String defaultCategory)
PropertyDefinitions	addComponents(Collection components)
PropertyDefinitions	addComponents(Collection components, String defaultCategory)
PropertyDefinition	get(String key)
Collection<PropertyDefinition>	getAll()
String	getCategory(Property prop)
String	getCategory(String key)
String	getDefaultValue(String key)
String	getDeprecatedKey(String key)
String	getNewKey(String deprecatedKey)
String	getSubCategory(String key)
Map<Category,Map<SubCategory,Collection<PropertyDefinition>>>	propertiesByCategory(String qualifier)
String	validKey(String key)

Methods inherited from class java.lang.Object

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

Constructor Detail

PropertyDefinitions

public PropertyDefinitions(Object... components)

PropertyDefinitions

public PropertyDefinitions(Collection<PropertyDefinition> components)

Method Detail

addComponents

public PropertyDefinitions addComponents(Collection components)

addComponents

public PropertyDefinitions addComponents(Collection components,
                                         String defaultCategory)

addComponent

public PropertyDefinitions addComponent(Object object)

addComponent

public PropertyDefinitions addComponent(Object component,
                                        String defaultCategory)

get

public PropertyDefinition get(String key)

getAll

public Collection<PropertyDefinition> getAll()

validKey

public String validKey(String key)

propertiesByCategory

public Map<Category,Map<SubCategory,Collection<PropertyDefinition>>> propertiesByCategory(@Nullable
                                                                                          String qualifier)

Since:

3.7

getDefaultValue

public String getDefaultValue(String key)

getCategory

public String getCategory(String key)

getSubCategory

public String getSubCategory(String key)

getCategory

public String getCategory(Property prop)

getNewKey

public String getNewKey(String deprecatedKey)

getDeprecatedKey

public String getDeprecatedKey(String key)