Deprecated API

Contents

• Deprecated Interfaces
• Deprecated Classes
• Deprecated Enums
• Deprecated Fields
• Deprecated Methods
• Deprecated Constructors

Deprecated Interfaces

org.sonar.api.utils.KeyValueFormat.Transformer
since 2.7. Replaced by Converter

Deprecated Classes

org.sonar.api.batch.AbstractCoverageExtension
since 2.6 was superseded by interface CoverageExtension

org.sonar.api.web.AbstractDashboardWidget
override org.sonar.api.web.AbstractRubyTemplate and implement org.sonar.api.web.RubyRailsWidget

org.sonar.api.batch.AbstractDirectoriesDecorator
since 2.2, the number of directories is automatically calculated by sonar core (see metric formula)

org.sonar.api.batch.AbstractFileComplexityDecorator
since 2.1, a formula has been implemented on the metric, so no need to have decorator anymore

org.sonar.api.batch.AbstractFilesDecorator
since 2.2, the number of files is automatically calculated by sonar core (see metric formula)

org.sonar.api.batch.AbstractFunctionComplexityDecorator
since 2.1, a formula has been implemented on the metric, so no need to have decorator anymore

org.sonar.api.batch.AbstractFunctionComplexityDistributionDecorator
since 2.1, a formula has been implemented on the metric, so no need to have decorator anymore

org.sonar.api.web.gwt.client.AbstractPage
since 2.0, use the lib sonar-gwt-api

org.sonar.api.web.gwt.client.webservices.AbstractResourceQuery
since 2.5

org.sonar.api.web.gwt.client.webservices.FileSource
since 2.5, use org.sonar.wsclient.services.Source instead.

org.sonar.api.rules.Iso9126RulesCategories
since 2.5. See http://jira.codehaus.org/browse/SONAR-2007

org.sonar.api.utils.KeyValueFormat.DoubleNumbersPairTransformer
since 2.7. Replaced by Converter

org.sonar.api.utils.KeyValueFormat.IntegerNumbersPairTransformer
since 2.7. Replaced by Converter

org.sonar.api.utils.KeyValueFormat.RulePriorityNumbersPairTransformer
since 2.7. Replaced by Converter

org.sonar.api.utils.KeyValueFormat.StringNumberPairTransformer
since 2.7 replaced by Converter

org.sonar.api.web.gwt.client.webservices.Measure
since 2.5, use org.sonar.wsclient.services.Measure instead.

org.sonar.api.web.gwt.client.webservices.MetricsQuery
since 2.5, use org.sonar.wsclient.services.MetricQuery instead.

org.sonar.api.Plugins
since 2.1

org.sonar.api.web.gwt.client.webservices.Properties
since 2.5

org.sonar.api.web.gwt.client.webservices.PropertiesQuery
since 2.5, use org.sonar.wsclient.services.PropertyQuery instead.

org.sonar.api.web.gwt.client.webservices.Property
since 2.5, use org.sonar.wsclient.services.Property instead

org.sonar.api.web.gwt.client.webservices.Resource
since 2.5, use org.sonar.wsclient.services.Resource instead.

org.sonar.api.web.gwt.client.webservices.Resources
since 2.5

org.sonar.api.web.gwt.client.webservices.ResourcesQuery
since 2.5, use org.sonar.wsclient.services.ResourceQuery instead

org.sonar.api.web.gwt.client.webservices.Rule
since 2.5

org.sonar.api.rules.RulesCategory
since 2.5 See http://jira.codehaus.org/browse/SONAR-2007

org.sonar.api.utils.ServerHttpClient
use org.sonar.api.plaform.Server instead

org.sonar.api.web.gwt.client.webservices.SourcesQuery
since 2.5, use org.sonar.wsclient.services.SourceQuery instead

org.sonar.api.web.gwt.client.webservices.Violation
since 2.5, use org.sonar.wsclient.services.Violation instead.

org.sonar.api.web.gwt.client.webservices.Violations
since 2.5

org.sonar.api.web.gwt.client.webservices.ViolationsQuery
since 2.5, use org.sonar.wsclient.services.ViolationQuery instead.

Deprecated Enums

org.sonar.api.web.Section
add annotation org.sonar.api.web.NavigationSection to View extensions

Deprecated Fields

org.sonar.api.measures.CoreMetrics.BRANCH_COVERAGE_HITS_DATA
since 2.7 replaced by metrics CONDITIONS_BY_LINE and COVERED_CONDITIONS_BY_LINE

org.sonar.api.measures.CoreMetrics.BRANCH_COVERAGE_HITS_DATA_KEY
since 2.7. Replaced by COVERED_CONDITIONS_BY_LINE_KEY and COVERED_CONDITIONS_BY_LINE_KEY

org.sonar.api.batch.AbstractSourceImporter.DEFAULT_IMPORT_SOURCES
replaced by CoreProperties.CORE_IMPORT_SOURCES_DEFAULT_VALUE since 1.11

org.sonar.api.measures.CoreMetrics.DOMAIN_RULE_CATEGORIES
since 2.5 See http://jira.codehaus.org/browse/SONAR-2007

org.sonar.api.measures.CoreMetrics.EFFICIENCY
since 2.5 See http://jira.codehaus.org/browse/SONAR-2007

org.sonar.api.measures.CoreMetrics.EFFICIENCY_KEY
since 2.5 See http://jira.codehaus.org/browse/SONAR-2007

org.sonar.api.batch.AbstractSourceImporter.KEY_IMPORT_SOURCES
replaced by CoreProperties.CORE_IMPORT_SOURCES_PROPERTY since 1.11

org.sonar.api.measures.CoreMetrics.MAINTAINABILITY
since 2.5 See http://jira.codehaus.org/browse/SONAR-2007

org.sonar.api.measures.CoreMetrics.MAINTAINABILITY_KEY
since 2.5 See http://jira.codehaus.org/browse/SONAR-2007

org.sonar.api.resources.Project.PARAM_DATE
since version 1.11. Constant moved to CoreProperties

org.sonar.api.resources.Project.PARAM_DYNAMIC_ANALYSIS
since version 1.11. Constant moved to CoreProperties

org.sonar.api.resources.Project.PARAM_EXCLUSIONS
since version 1.11. Constant moved to CoreProperties

org.sonar.api.resources.Project.PARAM_LANGUAGE
since version 1.11. Constant moved to CoreProperties

org.sonar.api.resources.Project.PARAM_REUSE_RULES_CONFIG
since version 1.11. Constant moved to CoreProperties

org.sonar.api.resources.Project.PARAM_VERSION
since version 1.11. Constant moved to CoreProperties

org.sonar.api.measures.CoreMetrics.PORTABILITY
since 2.5 See http://jira.codehaus.org/browse/SONAR-2007

org.sonar.api.measures.CoreMetrics.PORTABILITY_KEY
since 2.5 See http://jira.codehaus.org/browse/SONAR-2007

org.sonar.api.resources.Resource.QUALIFIER_CLASS
since 2.6. Use Qualifiers.CLASS.

org.sonar.api.resources.Resource.QUALIFIER_DIRECTORY
since 2.6. Use Qualifiers.DIRECTORY.

org.sonar.api.resources.Resource.QUALIFIER_FIELD
since 2.6. Use Qualifiers.FIELD.

org.sonar.api.resources.Resource.QUALIFIER_FILE
since 2.6. Use Qualifiers.FILE.

org.sonar.api.resources.Resource.QUALIFIER_LIB
since 2.6. Use Qualifiers.LIBRARY.

org.sonar.api.resources.Resource.QUALIFIER_METHOD
since 2.6. Use Qualifiers.METHOD.

org.sonar.api.resources.Resource.QUALIFIER_MODULE
since 2.6. Use Qualifiers.MODULE.

org.sonar.api.resources.Resource.QUALIFIER_PACKAGE
since 2.6. Use Qualifiers.PACKAGE.

org.sonar.api.resources.Resource.QUALIFIER_PROJECT
since 2.6. Use Qualifiers.PROJECT.

org.sonar.api.web.gwt.client.webservices.Resource.QUALIFIER_PROJECT_BRANCH

org.sonar.api.web.gwt.client.webservices.Resource.QUALIFIER_PROJECT_TRUNK

org.sonar.api.resources.Resource.QUALIFIER_SUBVIEW
since 2.6. Use Qualifiers.SUBVIEW.

org.sonar.api.resources.Resource.QUALIFIER_UNIT_TEST_CLASS
since 2.6. Use Qualifiers.UNIT_TEST_FILE.

org.sonar.api.resources.Resource.QUALIFIER_VIEW
since 2.6. Use Qualifiers.VIEW.

org.sonar.api.measures.CoreMetrics.RELIABILITY
since 2.5 See http://jira.codehaus.org/browse/SONAR-2007

org.sonar.api.measures.CoreMetrics.RELIABILITY_KEY
since 2.5 See http://jira.codehaus.org/browse/SONAR-2007

org.sonar.api.CoreProperties.REUSE_RULES_CONFIGURATION_PROPERTY
since 2.5. See discussion from http://jira.codehaus.org/browse/SONAR-1873

org.sonar.api.web.gwt.client.webservices.Resource.SCOPE_DIRECTORY

org.sonar.api.resources.Resource.SCOPE_ENTITY
since 2.6. Use Scopes.FILE.

org.sonar.api.web.gwt.client.webservices.Resource.SCOPE_FILE

org.sonar.api.web.gwt.client.webservices.Resource.SCOPE_PROJECT

org.sonar.api.resources.Resource.SCOPE_SET
since 2.6. Use Scopes.PROJECT.

org.sonar.api.resources.Resource.SCOPE_SPACE
since 2.6. Use Scopes.DIRECTORY.

org.sonar.api.measures.CoreMetrics.USABILITY
since 2.5 See http://jira.codehaus.org/browse/SONAR-2007

org.sonar.api.measures.CoreMetrics.USABILITY_KEY
since 2.5 See http://jira.codehaus.org/browse/SONAR-2007

org.sonar.api.web.UserRole.VIEWER
use the constant USER since 1.12.

Deprecated Methods

org.sonar.api.batch.SonarIndex.addResource(Resource)
since 2.6. Use methods index()

org.sonar.api.resources.ProjectFileSystem.addSourceDir(File)
since 2.6 - ProjectFileSystem should be immutable See http://jira.codehaus.org/browse/SONAR-2126

org.sonar.api.resources.DefaultProjectFileSystem.addSourceDir(File)
since 2.6, because should be immutable

org.sonar.api.resources.ProjectFileSystem.addTestDir(File)
since 2.6 - ProjectFileSystem should be immutable See http://jira.codehaus.org/browse/SONAR-2126

org.sonar.api.resources.DefaultProjectFileSystem.addTestDir(File)
since 2.6, because should be immutable

org.sonar.api.measures.RuleMeasure.createForCategory(Metric, Integer, Double)
since 2.5 See http://jira.codehaus.org/browse/SONAR-2007

org.sonar.api.web.gwt.client.webservices.ResourcesQuery.filterOnRuleCategories(boolean)
since 2.5 See http://jira.codehaus.org/browse/SONAR-2007

org.sonar.api.utils.KeyValueFormat.format(Bag)
use Multiset from google collections instead of commons-collections bags

org.sonar.api.utils.KeyValueFormat.format(Bag, int)
use Multiset from google collections instead of commons-collections bags

org.sonar.api.profiles.RulesProfile.getActiveRulesByPlugin(String)
since 2.3 use RulesProfile.getActiveRulesByRepository(String) instead.

org.sonar.api.resources.Project.getArtifactId()
since 2.5. See http://jira.codehaus.org/browse/SONAR-2011

org.sonar.api.web.gwt.client.webservices.ViolationsQuery.getCategories()
since 2.5 See http://jira.codehaus.org/browse/SONAR-2007

org.sonar.api.web.gwt.client.webservices.Rule.getCategory()
since 2.5 See http://jira.codehaus.org/browse/SONAR-2007

org.sonar.api.rules.Rule.getCategoryId()
since 2.5 See http://jira.codehaus.org/browse/SONAR-2007

org.sonar.api.Plugin.getDescription()
since 2.2. The description must be set in the manifest.

org.sonar.api.resources.Project.getGroupId()
since 2.5. See http://jira.codehaus.org/browse/SONAR-2011

org.sonar.api.resources.ProjectFileSystem.getJavaSourceFiles()
since 2.6 use ProjectFileSystem.mainFiles(String...) instead. See http://jira.codehaus.org/browse/SONAR-2126

org.sonar.api.resources.DefaultProjectFileSystem.getJavaSourceFiles()

org.sonar.api.resources.ProjectUtils.getJavaSourceVersion(Project)
since 2.6 use JavaUtils.getSourceVersion() instead.

org.sonar.api.resources.ProjectUtils.getJavaVersion(Project)
since 2.6 use JavaUtils.getTargetVersion() instead.

org.sonar.api.Plugin.getKey()
since 2.2. The key must be set in the manifest.

org.sonar.api.database.model.RuleFailureModel.getLevel()
since 2.7. Replace by getPriority()

org.sonar.api.Plugin.getName()
since 2.2. The name must be set in the manifest.

org.sonar.api.platform.PluginRepository.getPluginForExtension(Object)
since 2.3

org.sonar.api.rules.Rule.getPluginName()
since 2.5 use Rule.getRepositoryKey() instead

org.sonar.api.rules.ActiveRule.getPluginName()
since 2.3 use ActiveRule.getRepositoryKey() instead

org.sonar.api.resources.Project.getPom()
since 2.5. See http://jira.codehaus.org/browse/SONAR-2011 , MavenProject can be retrieved as an IoC dependency

org.sonar.api.rules.Violation.getPriority()
since 2.5 use Violation.getSeverity() instead. See http://jira.codehaus.org/browse/SONAR-1829

org.sonar.api.rules.Rule.getPriority()
since 2.5 use Rule.getSeverity() instead. See http://jira.codehaus.org/browse/SONAR-1829

org.sonar.api.rules.ActiveRule.getPriority()
since 2.5 use ActiveRule.getSeverity() instead. See http://jira.codehaus.org/browse/SONAR-1829

org.sonar.api.resources.Project.getReuseExistingRulesConfig()
since 2.5. See discussion from http://jira.codehaus.org/browse/SONAR-1873

org.sonar.api.measures.RuleMeasure.getRuleCategory()
since 2.5 See http://jira.codehaus.org/browse/SONAR-2007

org.sonar.api.web.gwt.client.webservices.Measure.getRuleCategory()
since 2.5 See http://jira.codehaus.org/browse/SONAR-2007

org.sonar.api.rules.Rule.getRulesCategory()
since 2.5 See http://jira.codehaus.org/browse/SONAR-2007

org.sonar.api.database.model.MeasureModel.getRulesCategoryId()
since 2.5 See http://jira.codehaus.org/browse/SONAR-2007

org.sonar.api.resources.ProjectFileSystem.getSourceFiles(Language...)
since 2.6 use ProjectFileSystem.mainFiles(String...) instead. See http://jira.codehaus.org/browse/SONAR-2126

org.sonar.api.resources.DefaultProjectFileSystem.getSourceFiles(Language...)

org.sonar.api.resources.ProjectFileSystem.getTestFiles(Language...)
since 2.6 use ProjectFileSystem.testFiles(String...) instead. See http://jira.codehaus.org/browse/SONAR-2126

org.sonar.api.resources.DefaultProjectFileSystem.getTestFiles(Language...)

org.sonar.api.resources.ProjectFileSystem.hasJavaSourceFiles()
since 2.6 - API should be language agnostic

org.sonar.api.resources.ProjectFileSystem.hasTestFiles(Language)
since 2.6 - use language key instead of Language object

org.sonar.api.resources.DefaultProjectFileSystem.hasTestFiles(Language)

org.sonar.api.resources.Resource.isExcluded()
since 2.6 should use SensorContext#isExcluded(resource). It will make inheritance of Resource easier.

org.sonar.api.utils.KeyValueFormat.parse(String, KeyValueFormat.Transformer)
since 2.7

org.sonar.api.measures.MeasuresFilters.ruleCategories(Metric)
since 2.5. See http://jira.codehaus.org/browse/SONAR-2007

org.sonar.api.measures.MeasuresFilters.ruleCategory(Metric, Integer)
since 2.5. See http://jira.codehaus.org/browse/SONAR-2007

org.sonar.api.batch.SensorContext.saveResource(Resource)
use the methods index()

org.sonar.api.rules.ActiveRuleParam.setActiveRule(ActiveRule)
visibility should be decreased to protected or package

org.sonar.api.rules.ActiveRule.setActiveRuleParams(List)
use setParameter()

org.sonar.api.web.gwt.client.webservices.ViolationsQuery.setCategories(String)
since 2.5 See http://jira.codehaus.org/browse/SONAR-2007

org.sonar.api.resources.Resource.setExcluded(boolean)
since 2.6 should use SensorContext#isExcluded(resource). It will make inheritance of Resource easier.

org.sonar.api.resources.Project.setFileSystem(ProjectFileSystem)
since 2.6. See http://jira.codehaus.org/browse/SONAR-2126

org.sonar.api.rules.Rule.setId(Integer)
since 2.3. visibility should be decreased to protected or package

org.sonar.api.rules.ActiveRule.setId(Integer)
visibility should be decreased to protected or package

org.sonar.api.database.model.RuleFailureModel.setLevel(RulePriority)
since 2.7. Replace by setPriority()

org.sonar.api.rules.Rule.setPluginName(String)
since 2.5 use Rule.setRepositoryKey(String) instead

org.sonar.api.rules.Violation.setPriority(RulePriority)
since 2.5 use Violation.setSeverity(RulePriority) instead. See http://jira.codehaus.org/browse/SONAR-1829

org.sonar.api.rules.Rule.setPriority(RulePriority)
since 2.5 use Rule.setSeverity(RulePriority) instead. See http://jira.codehaus.org/browse/SONAR-1829

org.sonar.api.rules.ActiveRule.setPriority(RulePriority)
since 2.5 use ActiveRule.setSeverity(RulePriority) instead. See http://jira.codehaus.org/browse/SONAR-1829

org.sonar.api.rules.ActiveRule.setRule(Rule)
visibility should be reduced to protected or package

org.sonar.api.web.gwt.client.webservices.ResourcesQuery.setRuleCategories(String)
since 2.5 See http://jira.codehaus.org/browse/SONAR-2007

org.sonar.api.measures.RuleMeasure.setRuleCategory(Integer)
since 2.5 See http://jira.codehaus.org/browse/SONAR-2007

org.sonar.api.rules.ActiveRuleParam.setRuleParam(RuleParam)
visibility should be decreased to protected or package

org.sonar.api.rules.Rule.setRulesCategory(RulesCategory)
since 2.5 See http://jira.codehaus.org/browse/SONAR-2007

org.sonar.api.database.model.MeasureModel.setRulesCategoryId(Integer)
since 2.5 See http://jira.codehaus.org/browse/SONAR-2007

org.sonar.api.rules.ActiveRule.setRulesProfile(RulesProfile)
visibility should be reduced to protected or package

Deprecated Constructors

org.sonar.api.batch.AbstractCoverageExtension(Plugins)
since 2.3. Use the default constructor

org.sonar.api.rules.ActiveRule()
visibility should be reduced to protected or package

org.sonar.api.rules.ActiveRule(RulesProfile, Rule, RulePriority)
visibility should be reduced to protected or package

org.sonar.api.rules.ActiveRuleParam()
visibility should be decreased to protected or package

org.sonar.api.rules.ActiveRuleParam(ActiveRule, RuleParam, String)
visibility should be decreased to protected or package

org.sonar.api.batch.Event(String, String, String, Date, Integer)

org.sonar.api.batch.Event(String, String, String, Snapshot)

org.sonar.api.measures.Metric()

org.sonar.api.measures.Metric(String)
since 2.7 use the Builder factory.

org.sonar.api.measures.Metric(String, Metric.ValueType)
since 2.7 use the Builder factory.

org.sonar.api.measures.Metric(String, String, Metric.ValueType, Integer, Boolean, String, Formula)
since 2.7 use the Builder factory.

org.sonar.api.measures.Metric(String, String, String, Metric.ValueType, Integer, Boolean, String)
since 2.7 use the Builder factory.

org.sonar.api.measures.Metric(String, String, String, Metric.ValueType, Integer, Boolean, String, boolean)
since 2.7 use the Builder factory.

org.sonar.api.rules.Rule()
since 2.3. Use the factory method Rule.create()

org.sonar.api.rules.Rule(String, String)
since 2.3. Use the factory method Rule.create()

org.sonar.api.rules.Rule(String, String, RulesCategory, String, String)
since 2.3. Use the factory method Rule.create()

org.sonar.api.rules.Rule(String, String, String, RulesCategory, RulePriority)
since 2.3. Use the factory method Rule.create()

org.sonar.api.rules.Rule(String, String, String, RulesCategory, String, String)
since 2.3. Use the factory method Rule.create()

org.sonar.api.rules.RuleParam()
since 2.3 use the factory method Rule.setParameter()

org.sonar.api.rules.RuleParam(Rule, String, String, String)
since 2.3 use the factory method setParameter()

org.sonar.api.profiles.RulesProfile()
use the factory method create()

org.sonar.api.profiles.RulesProfile(String, String)
since 2.3. Use the factory method create()

org.sonar.api.profiles.RulesProfile(String, String, boolean, boolean)
since 2.3. Use the factory method create()

org.sonar.api.rules.Violation(Rule)
since 2.3. Use the factory method create()

org.sonar.api.rules.Violation(Rule, Resource)
since 2.3. Use the factory method create()

org.sonar.api.profiles.XMLProfileParser(RuleFinder)
since 2.5. Plugins shouldn't directly instantiate this class, because it should be retrieved as an IoC dependency.

org.sonar.api.profiles.XMLProfileParser(RuleFinder, MetricFinder)
since 2.5. Plugins shouldn't directly instantiate this class, because it should be retrieved as an IoC dependency.