Deprecated List (SonarQube :: Plugin API 6.0 API)

Deprecated Interfaces
Interface and Description
org.sonar.api.BatchComponent since 5.2 use `ScannerSide` annotation
org.sonar.api.BatchExtension since 5.2 replaced by `ScannerSide` and `ExtensionPoint` annotations
org.sonar.api.batch.CheckProject since 5.6
org.sonar.api.component.Component since 5.2
org.sonar.api.test.CoverageBlock since 5.6. Feature will be removed without any alternatives.
org.sonar.api.batch.CoverageExtension since 5.2 not used anymore
org.sonar.api.batch.CpdMapping since 5.5 use `SensorContext.newCpdTokens()`
org.sonar.api.server.debt.DebtCharacteristic in 5.2. It will be dropped in version 6.0 (see https://jira.sonarsource.com/browse/SONAR-6393)
org.sonar.api.batch.debt.DebtCharacteristic since 5.1 debt model will soon be unavailable on batch side
org.sonar.api.server.debt.DebtModel in 5.2. It will be dropped in version 6.0 (see https://jira.sonarsource.com/browse/SONAR-6393)
org.sonar.api.batch.debt.DebtModel since 5.1 debt model will soon be unavailable on batch side
org.sonar.api.batch.Decorator since 5.2 there's no more decorator on batch side. Use `MeasureComputer` instead
org.sonar.api.batch.DecoratorBarriers since 5.6 as `Decorator` is deprecated
org.sonar.api.batch.DecoratorContext since 5.6 as `Decorator` is deprecated
org.sonar.api.batch.events.DecoratorExecutionHandler since 5.2 no more decorator
org.sonar.api.batch.events.DecoratorsPhaseHandler since 5.2 no more decorator
org.sonar.api.Extension since 5.2 replaced by `ExtensionPoint` annotation
org.sonar.api.scan.filesystem.FileSystemFilter since 4.2 use `InputFileFilter`
org.sonar.api.measures.Formula since 5.2 there's no more decorator on batch side, please use `MeasureComputer` instead
org.sonar.api.measures.FormulaContext since 5.2. Aggregation of measures is provided by `MeasureComputer`. `Decorator` and `Formula` are no more supported.
org.sonar.api.measures.FormulaData since 5.2. Aggregation of measures is provided by `MeasureComputer`. `Decorator` and `Formula` are no more supported.
org.sonar.api.source.Highlightable since 5.6 use `SensorContext.newHighlighting()`
org.sonar.api.batch.events.InitializerExecutionHandler since 6.0
org.sonar.api.batch.events.InitializersPhaseHandler since 6.0
org.sonar.api.issue.batch.IssueFilter since 5.3. Use `IssueFilter` instead.
org.sonar.api.issue.batch.IssueFilterChain since 5.3. Use `IssueFilterChain` instead.
org.sonar.api.security.LoginPasswordAuthenticator replaced by Authenticator in version 3.1
org.sonar.api.measures.MeasureBuilder since 5.6. To create a new measure on scanner side use `SensorContext.newMeasure()`
org.sonar.api.measures.MeasuresFilter since 5.6. Sensor should only save measures and not read them.
org.sonar.api.measures.MetricFinder since 5.1 use `MetricFinder` on scanner side.
org.sonar.api.component.Module since 5.6
org.sonar.api.scan.filesystem.ModuleFileSystem in 4.2. Replaced by `FileSystem`
org.sonar.api.test.MutableTestable since 5.6. Feature will be removed without any alternatives.
org.sonar.api.test.MutableTestCase since 5.6. Feature will be removed without any alternatives.
org.sonar.api.test.MutableTestPlan since 5.6. Feature will be removed without any alternatives.
org.sonar.api.component.Perspective since 5.2
org.sonar.api.batch.PostJob since 5.6 use org.sonar.api.batch.postjob.PostJob
org.sonar.api.batch.events.PostJobExecutionHandler since 6.0
org.sonar.api.batch.events.PostJobsPhaseHandler since 6.0
org.sonar.api.batch.events.ProjectAnalysisHandler since 6.0
org.sonar.api.component.ResourcePerspectives since 5.6 all features are available on `SensorContext`
org.sonar.api.component.RubyComponentService in 6.0
org.sonar.api.web.RubyRailsWebservice in 4.2. Replaced by `WebService`
org.sonar.api.rules.RuleFinder since 5.1. Use `ActiveRules` on batch side.
org.sonar.api.i18n.RuleI18n in 4.1. Rules are not localized anymore. See http://jira.sonarsource.com/browse/SONAR-4885
org.sonar.api.utils.Semaphores in 5.2 as batch analyzer does not connect to database anymore
org.sonar.api.batch.Sensor since 5.6 use org.sonar.api.batch.sensor.Sensor
org.sonar.api.batch.SensorContext since 5.6 use `Sensor`
org.sonar.api.batch.events.SensorExecutionHandler since 6.0
org.sonar.api.ServerComponent in 5.2. Use `ServerSide` annotation instead.
org.sonar.api.ServerExtension since 5.2. Use annotations `ServerSide` or `ComputeEngineSide` and `ExtensionPoint`
org.sonar.api.component.SourceFile since 5.6
org.sonar.api.source.Symbol since 5.6 use `SensorContext.newSymbolTable()`
org.sonar.api.source.Symbolizable since 5.6 use `SensorContext.newSymbolTable()`
org.sonar.api.task.TaskComponent since 5.1. Use `ScannerSide` and `InstantiationStrategy.PER_TASK`
org.sonar.api.task.TaskExtension since 5.1. Not used.
org.sonar.api.test.Testable since 5.2
org.sonar.api.test.TestCase since 5.2 not used
org.sonar.api.test.TestPlan since 5.2 not used
org.sonar.api.security.UserFinder since 5.1 DB access will soon be removed from batch side
org.sonar.api.user.UserFinder since 5.1 DB access will soon be removed from batch side
org.sonar.api.web.Webservice in 4.2. Replaced by `WebService`

Deprecated Classes
Class and Description
org.sonar.api.batch.AbstractCpdMapping since 5.6 use `SensorContext.newCpdTokens()`
org.sonar.api.web.AbstractDashboardWidget override org.sonar.api.web.AbstractRubyTemplate and implement org.sonar.api.web.RubyRailsWidget
org.sonar.api.batch.AbstractSumChildrenDecorator since 5.2 there's no more decorator on batch side
org.sonar.api.rules.AnnotationRuleParser in 4.2. Replaced by `RulesDefinitionAnnotationLoader`
org.sonar.api.measures.AverageFormula since 5.2. Aggregation of measures is provided by `MeasureComputer`. `Decorator` and `Formula` are no more supported.
org.sonar.api.batch.BuildBreaker since 5.6
org.sonar.api.web.CodeColorizerFormat since 4.5.2 use `Highlightable`
org.sonar.api.measures.CountDistributionBuilder since 5.6. Scanner side is not responsible to aggregate measures since 5.2.
org.sonar.api.measures.CoverageMeasuresBuilder since 5.2 use `SensorContext.newCoverage()`
org.sonar.api.batch.DefaultFormulaContext since 5.2. Aggregation of measures is provided by `MeasureComputer`. `Decorator` and `Formula` are no more supported.
org.sonar.api.batch.DefaultFormulaData since 5.2. Aggregation of measures is provided by `MeasureComputer`. `Decorator` and `Formula` are no more supported.
org.sonar.api.design.Dependency since 5.2 No more design features
org.sonar.api.resources.Directory since 5.6 replaced by `InputDir`.
org.sonar.api.ExtensionProvider since 6.0 should no more be used
org.sonar.api.resources.File since 5.6 replaced by `InputFile`.
org.sonar.api.scan.filesystem.FileQuery in 4.2. Replaced by `FileSystem` and `FilePredicate`
org.sonar.api.resources.Library since 5.2 No more design features
org.sonar.api.measures.MeanAggregationFormula since 5.2. Aggregation of measures is provided by `MeasureComputer`. `Decorator` and `Formula` are no more supported.
org.sonar.api.measures.Measure since 5.6. To create a new measure on scanner side use `SensorContext.newMeasure()`
org.sonar.api.measures.MeasuresFilters since 5.6. Sensor should only save measures and not read them.
org.sonar.api.measures.MeasureUtils since 5.6. `Measure` is deprecated.
org.sonar.api.component.mock.MockSourceFile since 5.6
org.sonar.api.scan.filesystem.PathResolver.RelativePath since 6.0 was used when component keys were relative to source dirs
org.sonar.api.resources.Project since 5.6 replaced by `InputModule`.
org.sonar.api.measures.PropertiesBuilder since 5.6. Use directly `KeyValueFormat`.
org.sonar.api.measures.RangeDistributionBuilder since 5.2 use `instead`
org.sonar.api.resources.Resource since 5.6 replaced by `InputComponent`
org.sonar.api.resources.ResourceUtils since 5.6 as `Resource` is deprecated
org.sonar.api.measures.RuleMeasure since 5.2. Ignored by design because of Compute Engine.
org.sonar.api.rules.RuleRepository in 4.2. Replaced by org.sonar.api.server.rule.RulesDefinition
org.sonar.api.server.rule.RulesDefinition.SubCharacteristics in 5.5. SQALE Quality Model is replaced by SonarQube Quality Model. See https://jira.sonarsource.com/browse/MMF-184
org.sonar.api.SonarPlugin replaced by `Plugin` in version 5.6.
org.sonar.api.utils.StaxParser since 5.6 plugins should use their own dependencies
org.sonar.api.measures.SumChildDistributionFormula since 5.2. Aggregation of measures is provided by `MeasureComputer`. `Decorator` and `Formula` are no more supported.
org.sonar.api.measures.SumChildValuesFormula since 5.2. Aggregation of measures is provided by `MeasureComputer`. `Decorator` and `Formula` are no more supported.
org.sonar.api.utils.TempFileUtils since 4.0 use `TempFolder`
org.sonar.api.utils.TimeProfiler since 5.1. Replaced by `Profiler`
org.sonar.api.measures.WeightedMeanAggregationFormula since 5.2. Aggregation of measures is provided by `MeasureComputer`. `Decorator` and `Formula` are no more supported.
org.sonar.api.utils.WorkUnit since 4.2. Use WorkDuration instead
org.sonar.api.rules.XMLRuleParser in 4.2. Replaced by org.sonar.api.server.rule.RulesDefinition and org.sonar.api.server.rule.RulesDefinitionXmlLoader
org.sonar.api.utils.XpathParser since 5.6 plugins should use their own dependencies

Deprecated Enums
Enum and Description
org.sonar.api.scan.filesystem.FileType in 4.2
org.sonar.api.measures.PersistenceMode since 5.6. No more used since 5.2.
org.sonar.api.rules.RulePriority since 4.2
org.sonar.api.web.Section add annotation org.sonar.api.web.NavigationSection to View extensions

Deprecated Exceptions
Exceptions and Description
org.sonar.api.test.exception.CoverageAlreadyExistsException since 5.6 feature will be removed soon
org.sonar.api.resources.DuplicatedSourceException since 5.6 should not be used in any API
org.sonar.api.test.exception.IllegalDurationException since 5.6 feature will be removed soon
org.sonar.api.utils.SonarException in 4.4. Use standard exceptions like `IllegalArgumentException` or `IllegalStateException`. Use `MessageException` for raising errors to end-users without displaying stackstrace.
org.sonar.api.test.exception.TestException since 5.6 feature will be removed soon
org.sonar.api.utils.XmlParserException since 5.6

Deprecated Annotation Types
Annotation Type and Description

org.sonar.api.batch.BatchSide
since 6.0. Use ScannerSide instead.

Deprecated Annotation Types
Annotation Type and Description
org.sonar.api.batch.BatchSide since 6.0. Use `ScannerSide` instead.

Deprecated Fields
Field and Description
org.sonar.api.measures.CoreMetrics.ACCESSORS since 5.0.
org.sonar.api.measures.CoreMetrics.ACCESSORS_KEY since 5.0.
org.sonar.api.CoreProperties.ANALYSIS_MODE_ANALYSIS since 5.2 the default mode is publish
org.sonar.api.CoreProperties.ANALYSIS_MODE_INCREMENTAL since 5.2
org.sonar.api.resources.Scopes.BLOCK_UNIT since 4.3 resources under FILE level are no more be supported since 4.2.
org.sonar.api.CoreProperties.CATEGORY_JAVA since 6.0
org.sonar.api.measures.CoreMetrics.CLASS_COMPLEXITY_DISTRIBUTION in 3.0 - see SONAR-3289
org.sonar.api.measures.CoreMetrics.CLASS_COMPLEXITY_DISTRIBUTION_KEY in 3.0 - see SONAR-3289
org.sonar.api.measures.CoreMetrics.COMMENTED_OUT_CODE_LINES since 4.2 - see SONAR-4990
org.sonar.api.measures.CoreMetrics.COMMENTED_OUT_CODE_LINES_KEY since 4.2 - see SONAR-4990
org.sonar.api.measures.CoreMetrics.CONDITIONS_BY_LINE since 5.2 soon to be removed
org.sonar.api.measures.CoreMetrics.CONDITIONS_BY_LINE_KEY since 5.2 soon to be removed
org.sonar.api.CoreProperties.CORE_AUTHENTICATOR_CLASS since 2.14. See http://jira.sonarsource.com/browse/SONAR-3153. Replaced by `CoreProperties.CORE_AUTHENTICATOR_REALM`.
org.sonar.api.CoreProperties.CORE_AUTHENTICATOR_LOCAL_USERS no more used since 5.5
org.sonar.api.CoreProperties.CORE_AUTHENTICATOR_UPDATE_USER_ATTRIBUTES since 5.4. This feature is not supported anymore. See http://jira.sonarsource.com/browse/SONAR-7219
org.sonar.api.CoreProperties.CORE_PREVENT_AUTOMATIC_PROJECT_CREATION replaced in 5.2 by the permission 'provisioning'
org.sonar.api.measures.CoreMetrics.COVERAGE_LINE_HITS_DATA since 5.2 soon to be removed
org.sonar.api.measures.CoreMetrics.COVERAGE_LINE_HITS_DATA_KEY since 5.2 soon to be removed
org.sonar.api.measures.CoreMetrics.COVERED_CONDITIONS_BY_LINE since 5.2 soon to be removed
org.sonar.api.measures.CoreMetrics.COVERED_CONDITIONS_BY_LINE_KEY since 5.2 soon to be removed
org.sonar.api.CoreProperties.CPD_SKIP_PROPERTY in 5.0
org.sonar.api.measures.Measure.DEFAULT_PRECISION in 5.3. Decimal scale is provided by metric, not by measure.
org.sonar.api.measures.CoreMetrics.DEPENDENCY_MATRIX since 5.0 this is an internal metric that should not be accessed by plugins
org.sonar.api.measures.CoreMetrics.DEPENDENCY_MATRIX_KEY since 5.0 this is an internal metric that should not be accessed by plugins
org.sonar.api.measures.CoreMetrics.DIRECTORY_CYCLES since 5.2 No more design features
org.sonar.api.measures.CoreMetrics.DIRECTORY_CYCLES_KEY since 5.2 No more design features
org.sonar.api.measures.CoreMetrics.DIRECTORY_EDGES_WEIGHT since 5.2 No more design features
org.sonar.api.measures.CoreMetrics.DIRECTORY_EDGES_WEIGHT_KEY since 5.2 No more design features
org.sonar.api.measures.CoreMetrics.DIRECTORY_FEEDBACK_EDGES since 5.2 No more design features
org.sonar.api.measures.CoreMetrics.DIRECTORY_FEEDBACK_EDGES_KEY since 5.2 No more design features
org.sonar.api.measures.CoreMetrics.DIRECTORY_TANGLE_INDEX since 5.2 No more design features
org.sonar.api.measures.CoreMetrics.DIRECTORY_TANGLE_INDEX_KEY since 5.2 No more design features
org.sonar.api.measures.CoreMetrics.DIRECTORY_TANGLES since 5.2 No more design features
org.sonar.api.measures.CoreMetrics.DIRECTORY_TANGLES_KEY since 5.2 No more design features
org.sonar.api.measures.CoreMetrics.DOMAIN_DUPLICATION in 5.5. Renamed to `CoreMetrics.DOMAIN_DUPLICATIONS`
org.sonar.api.measures.CoreMetrics.DOMAIN_INTEGRATION_TESTS in 5.5. Merged into `CoreMetrics.DOMAIN_COVERAGE`
org.sonar.api.measures.CoreMetrics.DOMAIN_OVERALL_TESTS in 5.5. Merged into `CoreMetrics.DOMAIN_COVERAGE`
org.sonar.api.measures.CoreMetrics.DOMAIN_TECHNICAL_DEBT in 5.5. Replaced by `CoreMetrics.DOMAIN_MAINTAINABILITY`
org.sonar.api.measures.CoreMetrics.DOMAIN_TESTS in 5.5. Merged into `CoreMetrics.DOMAIN_COVERAGE`
org.sonar.api.measures.CoreMetrics.DUPLICATIONS_DATA since 4.5. Internal storage of duplication is not an API.
org.sonar.api.measures.CoreMetrics.DUPLICATIONS_DATA_KEY since 4.5. Internal storage of duplication is not an API.
org.sonar.api.batch.DecoratorBarriers.END_OF_VIOLATION_PERSISTENCE in 3.6. Issues are persisted at the end of analysis
org.sonar.api.batch.DecoratorBarriers.END_OF_VIOLATION_TRACKING in 3.6. Replaced by `DecoratorBarriers.ISSUES_TRACKED`
org.sonar.api.batch.DecoratorBarriers.END_OF_VIOLATIONS_GENERATION in 3.6. Replaced by `DecoratorBarriers.ISSUES_ADDED`
org.sonar.api.measures.CoreMetrics.FILE_CYCLES since 5.2 No more design features
org.sonar.api.measures.CoreMetrics.FILE_CYCLES_KEY since 5.2 No more design features
org.sonar.api.measures.CoreMetrics.FILE_EDGES_WEIGHT since 5.2 No more design features
org.sonar.api.measures.CoreMetrics.FILE_EDGES_WEIGHT_KEY since 5.2 No more design features
org.sonar.api.measures.CoreMetrics.FILE_FEEDBACK_EDGES since 5.2 No more design features
org.sonar.api.measures.CoreMetrics.FILE_FEEDBACK_EDGES_KEY since 5.2 No more design features
org.sonar.api.measures.CoreMetrics.FILE_TANGLE_INDEX since 5.2 No more design features
org.sonar.api.measures.CoreMetrics.FILE_TANGLE_INDEX_KEY since 5.2 No more design features
org.sonar.api.measures.CoreMetrics.FILE_TANGLES since 5.2 No more design features
org.sonar.api.measures.CoreMetrics.FILE_TANGLES_KEY since 5.2 No more design features
org.sonar.api.measures.CoreMetrics.IT_CONDITIONS_BY_LINE since 5.2 soon to be removed
org.sonar.api.measures.CoreMetrics.IT_CONDITIONS_BY_LINE_KEY since 5.2 soon to be removed
org.sonar.api.measures.CoreMetrics.IT_COVERAGE_LINE_HITS_DATA since 5.2 soon to be removed
org.sonar.api.measures.CoreMetrics.IT_COVERAGE_LINE_HITS_DATA_KEY since 5.2 soon to be removed
org.sonar.api.measures.CoreMetrics.IT_COVERED_CONDITIONS_BY_LINE since 5.2 soon to be removed
org.sonar.api.measures.CoreMetrics.IT_COVERED_CONDITIONS_BY_LINE_KEY since 5.2 soon to be removed
org.sonar.api.resources.Qualifiers.LIBRARY since 5.2 No more design features
org.sonar.api.rule.RuleKey.MANUAL_REPOSITORY_KEY since 5.5, manual rule feature has been dropped
org.sonar.api.measures.CoreMetrics.OVERALL_CONDITIONS_BY_LINE since 5.2 soon to be removed
org.sonar.api.measures.CoreMetrics.OVERALL_CONDITIONS_BY_LINE_KEY since 5.2 soon to be removed
org.sonar.api.measures.CoreMetrics.OVERALL_COVERAGE_LINE_HITS_DATA since 5.2 soon to be removed
org.sonar.api.measures.CoreMetrics.OVERALL_COVERAGE_LINE_HITS_DATA_KEY since 5.2 soon to be removed
org.sonar.api.measures.CoreMetrics.OVERALL_COVERED_CONDITIONS_BY_LINE since 5.2 soon to be removed
org.sonar.api.measures.CoreMetrics.OVERALL_COVERED_CONDITIONS_BY_LINE_KEY since 5.2 soon to be removed
org.sonar.api.measures.CoreMetrics.PACKAGE_CYCLES since 5.0 use `CoreMetrics.DIRECTORY_CYCLES`
org.sonar.api.measures.CoreMetrics.PACKAGE_CYCLES_KEY since 5.0 use `CoreMetrics.DIRECTORY_CYCLES_KEY`
org.sonar.api.measures.CoreMetrics.PACKAGE_EDGES_WEIGHT since 5.0 use `CoreMetrics.DIRECTORY_EDGES_WEIGHT`
org.sonar.api.measures.CoreMetrics.PACKAGE_EDGES_WEIGHT_KEY since 5.0 use `CoreMetrics.DIRECTORY_EDGES_WEIGHT_KEY`
org.sonar.api.measures.CoreMetrics.PACKAGE_FEEDBACK_EDGES since 5.0 use `CoreMetrics.DIRECTORY_FEEDBACK_EDGES`
org.sonar.api.measures.CoreMetrics.PACKAGE_FEEDBACK_EDGES_KEY since 5.0 use `CoreMetrics.DIRECTORY_FEEDBACK_EDGES_KEY`
org.sonar.api.measures.CoreMetrics.PACKAGE_TANGLE_INDEX since 5.0 use `CoreMetrics.DIRECTORY_TANGLE_INDEX`
org.sonar.api.measures.CoreMetrics.PACKAGE_TANGLE_INDEX_KEY since 5.0 use `CoreMetrics.DIRECTORY_TANGLE_INDEX_KEY`
org.sonar.api.measures.CoreMetrics.PACKAGE_TANGLES since 5.0 use `CoreMetrics.DIRECTORY_TANGLES`
org.sonar.api.measures.CoreMetrics.PACKAGE_TANGLES_KEY since 5.0 use `CoreMetrics.DIRECTORY_TANGLES_KEY`
org.sonar.api.CoreProperties.PREVIEW_READ_TIMEOUT_SEC in 5.1 no more used
org.sonar.api.resources.Scopes.PROGRAM_UNIT since 4.3 resources under FILE level are no more be supported since 4.2.
org.sonar.api.CoreProperties.PROJECT_LANGUAGE_PROPERTY since 4.2 projects are now multi-language
org.sonar.api.resources.Resource.QUALIFIER_DIRECTORY since 2.6. Use Qualifiers.DIRECTORY.
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_MODULE since 2.6. Use Qualifiers.MODULE.
org.sonar.api.resources.Resource.QUALIFIER_PROJECT since 2.6. Use Qualifiers.PROJECT.
org.sonar.api.resources.Resource.QUALIFIER_SUBVIEW since 2.6. Use Qualifiers.SUBVIEW.
org.sonar.api.resources.Resource.QUALIFIER_VIEW since 2.6. Use Qualifiers.VIEW.
org.sonar.api.measures.CoreMetrics.QUALITY_PROFILES since 5.5
org.sonar.api.measures.CoreMetrics.QUALITY_PROFILES_KEY since 5.5
org.sonar.api.web.NavigationSection.RESOURCE_TAB in 4.5, as it costs too much to maintain and update.
org.sonar.api.measures.CoreMetrics.SCM_AUTHORS_BY_LINE since 5.0 SCM data will no more be stored as measures
org.sonar.api.measures.CoreMetrics.SCM_AUTHORS_BY_LINE_KEY since 5.0 SCM data will no more be stored as measures
org.sonar.api.measures.CoreMetrics.SCM_LAST_COMMIT_DATETIMES_BY_LINE since 5.0 SCM data will no more be stored as measures
org.sonar.api.measures.CoreMetrics.SCM_LAST_COMMIT_DATETIMES_BY_LINE_KEY since 5.0 SCM data will no more be stored as measures
org.sonar.api.measures.CoreMetrics.SCM_REVISIONS_BY_LINE since 5.0 SCM data will no more be stored as measures
org.sonar.api.measures.CoreMetrics.SCM_REVISIONS_BY_LINE_KEY since 5.0 SCM data will no more be stored as measures
org.sonar.api.resources.Resource.SCOPE_ENTITY since 2.6. Use Scopes.FILE.
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.CoreProperties.SERVER_BASE_URL_DEFAULT_VALUE since 5.6. This constant default value is incorrect if a host and/or a port and/or a context have been configured. The correct default value when `CoreProperties.SERVER_BASE_URL` is not set is provided by `Server.getURL()`.
org.sonar.api.CoreProperties.SIZE_METRIC no used anymore since 5.2
org.sonar.api.profiles.RulesProfile.SONAR_WAY_FINDBUGS_NAME in 4.2. Use your own constant.
org.sonar.api.profiles.RulesProfile.SONAR_WAY_NAME in 4.2. Use your own constant.
org.sonar.api.batch.DecoratorBarriers.START_VIOLATION_PERSISTENCE in 3.6. Issues are persisted at the end of analysis.
org.sonar.api.batch.DecoratorBarriers.START_VIOLATION_TRACKING in 3.6. Not required anymore.
org.sonar.api.batch.DecoratorBarriers.START_VIOLATIONS_GENERATION in 3.6. Not required anymore.
org.sonar.api.profiles.RulesProfile.SUN_CONVENTIONS_NAME in 4.2. Use your own constant.
org.sonar.api.measures.CoreMetrics.TEST_DATA since 5.2 use `MutableTestPlan`
org.sonar.api.measures.CoreMetrics.TEST_DATA_KEY since 5.2 use `MutableTestPlan`
org.sonar.api.test.TestCase.TYPE_INTEGRATION since 5.2 not used
org.sonar.api.test.TestCase.TYPE_UNIT since 5.2 not used
org.sonar.api.SonarQubeVersion.V5_5 in 6.0. Please define your own constants.
org.sonar.api.SonarQubeVersion.V5_6 in 6.0. Please define your own constants.
org.sonar.api.web.UserRole.VIEWER use the constant USER since 1.12.

Deprecated Methods
Method and Description
org.sonar.api.issue.Issue.actionPlanKey() since 5.5 Action plans are dropped in 5.5. This field has no effect
org.sonar.api.batch.rule.Checks.addAnnotatedChecks(Collection) since 5.2 use `Checks.addAnnotatedChecks(Iterable)`
org.sonar.api.issue.NoSonarFilter.addComponent(String, Set<Integer>) since 5.0 use `NoSonarFilter.noSonarInFile(InputFile, Set)`
org.sonar.api.resources.ResourceType.Builder.availableForFilters() since 3.0. Use `ResourceType.Builder.setProperty(String, String)` with "supportsMeasureFilters" set to "true".
org.sonar.api.scan.filesystem.ModuleFileSystem.binaryDirs() since 4.2 sonar.binaries will be converted to java specific property
org.sonar.api.batch.bootstrap.ProjectBuilder.build(ProjectReactor) since 3.7 override `ProjectBuilder.build(Context)` instead
org.sonar.api.server.debt.DebtRemediationFunction.coefficient() since 5.5, replaced by `DebtRemediationFunction.gapMultiplier()`
org.sonar.api.server.debt.internal.DefaultDebtRemediationFunction.coefficient() since 5.5, replaced by `DefaultDebtRemediationFunction.gapMultiplier`
org.sonar.api.utils.Paging.create(int, int, int) since 5.2 please use the forPageIndex(...) builder method
org.sonar.api.resources.File.create(String) since 5.1 use `FileSystem.inputFile(org.sonar.api.batch.fs.FilePredicate)`
org.sonar.api.resources.Directory.create(String) since 5.1 use `FileSystem.inputDir(java.io.File)`
org.sonar.api.resources.File.create(String, Language, boolean) since 5.1 use `FileSystem.inputFile(org.sonar.api.batch.fs.FilePredicate)`
org.sonar.api.measures.RuleMeasure.createForCategory(Metric, Integer, Double) since 2.5. See SONAR-2007.
org.sonar.api.measures.RuleMeasure.createForRule(Metric, Rule, Double) since 4.4 use `RuleMeasure.createForRule(Metric, RuleKey, Double)`
org.sonar.api.server.ws.WebService.NewAction.createParam(String, String) since 4.4. Use `WebService.NewAction.createParam(String paramKey)` instead.
org.sonar.api.batch.CpdMapping.createResource(File, List<File>) since 4.2 not used anymore
org.sonar.api.ce.measure.Issue.debt() since 5.5, replaced by `Issue.effort()`
org.sonar.api.ce.measure.test.TestIssue.debt() since 5.5, replaced by `TestIssue.effort`
org.sonar.api.issue.Issue.debt() since 5.5, replaced by `Issue.effort()`
org.sonar.api.batch.rule.Rule.debtRemediationFunction() since 5.2 as any computation of data are moved to server's Compute Engine. Calling this method throws an exception.
org.sonar.api.server.rule.RulesDefinition.Rule.debtSubCharacteristic() in 5.5. SQALE Quality Model is replaced by SonarQube Quality Model. `null` is always returned. See https://jira.sonarsource.com/browse/MMF-184
org.sonar.api.batch.rule.Rule.debtSubCharacteristic() since 5.2 as any computation of data are moved to server's Compute Engine. Calling this method throws an exception.
org.sonar.api.security.ExternalGroupsProvider.doGetGroups(String) replaced by `ExternalGroupsProvider.doGetGroups(org.sonar.api.security.ExternalGroupsProvider.Context)` since v. 5.2
org.sonar.api.security.ExternalUsersProvider.doGetUserDetails(String) replaced by `ExternalUsersProvider.doGetUserDetails(org.sonar.api.security.ExternalUsersProvider.Context)` since v. 3.1
org.sonar.api.scan.issue.filter.FilterableIssue.effortToFix() since 5.5 use `FilterableIssue.gap()`
org.sonar.api.batch.sensor.issue.Issue.effortToFix() since 5.5 use `Issue.gap()`
org.sonar.api.issue.Issue.effortToFix() since 5.5, replaced by `Issue.gap()`
org.sonar.api.batch.sensor.issue.NewIssue.effortToFix(Double) since 5.5 use `NewIssue.gap(Double)`
org.sonar.api.server.rule.RulesDefinition.Rule.effortToFixDescription() since 5.5, replaced by `RulesDefinition.Rule.gapDescription()`
org.sonar.api.batch.Initializer.execute(Project) since 5.6 override `Initializer.execute()` instead
org.sonar.api.server.rule.RulesDefinition.Context.extendedRepositories() returns empty list since 5.2. Concept of "extended repository" was misleading and not valuable. Simply declare repositories and use `RulesDefinition.Context.repositories()`. See http://jira.sonarsource.com/browse/SONAR-6709
org.sonar.api.server.rule.RulesDefinition.Context.extendedRepositories(String) returns empty list since 5.2. Concept of "extended repository" was misleading and not valuable. Simply declare repositories and use `RulesDefinition.Context.repositories()`. See http://jira.sonarsource.com/browse/SONAR-6709
org.sonar.api.server.rule.RulesDefinition.Context.extendRepository(String, String) since 5.2. Simply use `RulesDefinition.Context.createRepository(String, String)`
org.sonar.api.rules.RuleFinder.findById(int) since 4.4, Please use `RuleFinder.findByKey(org.sonar.api.rule.RuleKey)`}
org.sonar.api.resources.Directory.fromIOFile(File, Project) since 5.1 use `FileSystem.inputDir(java.io.File)`
org.sonar.api.rules.Rule.getCardinality() since 4.4, use `Rule.isTemplate()`
org.sonar.api.rules.Rule.getCharacteristicId() since 4.4, use `Rule.getCharacteristicKey()`
org.sonar.api.rules.Rule.getCharacteristicKey() in 5.5. SQALE Quality Model is replaced by SonarQube Quality Model.
org.sonar.api.utils.AnnotationUtils.getClassAnnotation(Object, Class<A>) As of 3.1, replaced by `AnnotationUtils.getAnnotation(Object,Class)`
org.sonar.api.source.Symbol.getDeclarationEndOffset() in 5.2 not used.
org.sonar.api.source.Symbol.getDeclarationStartOffset() in 5.2 not used.
org.sonar.api.rules.Rule.getDefaultCharacteristicId() since 4.4, use `Rule.getDefaultCharacteristicKey()`
org.sonar.api.rules.Rule.getDefaultCharacteristicKey() in 5.5. SQALE Quality Model is replaced by SonarQube Quality Model.
org.sonar.api.rules.Rule.getDefaultSubCharacteristicKey() in 5.5. SQALE Quality Model is replaced by SonarQube Quality Model.
org.sonar.api.platform.Server.getDeployDir() always `null` since version 6.0. No alternatives, as plugins do not have to touch this directory.
org.sonar.api.i18n.RuleI18n.getDescription(String, String, Locale) since 4.1. Rules are not localized anymore. See http://jira.sonarsource.com/browse/SONAR-4885
org.sonar.api.measures.Metric.getFormula() since 5.2 there's no more decorator on batch side, please use `MeasureComputer` instead
org.sonar.api.source.Symbol.getFullyQualifiedName() in 4.3 not used.
org.sonar.api.measures.FileLinesContext.getIntValue(String, int) since 5.0 sensors should not read data
org.sonar.api.resources.Resource.getLanguage() since 5.1 use `Resource.language()`
org.sonar.api.resources.Project.getLanguageKey() since 4.2 use `FileSystem.languages()`
org.sonar.api.security.SecurityRealm.getLoginPasswordAuthenticator() replaced by doGetAuthenticator in version 3.1
org.sonar.api.batch.SensorContext.getMeasure(Metric<G>) since 5.1 Sensors should not read but only save data
org.sonar.api.batch.SensorContext.getMeasure(Resource, Metric<G>) since 5.1 Sensors should not read but only save data
org.sonar.api.batch.SensorContext.getMeasures(MeasuresFilter<M>) since 5.1 Sensors should not read but only save data
org.sonar.api.batch.SensorContext.getMeasures(Resource, MeasuresFilter<M>) since 5.1 Sensors should not read but only save data
org.sonar.api.i18n.RuleI18n.getName(Rule, Locale) since 4.1. Rules are not localized anymore. See http://jira.sonarsource.com/browse/SONAR-4885
org.sonar.api.i18n.RuleI18n.getName(String, String, Locale) since 4.1. Rules are not localized anymore. See http://jira.sonarsource.com/browse/SONAR-4885
org.sonar.api.rules.ActiveRule.getNoteCreatedAt() in 4.4. Feature dropped.
org.sonar.api.rules.ActiveRule.getNoteData() in 4.4. Feature dropped.
org.sonar.api.rules.ActiveRule.getNoteUpdatedAt() in 4.4. Feature dropped.
org.sonar.api.rules.ActiveRule.getNoteUserLogin() in 4.4. Feature dropped.
org.sonar.api.i18n.RuleI18n.getParamDescription(String, String, String, Locale) since 4.1. Rules are not localized anymore. See http://jira.sonarsource.com/browse/SONAR-4885
org.sonar.api.rules.Rule.getParent() since 4.4, use `Rule.getTemplate()`
org.sonar.api.rules.ActiveRule.getPluginName() since 2.3 use `ActiveRule.getRepositoryKey()` instead
org.sonar.api.rules.ActiveRule.getPriority() since 2.5 use `ActiveRule.getSeverity()` instead. See http://jira.sonarsource.com/browse/SONAR-1829
org.sonar.api.batch.bootstrap.ProjectDefinition.getProperties() since 5.0 use `ProjectDefinition.properties()`
org.sonar.api.platform.Server.getRootDir() in 6.0. Replaced by `ServerFileSystem.getHomeDir()`
org.sonar.api.measures.RuleMeasure.getRule() since 4.4 use `RuleMeasure.ruleKey()`
org.sonar.api.measures.RuleMeasure.getRulePriority() since 2.14 use `RuleMeasure.getSeverity()` instead. See SONAR-1829.
org.sonar.api.resources.Project.getSettings() since 5.0
org.sonar.api.measures.FileLinesContext.getStringValue(String, int) since 5.0 sensors should not read data
org.sonar.api.rules.Rule.getSubCharacteristicKey() in 5.5. SQALE Quality Model is replaced by SonarQube Quality Model.
org.sonar.api.measures.Measure.getTendency() since 5.2. See https://jira.sonarsource.com/browse/SONAR-6392
org.sonar.api.web.ServletFilter.UrlPattern.getUrl() replaced in version 6.0 by `ServletFilter.UrlPattern.getInclusions()` and `ServletFilter.UrlPattern.getExclusions()`
org.sonar.api.profiles.RulesProfile.getUsed() profile versioning is dropped in 4.4. Always returns null.
org.sonar.api.profiles.RulesProfile.getVersion() profile versioning is dropped in 4.4. Always returns -1.
org.sonar.api.batch.sensor.highlighting.NewHighlighting.highlight(int, int, TypeOfText) since 5.6 Only supported to ease migration from old API. Please prefer other `highlight()` methods.
org.sonar.api.security.LoginPasswordAuthenticator.init() in 2.14, but was left for backward compatibility - when this authenticator is not a part of `SecurityRealm`, otherwise has no effect and not invoked
org.sonar.api.resources.Scopes.isBlockUnit(Resource) since 4.3 resources under FILE level are no more be supported since 4.2.
org.sonar.api.resources.Resource.isExcluded() since 2.6.
org.sonar.api.resources.ResourceUtils.isLibrary(Resource) since 5.2 No more design features
org.sonar.api.rule.RuleKey.isManual() since 5.5, manual rule feature has been dropped
org.sonar.api.resources.Scopes.isProgramUnit(Resource) since 4.3 resources under FILE level are no more be supported since 4.2.
org.sonar.api.platform.Server.isSecured() since 5.6, use instead `HttpServletRequest.getHeader(String)` and check that X-Forwarded-Proto header is set to "https".
org.sonar.api.issue.Issuable.issues() since 5.2 no more decorators on batch side
org.sonar.api.resources.ResourceUtils.isUnitTestClass(Resource) since 5.1 use `ResourceUtils.isUnitTestFile(Resource)`
org.sonar.api.issue.Issuable.IssueBuilder.line(Integer) since 5.2 use `Issuable.IssueBuilder.at(NewIssueLocation)`
org.sonar.api.utils.ValidationMessages.log(Logger) replaced by `ValidationMessages.log(org.sonar.api.utils.log.Logger)` since deprecation of slf4j in 5.1
org.sonar.api.issue.Issuable.IssueBuilder.message(String) since 5.2 use `Issuable.IssueBuilder.at(NewIssueLocation)`
org.sonar.api.utils.System2.newDate() in 5.2. Please use `System2.now()`
org.sonar.api.batch.sensor.symbol.NewSymbolTable.newSymbol(int, int) since 5.6 Only supported to ease migration from old API. Please prefer `NewSymbolTable.newSymbol(int, int, int, int)`.
org.sonar.api.server.debt.DebtRemediationFunction.offset() since 5.5, replaced by `DebtRemediationFunction.baseEffort()`
org.sonar.api.server.debt.internal.DefaultDebtRemediationFunction.offset() since 5.5, replaced by `DefaultDebtRemediationFunction.baseEffort`
org.sonar.api.server.ws.Request.param(String, String) to be dropped in 4.4. Default values are declared in ws metadata
org.sonar.api.server.ws.Request.paramAsBoolean(String, boolean) to be dropped in 4.4. Default values must be declared in `WebService` then this method can be replaced by `Request.mandatoryParamAsBoolean(String)`.
org.sonar.api.server.ws.Request.paramAsInt(String, int) to be dropped in 4.4. Default values must be declared in `WebService` then this method can be replaced by `Request.mandatoryParamAsInt(String)`.
org.sonar.api.server.ws.Request.paramAsLong(String, long) to be dropped in 4.4. Default values must be declared in `WebService` then this method can be replaced by `Request.mandatoryParamAsLong(String)`.
org.sonar.api.source.Symbolizable.SymbolTable.references(Symbol) since 5.2 not used
org.sonar.api.scan.filesystem.PathResolver.relativePath(Collection<File>, File) since 6.0 was used when component keys were relative to source dirs
org.sonar.api.issue.Issue.reporter() since 5.5, manual issue feature has been dropped.
org.sonar.api.issue.Issuable.IssueBuilder.reporter(String) since 5.5, manual issue feature has been dropped.
org.sonar.api.issue.Issuable.resolvedIssues() since 5.2 no more decorators on batch side
org.sonar.api.batch.SensorContext.saveDependency(Dependency) since 5.2 No more design features. No-op
org.sonar.api.batch.DecoratorContext.saveDependency(Dependency) since 5.2 No more design features. No-op.
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<ActiveRuleParam>) use setParameter()
org.sonar.api.rules.Rule.setCardinality(Cardinality) since 4.4, use `Rule.setIsTemplate(boolean)`
org.sonar.api.rules.Rule.setCharacteristicId(Integer) since 4.4, use `Rule.setCharacteristicKey(String)`
org.sonar.api.rules.Rule.setCharacteristicKey(String) in 5.5. SQALE Quality Model is replaced by SonarQube Quality Model.
org.sonar.api.test.MutableTestCase.setCoverageBlock(Testable, List<Integer>) since 5.2. Use `MutableTestCase.setCoverageBlock(InputFile, List)`
org.sonar.api.ce.measure.test.TestIssue.Builder.setDebt(Duration) since 5.5, use `TestIssue.Builder.setEffort(Duration)` instead
org.sonar.api.server.rule.RulesDefinition.NewRule.setDebtSubCharacteristic(String) in 5.5. SQALE Quality Model is replaced by SonarQube Quality Model. This method does nothing. See https://jira.sonarsource.com/browse/MMF-184
org.sonar.api.rules.Rule.setDefaultCharacteristicId(Integer) since 4.4, use `Rule.setDefaultCharacteristicKey(String)`
org.sonar.api.rules.Rule.setDefaultCharacteristicKey(String) in 5.5. SQALE Quality Model is replaced by SonarQube Quality Model.
org.sonar.api.rules.Rule.setDefaultSubCharacteristicKey(String) in 5.5. SQALE Quality Model is replaced by SonarQube Quality Model.
org.sonar.api.server.rule.RulesDefinition.NewRule.setEffortToFixDescription(String) since 5.5, replaced by `RulesDefinition.NewRule.setGapDescription(String)`
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.measures.Metric.setFormula(Formula) since 5.2 there's no more decorator on batch side, please use `MeasureComputer` instead
org.sonar.api.measures.Metric.Builder.setFormula(Formula) since 5.2, it's no more possible to define a formula on a metric, please use `MeasureComputer` instead
org.sonar.api.rules.ActiveRule.setId(Integer) visibility should be decreased to protected or package
org.sonar.api.rules.Rule.setId(Integer) since 2.3. visibility should be decreased to protected or package
org.sonar.api.resources.Project.setLatestAnalysis(boolean) in 3.6. It's not possible to analyze a project before the latest known quality snapshot. See http://jira.sonarsource.com/browse/SONAR-4334
org.sonar.api.rules.Rule.setParent(Rule) since 4.4, use `Rule.setTemplate(Rule)`}
org.sonar.api.rules.ActiveRule.setPriority(RulePriority) since 2.5 use `ActiveRule.setSeverity(RulePriority)` instead. See http://jira.sonarsource.com/browse/SONAR-1829
org.sonar.api.batch.bootstrap.ProjectDefinition.setProperties(Properties) since 5.0 use `ProjectDefinition.setProperties(Map)`
org.sonar.api.rules.ActiveRule.setRule(Rule) visibility should be reduced to protected or package
org.sonar.api.measures.RuleMeasure.setRule(Rule) since 4.4 use `RuleMeasure.setRuleKey(org.sonar.api.rule.RuleKey)`
org.sonar.api.rules.ActiveRuleParam.setRuleParam(RuleParam) visibility should be decreased to protected or package
org.sonar.api.measures.RuleMeasure.setRulePriority(RulePriority) since 2.14 use `RuleMeasure.setSeverity(org.sonar.api.rules.RulePriority)` instead. See SONAR-1829.
org.sonar.api.rules.ActiveRule.setRulesProfile(RulesProfile) visibility should be reduced to protected or package
org.sonar.api.rules.Rule.setSubCharacteristicKey(String) in 5.5. SQALE Quality Model is replaced by SonarQube Quality Model.
org.sonar.api.measures.Measure.setTendency(Integer) since 5.2. See https://jira.sonarsource.com/browse/SONAR-6392
org.sonar.api.test.MutableTestCase.setType(String) since 5.2 not used
org.sonar.api.profiles.RulesProfile.setUsed(Boolean) profile versioning is dropped in 4.4. Always returns -1.
org.sonar.api.measures.Measure.setValue(Double, int) in 5.3. The decimal scale is given by the metric, not by the measure. Anyway this parameter was enforced to 1 before version 5.3.
org.sonar.api.profiles.RulesProfile.setVersion(int) profile versioning is dropped in 4.4. Always returns -1.
org.sonar.api.batch.Initializer.shouldExecuteOnProject(Project) since 5.6 should no more be implemented by plugins
org.sonar.api.scan.filesystem.ModuleFileSystem.sourceDirs() since 4.2 use `FileSystem.files(org.sonar.api.batch.fs.FilePredicate)` to get all files with type `InputFile.Type#MAIN`.
org.sonar.api.scan.filesystem.ModuleFileSystem.testDirs() since 4.2 use `FileSystem.files(org.sonar.api.batch.fs.FilePredicate)` to get all files with type `InputFile.Type#TEST`.
org.sonar.api.test.TestCase.type() since 5.2 not used
org.sonar.api.server.debt.DebtRemediationFunction.Type.usesCoefficient() since 5.5, replaced by `DebtRemediationFunction.Type.usesGapMultiplier()`
org.sonar.api.server.debt.DebtRemediationFunction.Type.usesOffset() since 5.5, replaced by `DebtRemediationFunction.Type.usesBaseEffort()`
org.sonar.api.rules.RulePriority.valueOfString(String) in 3.6

Deprecated Constructors
Constructor and Description
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.measures.Metric() in 1.12. Use the `Metric.Builder` factory.
org.sonar.api.measures.Metric(String) since 2.7 use the `Metric.Builder` factory.
org.sonar.api.measures.Metric(String, Metric.ValueType) since 2.7 use the `Metric.Builder` factory.
org.sonar.api.measures.Metric(String, String, String, Metric.ValueType, Integer, Boolean, String) since 2.7 use the `Metric.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.measures.RuleMeasure(Metric, Rule, RulePriority, Integer) since 4.4 use `RuleMeasure.RuleMeasure(Metric, RuleKey, RulePriority, Integer)`
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.profiles.XMLProfileParser(RuleFinder) since 2.5. Plugins shouldn't directly instantiate this class, because it should be retrieved as an IoC dependency.

Deprecated Enum Constants
Enum Constant and Description

org.sonar.api.batch.sensor.highlighting.TypeOfText.CPP_DOC
use TypeOfText.COMMENT

Deprecated API

Contents