org.sonar.api.config
Class PropertyDefinitions

java.lang.Object
  org.sonar.api.config.PropertyDefinitions

All Implemented Interfaces:

BatchComponent, ServerComponent

public final class PropertyDefinitions
extends Object
implements BatchComponent, ServerComponent

Metadata of all the properties declared by plugins

Since:

2.12

Constructor Summary

PropertyDefinitions(Object... components)

Method Summary

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)
Map<String,Collection<PropertyDefinition>>	getGlobalPropertiesByCategory() since 3.3
Map<String,Collection<PropertyDefinition>>	getModulePropertiesByCategory() since 3.3
Map<String,Collection<PropertyDefinition>>	getProjectPropertiesByCategory() since 3.3

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)

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()

getGlobalPropertiesByCategory

public Map<String,Collection<PropertyDefinition>> getGlobalPropertiesByCategory()

since 3.3

getProjectPropertiesByCategory

public Map<String,Collection<PropertyDefinition>> getProjectPropertiesByCategory()

since 3.3

getModulePropertiesByCategory

public Map<String,Collection<PropertyDefinition>> getModulePropertiesByCategory()

since 3.3

getDefaultValue

public String getDefaultValue(String key)

getCategory

public String getCategory(String key)

getCategory

public String getCategory(Property prop)