A B C D E F G H I J K L M N O P Q R S T U V W X Z 
All Classes All Packages

A

A1 - org.sonar.api.server.rule.RulesDefinition.OwaspTop10
 
A10 - org.sonar.api.server.rule.RulesDefinition.OwaspTop10
 
A2 - org.sonar.api.server.rule.RulesDefinition.OwaspTop10
 
A3 - org.sonar.api.server.rule.RulesDefinition.OwaspTop10
 
A4 - org.sonar.api.server.rule.RulesDefinition.OwaspTop10
 
A5 - org.sonar.api.server.rule.RulesDefinition.OwaspTop10
 
A6 - org.sonar.api.server.rule.RulesDefinition.OwaspTop10
 
A7 - org.sonar.api.server.rule.RulesDefinition.OwaspTop10
 
A8 - org.sonar.api.server.rule.RulesDefinition.OwaspTop10
 
A9 - org.sonar.api.server.rule.RulesDefinition.OwaspTop10
 
absolutePath() - Method in interface org.sonar.api.batch.fs.IndexedFile
absolutePath() - Method in interface org.sonar.api.batch.fs.InputDir
Deprecated.
Normalized absolute path.
absolutePath() - Method in interface org.sonar.api.batch.fs.InputFile
Deprecated.
since 6.6 use InputFile.inputStream() for file content, IndexedFile.filename() for file name, IndexedFile.uri() for an unique identifier, and InputFile.toString() for logging
absolutePath() - Method in interface org.sonar.api.batch.fs.InputPath
Deprecated.
since 6.5 use InputPath.uri()
AbstractContext() - Constructor for class org.sonar.api.server.rule.RulesDefinition.AbstractContext
 
AbstractDashboardWidget - Class in org.sonar.api.web
Deprecated.
override org.sonar.api.web.AbstractRubyTemplate and implement org.sonar.api.web.RubyRailsWidget
AbstractDashboardWidget() - Constructor for class org.sonar.api.web.AbstractDashboardWidget
Deprecated.
 
AbstractLanguage - Class in org.sonar.api.resources
Inherit this class to define a new language like PLSQL, PHP or C#
AbstractLanguage(String) - Constructor for class org.sonar.api.resources.AbstractLanguage
Better to use AbstractLanguage(key, name).
AbstractLanguage(String, String) - Constructor for class org.sonar.api.resources.AbstractLanguage
Should be the constructor used to build an AbstractLanguage.
AbstractRubyTemplate - Class in org.sonar.api.web
Deprecated.
since 6.3. This class is ignored.
AbstractRubyTemplate() - Constructor for class org.sonar.api.web.AbstractRubyTemplate
Deprecated.
 
accept(ZipEntry) - Method in interface org.sonar.api.utils.ZipUtils.ZipEntryFilter
Deprecated.
 
accept(InputFile) - Method in interface org.sonar.api.batch.fs.InputFileFilter
 
accept(FilterableIssue) - Method in interface org.sonar.api.scan.issue.filter.IssueFilterChain
Called by a filter to let downstream filters decide the fate of the issue
accept(FilterableIssue, IssueFilterChain) - Method in interface org.sonar.api.scan.issue.filter.IssueFilter
Deprecated.
The accept method is called for each FilterableIssue created during analysis, to check if it has to be persisted.
action(String) - Method in class org.sonar.api.server.ws.WebService.Controller
 
actions() - Method in class org.sonar.api.server.ws.WebService.Controller
 
activatedByDefault() - Method in class org.sonar.api.server.rule.internal.DefaultRule
 
activatedByDefault() - Method in class org.sonar.api.server.rule.RulesDefinition.Rule
Should this rule be enabled by default.
activateRule(String, String) - Method in interface org.sonar.api.server.profile.BuiltInQualityProfilesDefinition.NewBuiltInQualityProfile
Activate a rule with specified key.
activateRule(String, String) - Method in class org.sonar.api.server.profile.BuiltInQualityProfilesDefinition.NewBuiltInQualityProfileImpl
 
activateRule(Rule, RulePriority) - Method in class org.sonar.api.profiles.RulesProfile
 
active() - Method in interface org.sonar.api.user.User
 
ActiveRule - Class in org.sonar.api.rules
 
ActiveRule - Interface in org.sonar.api.batch.rule
Configuration of a rule activated on a Quality profile
ActiveRule() - Constructor for class org.sonar.api.rules.ActiveRule
Deprecated.
visibility should be reduced to protected or package
ActiveRule(RulesProfile, Rule, RulePriority) - Constructor for class org.sonar.api.rules.ActiveRule
Deprecated.
visibility should be reduced to protected or package
ActiveRuleParam - Class in org.sonar.api.rules
 
ActiveRuleParam() - Constructor for class org.sonar.api.rules.ActiveRuleParam
Deprecated.
visibility should be decreased to protected or package
ActiveRuleParam(ActiveRule, RuleParam, String) - Constructor for class org.sonar.api.rules.ActiveRuleParam
Deprecated.
visibility should be decreased to protected or package
activeRules() - Method in interface org.sonar.api.batch.sensor.SensorContext
Get list of active rules.
activeRules() - Method in interface org.sonar.api.server.profile.BuiltInQualityProfilesDefinition.NewBuiltInQualityProfile
 
activeRules() - Method in class org.sonar.api.server.profile.BuiltInQualityProfilesDefinition.NewBuiltInQualityProfileImpl
 
ActiveRules - Interface in org.sonar.api.batch.rule
The rules that are activated on the current project.
add(Number) - Method in class org.sonar.api.ce.measure.RangeDistributionBuilder
Increments an entry by 1
add(Number, int) - Method in class org.sonar.api.ce.measure.RangeDistributionBuilder
Increments an entry
add(Object, Object...) - Method in class org.sonar.api.utils.dag.DirectAcyclicGraph
 
add(String) - Method in class org.sonar.api.ce.measure.RangeDistributionBuilder
Adds an existing Distribution to the current one.
add(String, Object) - Method in interface org.sonar.api.ce.posttask.PostProjectAnalysisTask.LogStatistics
 
add(QualityGate.Condition) - Method in class org.sonar.api.ce.posttask.PostProjectAnalysisTaskTester.QualityGateBuilder
 
add(Language) - Method in class org.sonar.api.resources.Languages
Adds a language to the current object
add(Duration) - Method in class org.sonar.api.utils.Duration
Add the given duration to the current one.
addActiveRule(ActiveRule) - Method in class org.sonar.api.profiles.RulesProfile
 
addAnnotatedChecks(Iterable) - Method in class org.sonar.api.batch.rule.Checks
 
addAnnotatedChecks(Object...) - Method in class org.sonar.api.batch.rule.Checks
 
addAnnotatedChecks(Collection) - Method in class org.sonar.api.batch.rule.Checks
Deprecated.
addArgument(String) - Method in class org.sonar.api.utils.command.Command
 
addArguments(String[]) - Method in class org.sonar.api.utils.command.Command
 
addArguments(List<String>) - Method in class org.sonar.api.utils.command.Command
 
addChildrenMeasures(String, Double...) - Method in class org.sonar.api.ce.measure.test.TestMeasureComputerContext
 
addChildrenMeasures(String, Integer...) - Method in class org.sonar.api.ce.measure.test.TestMeasureComputerContext
 
addChildrenMeasures(String, Long...) - Method in class org.sonar.api.ce.measure.test.TestMeasureComputerContext
 
addChildrenMeasures(String, String...) - Method in class org.sonar.api.ce.measure.test.TestMeasureComputerContext
 
addComponent(Object) - Method in class org.sonar.api.config.PropertyDefinitions
 
addComponent(Object, String) - Method in class org.sonar.api.config.PropertyDefinitions
 
addComponents(Collection) - Method in class org.sonar.api.config.PropertyDefinitions
 
addComponents(Collection, String) - Method in class org.sonar.api.config.PropertyDefinitions
 
addContext(String, Object) - Method in class org.sonar.api.utils.log.Profiler
Context information is removed if value is null.
addContextProperty(String, String) - Method in interface org.sonar.api.batch.sensor.SensorContext
Add a property to the scanner context.
addCwe(int...) - Method in class org.sonar.api.server.rule.RulesDefinition.NewRule
 
addDays(Instant, int) - Static method in class org.sonar.api.utils.DateUtils
 
addDays(Date, int) - Static method in class org.sonar.api.utils.DateUtils
Adds a number of days to a date returning a new object.
addDependency(Node) - Method in class org.sonar.api.utils.dag.Node
 
addDeprecatedRuleKey(String, String) - Method in class org.sonar.api.server.rule.RulesDefinition.NewRule
Register a repository and key under which this rule used to be known (see RulesDefinition.Rule.deprecatedRuleKeys() for details).
ADDED - org.sonar.api.batch.fs.InputFile.Status
Deprecated.
 
addErrorText(String) - Method in class org.sonar.api.utils.ValidationMessages
 
addExtension(Object) - Method in class org.sonar.api.Plugin.Context
Add an extension as : a Class that is annotated with ScannerSide, ServerSide or ComputeEngineSide.
addExtensions(Object, Object, Object...) - Method in class org.sonar.api.Plugin.Context
 
addExtensions(Collection) - Method in class org.sonar.api.Plugin.Context
 
addFieldsParam(Collection<?>) - Method in class org.sonar.api.server.ws.WebService.NewAction
Creates the parameter WebService.Param.FIELDS, which is used to restrict the number of fields returned in JSON response.
addFlow(Iterable<NewIssueLocation>) - Method in interface org.sonar.api.batch.sensor.issue.NewExternalIssue
Register a flow for this issue.
addFlow(Iterable<NewIssueLocation>) - Method in interface org.sonar.api.batch.sensor.issue.NewIssue
Register a flow for this issue.
addInfoText(String) - Method in class org.sonar.api.utils.ValidationMessages
 
addInputMeasure(String, boolean) - Method in class org.sonar.api.ce.measure.test.TestMeasureComputerContext
 
addInputMeasure(String, double) - Method in class org.sonar.api.ce.measure.test.TestMeasureComputerContext
 
addInputMeasure(String, int) - Method in class org.sonar.api.ce.measure.test.TestMeasureComputerContext
 
addInputMeasure(String, long) - Method in class org.sonar.api.ce.measure.test.TestMeasureComputerContext
 
addInputMeasure(String, String) - Method in class org.sonar.api.ce.measure.test.TestMeasureComputerContext
 
addLocation(NewIssueLocation) - Method in interface org.sonar.api.batch.sensor.issue.NewExternalIssue
Add a secondary location for this issue.
addLocation(NewIssueLocation) - Method in interface org.sonar.api.batch.sensor.issue.NewIssue
Add a secondary location for this issue.
addMaskedArgument(String) - Method in class org.sonar.api.utils.command.Command
 
addMeasure(String, boolean) - Method in interface org.sonar.api.ce.measure.MeasureComputer.MeasureComputerContext
Add a new measure of a given metric which measure type will be boolean
addMeasure(String, boolean) - Method in class org.sonar.api.ce.measure.test.TestMeasureComputerContext
 
addMeasure(String, double) - Method in interface org.sonar.api.ce.measure.MeasureComputer.MeasureComputerContext
Add a new measure of a given metric which measure type will be double
addMeasure(String, double) - Method in class org.sonar.api.ce.measure.test.TestMeasureComputerContext
 
addMeasure(String, int) - Method in interface org.sonar.api.ce.measure.MeasureComputer.MeasureComputerContext
Add a new measure of a given metric which measure type will be int
addMeasure(String, int) - Method in class org.sonar.api.ce.measure.test.TestMeasureComputerContext
 
addMeasure(String, long) - Method in interface org.sonar.api.ce.measure.MeasureComputer.MeasureComputerContext
Add a new measure of a given metric which measure type will be long
addMeasure(String, long) - Method in class org.sonar.api.ce.measure.test.TestMeasureComputerContext
 
addMeasure(String, String) - Method in interface org.sonar.api.ce.measure.MeasureComputer.MeasureComputerContext
Add a new measure of a given metric which measure type will be string
addMeasure(String, String) - Method in class org.sonar.api.ce.measure.test.TestMeasureComputerContext
 
addOwaspTop10(RulesDefinition.OwaspTop10...) - Method in class org.sonar.api.server.rule.RulesDefinition.NewRule
 
addPage(Page) - Method in class org.sonar.api.web.page.Context
 
addPagingParams(int) - Method in class org.sonar.api.server.ws.WebService.NewAction
Add predefined parameters related to pagination of results.
addPagingParams(int, int) - Method in class org.sonar.api.server.ws.WebService.NewAction
Add predefined parameters related to pagination of results with a maximum page size.
addPagingParamsSince(int, int, String) - Method in class org.sonar.api.server.ws.WebService.NewAction
Add predefined parameters related to pagination of results with a maximum page size.
addProperties(Map<String, String>) - Method in class org.sonar.api.ce.posttask.PostProjectAnalysisTaskTester.ScannerContextBuilder
 
addProperties(Map<String, String>) - Method in class org.sonar.api.config.Settings
Deprecated.
 
addProperties(Properties) - Method in class org.sonar.api.config.Settings
Deprecated.
 
addRange(TextRange) - Method in interface org.sonar.api.batch.sensor.code.NewSignificantCode
Add a range of significant code.
addRelations(String, String...) - Method in class org.sonar.api.resources.ResourceTypeTree.Builder
 
addSearchQuery(String, String...) - Method in class org.sonar.api.server.ws.WebService.NewAction
Creates the parameter WebService.Param.TEXT_QUERY, which is used to search for a subset of fields containing the supplied string.
addSelectionModeParam() - Method in class org.sonar.api.server.ws.WebService.NewAction
Add 'selected=(selected|deselected|all)' for select-list oriented WS.
addSortParams(Collection<V>, V, boolean) - Method in class org.sonar.api.server.ws.WebService.NewAction
Add predefined parameters related to sorting of results.
addSources(File...) - Method in class org.sonar.api.batch.bootstrap.ProjectDefinition
Deprecated.
 
addSources(String...) - Method in class org.sonar.api.batch.bootstrap.ProjectDefinition
Deprecated.
 
addSubProject(ProjectDefinition) - Method in class org.sonar.api.batch.bootstrap.ProjectDefinition
Deprecated.
 
addTags(String...) - Method in class org.sonar.api.server.rule.RulesDefinition.NewRule
 
addTestCase(String) - Method in interface org.sonar.api.test.MutableTestPlan
Deprecated.
Add a TestCase to this test file.
addTests(File...) - Method in class org.sonar.api.batch.bootstrap.ProjectDefinition
Deprecated.
 
addTests(String...) - Method in class org.sonar.api.batch.bootstrap.ProjectDefinition
Deprecated.
 
addToken(int, int, int, int, String) - Method in interface org.sonar.api.batch.sensor.cpd.NewCpdTokens
Shortcut to avoid calling InputFile.newRange(int, int, int, int)
addToken(TextRange, String) - Method in interface org.sonar.api.batch.sensor.cpd.NewCpdTokens
Call this method to register a token in a range.
addType(ResourceType) - Method in class org.sonar.api.resources.ResourceTypeTree.Builder
 
addUnique(String) - Method in interface org.sonar.api.notifications.AnalysisWarnings
Add a single message, if it was not already added.
addWarningText(String) - Method in class org.sonar.api.utils.ValidationMessages
 
addWidget(String, int) - Method in class org.sonar.api.web.Dashboard
Deprecated.
Add a widget with the given parameters, and return the newly created Dashboard.Widget object if one wants to add parameters to it.
AdHocRule - Interface in org.sonar.api.batch.sensor.rule
Represents a rule imported from an external rule engine by a Sensor.
ADMIN - Static variable in annotation type org.sonar.api.web.UserRole
 
ADMINISTRATORS - Static variable in class org.sonar.api.security.DefaultGroups
 
after() - Method in class org.sonar.api.utils.log.LogTester
 
age(Locale, long) - Method in interface org.sonar.api.i18n.I18n
Deprecated.
Return the distance in time for a duration in milliseconds.
age(Locale, Date, Date) - Method in interface org.sonar.api.i18n.I18n
Deprecated.
Return the distance in time between two dates.
ageFromNow(Locale, Date) - Method in interface org.sonar.api.i18n.I18n
Deprecated.
Reports the distance in time a date and now.
ALERT_STATUS - Static variable in class org.sonar.api.measures.CoreMetrics
 
ALERT_STATUS_KEY - Static variable in class org.sonar.api.measures.CoreMetrics
 
all() - Method in interface org.sonar.api.batch.fs.FilePredicates
Predicate that always evaluates to true
all() - Method in class org.sonar.api.batch.rule.Checks
 
all() - Method in class org.sonar.api.resources.Languages
 
ALL - org.sonar.api.rule.RuleScope
 
ALL - org.sonar.api.server.ws.WebService.SelectionMode
 
ALL - Static variable in interface org.sonar.api.issue.DefaultTransitions
 
ALL - Static variable in class org.sonar.api.rule.Severity
All the supported severity values, ordered from Severity.INFO to Severity.BLOCKER.
ALL_ACTIVES - Static variable in class org.sonar.api.user.UserQuery
 
allowsUsersToSignUp() - Method in interface org.sonar.api.server.authentication.IdentityProvider
Can users sign-up (connecting with their account for the first time) ? If true, then users can register and create their account into SonarQube, else only already registered users can login.
Analysis - Interface in org.sonar.api.ce.posttask
 
AnalysisError - Interface in org.sonar.api.batch.sensor.error
Represents an analysis error, such as a parsing error, reported by a Sensor.
analysisMode() - Method in interface org.sonar.api.batch.postjob.PostJobContext
Deprecated.
since 7.3 preview mode deprecated since 6.6
AnalysisMode - Interface in org.sonar.api.batch
Deprecated.
since 7.3 preview mode deprecated since 6.6
AnalysisWarnings - Interface in org.sonar.api.notifications
Record user-friendly warnings that will be visible on SonarQube to users with browse access to the project.
and(Collection<FilePredicate>) - Method in interface org.sonar.api.batch.fs.FilePredicates
 
and(FilePredicate...) - Method in interface org.sonar.api.batch.fs.FilePredicates
 
and(FilePredicate, FilePredicate) - Method in interface org.sonar.api.batch.fs.FilePredicates
 
andTotal(int) - Method in class org.sonar.api.utils.Paging.Builder
 
ANNOTATION - org.sonar.api.batch.sensor.highlighting.TypeOfText
 
AnnotationProfileParser - Class in org.sonar.api.profiles
Deprecated.
AnnotationProfileParser(RuleFinder) - Constructor for class org.sonar.api.profiles.AnnotationProfileParser
Deprecated.
 
AnnotationRuleParser - Class in org.sonar.api.rules
Deprecated.
AnnotationRuleParser() - Constructor for class org.sonar.api.rules.AnnotationRuleParser
Deprecated.
 
AnnotationUtils - Class in org.sonar.api.utils
A utility class for annotations
ANYONE - Static variable in class org.sonar.api.security.DefaultGroups
 
API_ABUSE - Static variable in class org.sonar.api.server.rule.RulesDefinition.SubCharacteristics
Deprecated.
Related to characteristic SECURITY
APP - org.sonar.api.web.page.Page.Qualifier
 
APP - Static variable in class org.sonar.api.resources.Qualifiers
Application portfolios.
appendProperty(String, String) - Method in class org.sonar.api.config.Settings
Deprecated.
 
apply(InputFile) - Method in interface org.sonar.api.batch.fs.FilePredicate
Test if provided file is valid for this predicate
ARCHITECTURE_CHANGEABILITY - Static variable in class org.sonar.api.server.rule.RulesDefinition.SubCharacteristics
Deprecated.
Related to characteristic CHANGEABILITY
ARCHITECTURE_RELIABILITY - Static variable in class org.sonar.api.server.rule.RulesDefinition.SubCharacteristics
Deprecated.
Related to characteristic RELIABILITY
as(Class<P>, InputPath) - Method in interface org.sonar.api.component.ResourcePerspectives
Deprecated.
Allow to create perspective from InputPath.
ASCENDING - Static variable in class org.sonar.api.server.ws.WebService.Param
 
assignee() - Method in interface org.sonar.api.issue.Issue
UUID of the user who is assigned to this issue.
at(Date) - Method in class org.sonar.api.ce.posttask.PostProjectAnalysisTaskTester
 
at(TextPointer) - Method in interface org.sonar.api.batch.sensor.error.NewAnalysisError
Location of this error.
at(TextRange) - Method in interface org.sonar.api.batch.sensor.issue.NewIssueLocation
Position in the file.
at(NewIssueLocation) - Method in interface org.sonar.api.batch.sensor.issue.NewExternalIssue
Primary location for this issue.
at(NewIssueLocation) - Method in interface org.sonar.api.batch.sensor.issue.NewIssue
Primary location for this issue.
attribute(String) - Method in interface org.sonar.api.issue.Issue
 
attributes() - Method in interface org.sonar.api.issue.Issue
Empty on batch side since version 5.2.
authenticate(String, String) - Method in interface org.sonar.api.security.LoginPasswordAuthenticator
Deprecated.
 
authenticate(UserIdentity) - Method in interface org.sonar.api.server.authentication.BaseIdentityProvider.Context
Authenticate and register the user into the platform.
authenticate(UserIdentity) - Method in interface org.sonar.api.server.authentication.OAuth2IdentityProvider.CallbackContext
Authenticate and register the user into the platform.
Authenticator - Class in org.sonar.api.security
 
Authenticator() - Constructor for class org.sonar.api.security.Authenticator
 
Authenticator.Context - Class in org.sonar.api.security
 
author() - Method in class org.sonar.api.batch.scm.BlameLine
 
author(String) - Method in class org.sonar.api.batch.scm.BlameLine
Sets author for this line.
authorLogin() - Method in interface org.sonar.api.issue.Issue
Login of the SCM account that introduced this issue.
availableForFilters() - Method in class org.sonar.api.resources.ResourceType.Builder
Deprecated.
since 3.0. Use ResourceType.Builder.setProperty(String, String) with "supportsMeasureFilters" set to "true".

B

baseDir() - Method in interface org.sonar.api.batch.fs.FileSystem
Absolute base directory of module.
baseEffort() - Method in interface org.sonar.api.server.debt.DebtRemediationFunction
baseEffort() - Method in class org.sonar.api.server.debt.internal.DefaultDebtRemediationFunction
 
BaseIdentifiable<G> - Class in org.sonar.api.database
Deprecated.
since 7.8
BaseIdentifiable() - Constructor for class org.sonar.api.database.BaseIdentifiable
Deprecated.
 
BaseIdentityProvider - Interface in org.sonar.api.server.authentication
 
BaseIdentityProvider.Context - Interface in org.sonar.api.server.authentication
 
BatchComponent - Interface in org.sonar.api
Deprecated.
since 5.2 use ScannerSide annotation
before() - Method in class org.sonar.api.utils.log.LogTester
 
begin(String) - Method in class org.sonar.api.utils.text.XmlWriter
 
beginArray() - Method in class org.sonar.api.utils.text.JsonWriter
Begins encoding a new array.
beginObject() - Method in class org.sonar.api.utils.text.JsonWriter
Begins encoding a new object.
BETA - org.sonar.api.rule.RuleStatus
 
blame(BlameCommand.BlameInput, BlameCommand.BlameOutput) - Method in class org.sonar.api.batch.scm.BlameCommand
Compute blame of the provided files.
blameCommand() - Method in class org.sonar.api.batch.scm.ScmProvider
 
BlameCommand - Class in org.sonar.api.batch.scm
This class should be implemented by SCM providers.
BlameCommand() - Constructor for class org.sonar.api.batch.scm.BlameCommand
 
BlameCommand.BlameInput - Interface in org.sonar.api.batch.scm
Callback for the provider to report results of blame per file.
BlameCommand.BlameOutput - Interface in org.sonar.api.batch.scm
Callback for the provider to report results of blame per file.
BlameLine - Class in org.sonar.api.batch.scm
 
BlameLine() - Constructor for class org.sonar.api.batch.scm.BlameLine
 
BlameLine(Date, String) - Constructor for class org.sonar.api.batch.scm.BlameLine
Preferred constructor.
blameResult(InputFile, List<BlameLine>) - Method in interface org.sonar.api.batch.scm.BlameCommand.BlameOutput
Add result of the blame command for a single file.
BLOCK_UNIT - Static variable in class org.sonar.api.resources.Scopes
Deprecated.
since 4.3 resources under FILE level are no more be supported since 4.2.
BLOCKER - org.sonar.api.batch.rule.Severity
 
BLOCKER - org.sonar.api.rules.RulePriority
Deprecated.
 
BLOCKER - Static variable in class org.sonar.api.rule.Severity
 
BLOCKER_VIOLATIONS - Static variable in class org.sonar.api.measures.CoreMetrics
 
BLOCKER_VIOLATIONS_KEY - Static variable in class org.sonar.api.measures.CoreMetrics
 
BOOL - org.sonar.api.measures.Metric.ValueType
 
BOOLEAN - org.sonar.api.PropertyType
True/False
BOOLEAN - org.sonar.api.web.WidgetPropertyType
Deprecated.
True/False
BOOLEAN - Static variable in class org.sonar.api.server.rule.RuleParamType
 
Branch - Interface in org.sonar.api.ce.posttask
 
BRANCH_COVERAGE - Static variable in class org.sonar.api.measures.CoreMetrics
 
BRANCH_COVERAGE_KEY - Static variable in class org.sonar.api.measures.CoreMetrics
 
Branch.Type - Enum in org.sonar.api.ce.posttask
 
branchChangedFiles(String, Path) - Method in class org.sonar.api.batch.scm.ScmProvider
Return absolute path of the files changed in the current branch, compared to the provided target branch.
branchChangedLines(String, Path, Set<Path>) - Method in class org.sonar.api.batch.scm.ScmProvider
Return a map between paths given as argument and the corresponding line numbers which are new compared to the provided target branch.
BUG - org.sonar.api.rules.RuleType
 
BUGS - Static variable in class org.sonar.api.measures.CoreMetrics
SonarQube Quality Model
BUGS_KEY - Static variable in class org.sonar.api.measures.CoreMetrics
SonarQube Quality Model
build() - Method in interface org.sonar.api.ce.measure.MeasureComputer.MeasureComputerDefinition.Builder
 
build() - Method in class org.sonar.api.ce.measure.RangeDistributionBuilder
Used to build a measure from the current object
build() - Method in class org.sonar.api.ce.measure.test.TestIssue.Builder
 
build() - Method in class org.sonar.api.ce.measure.test.TestMeasureComputerDefinition.MeasureComputerDefinitionBuilderImpl
 
build() - Method in class org.sonar.api.ce.posttask.PostProjectAnalysisTaskTester.AnalysisBuilder
 
build() - Method in class org.sonar.api.ce.posttask.PostProjectAnalysisTaskTester.BranchBuilder
 
build() - Method in class org.sonar.api.ce.posttask.PostProjectAnalysisTaskTester.CeTaskBuilder
 
build() - Method in class org.sonar.api.ce.posttask.PostProjectAnalysisTaskTester.OrganizationBuilder
 
build() - Method in class org.sonar.api.ce.posttask.PostProjectAnalysisTaskTester.ProjectAnalysisBuilder
 
build() - Method in class org.sonar.api.ce.posttask.PostProjectAnalysisTaskTester.ProjectBuilder
 
build() - Method in class org.sonar.api.ce.posttask.PostProjectAnalysisTaskTester.QualityGateBuilder
 
build() - Method in class org.sonar.api.ce.posttask.PostProjectAnalysisTaskTester.ScannerContextBuilder
 
build() - Method in class org.sonar.api.config.PropertyDefinition.Builder
 
build() - Method in class org.sonar.api.config.PropertyFieldDefinition.Builder
 
build() - Method in class org.sonar.api.platform.NewUserHandler.Context.Builder
 
build() - Method in class org.sonar.api.resources.ResourceType.Builder
Creates an instance of ResourceType based on all information given to the builder.
build() - Method in class org.sonar.api.resources.ResourceTypeTree.Builder
 
build() - Method in class org.sonar.api.server.authentication.Display.Builder
 
build() - Method in class org.sonar.api.server.authentication.UserIdentity.Builder
 
build() - Method in class org.sonar.api.task.TaskDefinition.Builder
Deprecated.
 
build() - Method in class org.sonar.api.user.UserQuery.Builder
 
build() - Method in class org.sonar.api.web.page.Page.Builder
 
build() - Method in class org.sonar.api.web.ServletFilter.UrlPattern.Builder
 
build(String) - Static method in class org.sonar.api.config.PropertyFieldDefinition
 
build(ProjectBuilder.Context) - Method in class org.sonar.api.batch.bootstrap.ProjectBuilder
Deprecated.
Override this method to change project reactor structure.
build(ProjectReactor) - Method in class org.sonar.api.batch.bootstrap.ProjectBuilder
Deprecated.
since 3.7 override ProjectBuilder.build(Context) instead
build(QualityGate.EvaluationStatus, String) - Method in class org.sonar.api.ce.posttask.PostProjectAnalysisTaskTester.ConditionBuilder
 
BUILD_STRING_PROPERTY - Static variable in interface org.sonar.api.CoreProperties
 
builder() - Static method in class org.sonar.api.platform.NewUserHandler.Context
 
builder() - Static method in class org.sonar.api.resources.ResourceTypeTree
 
builder() - Static method in class org.sonar.api.server.authentication.Display
 
builder() - Static method in class org.sonar.api.server.authentication.UserIdentity
 
builder() - Static method in class org.sonar.api.task.TaskDefinition
Deprecated.
 
builder() - Static method in class org.sonar.api.user.UserQuery
 
builder() - Static method in class org.sonar.api.web.ServletFilter.UrlPattern
 
builder(String) - Static method in class org.sonar.api.config.PropertyDefinition
 
builder(String) - Static method in class org.sonar.api.resources.ResourceType
Creates a new ResourceType.Builder
builder(String) - Static method in class org.sonar.api.web.page.Page
 
Builder() - Constructor for class org.sonar.api.ce.measure.test.TestIssue.Builder
 
Builder(String) - Constructor for class org.sonar.api.resources.ResourceType.Builder
Creates a new ResourceType.Builder
Builder(String, String, Metric.ValueType) - Constructor for class org.sonar.api.measures.Metric.Builder
Creates a new Metric.Builder object.
buildNoValue() - Method in class org.sonar.api.ce.posttask.PostProjectAnalysisTaskTester.ConditionBuilder
 
buildNumber() - Method in class org.sonar.api.utils.Version
Build number if the fourth field, for example 12345 for "6.3.0.12345".
BuiltInQualityProfileAnnotationLoader - Class in org.sonar.api.server.profile
Read definitions of quality profiles based on the annotation BelongsToProfile provided by sonar-check-api.
BuiltInQualityProfileAnnotationLoader() - Constructor for class org.sonar.api.server.profile.BuiltInQualityProfileAnnotationLoader
 
BuiltInQualityProfilesDefinition - Interface in org.sonar.api.server.profile
Define built-in quality profiles which are automatically registered during SonarQube startup.
BuiltInQualityProfilesDefinition.BuiltInActiveRule - Class in org.sonar.api.server.profile
A rule activated on a built in quality profile.
BuiltInQualityProfilesDefinition.BuiltInQualityProfile - Interface in org.sonar.api.server.profile
 
BuiltInQualityProfilesDefinition.BuiltInQualityProfileImpl - Class in org.sonar.api.server.profile
 
BuiltInQualityProfilesDefinition.Context - Class in org.sonar.api.server.profile
Instantiated by core but not by plugins, except for their tests.
BuiltInQualityProfilesDefinition.NewBuiltInActiveRule - Class in org.sonar.api.server.profile
 
BuiltInQualityProfilesDefinition.NewBuiltInQualityProfile - Interface in org.sonar.api.server.profile
 
BuiltInQualityProfilesDefinition.NewBuiltInQualityProfileImpl - Class in org.sonar.api.server.profile
 
BuiltInQualityProfilesDefinition.NewOverriddenParam - Class in org.sonar.api.server.profile
 
BuiltInQualityProfilesDefinition.OverriddenParam - Class in org.sonar.api.server.profile
 

C

call(LocalConnector.LocalRequest) - Method in interface org.sonar.api.server.ws.LocalConnector
 
callback(OAuth2IdentityProvider.CallbackContext) - Method in interface org.sonar.api.server.authentication.OAuth2IdentityProvider
This method is called when the identity provider has authenticated a user.
canonicalPath(File) - Static method in class org.sonar.api.utils.PathUtils
Get canonical path and replace file separators by forward slash.
category() - Method in class org.sonar.api.config.PropertyDefinition
Category where the property appears in settings pages.
category() - Method in annotation type org.sonar.api.Property
 
category(String) - Method in class org.sonar.api.config.PropertyDefinition.Builder
 
Category - Class in org.sonar.api.config
 
CATEGORY_CODE_COVERAGE - Static variable in interface org.sonar.api.CoreProperties
 
CATEGORY_EXCLUSIONS - Static variable in interface org.sonar.api.CoreProperties
 
CATEGORY_EXTERNAL_ISSUES - Static variable in interface org.sonar.api.CoreProperties
 
CATEGORY_GENERAL - Static variable in interface org.sonar.api.CoreProperties
 
CATEGORY_JAVA - Static variable in interface org.sonar.api.CoreProperties
Deprecated.
since 6.0
CATEGORY_LICENSES - Static variable in interface org.sonar.api.CoreProperties
 
CATEGORY_SCM - Static variable in interface org.sonar.api.CoreProperties
 
CATEGORY_SECURITY - Static variable in interface org.sonar.api.CoreProperties
 
CATEGORY_TECHNICAL_DEBT - Static variable in interface org.sonar.api.CoreProperties
 
CeTask - Interface in org.sonar.api.ce.posttask
 
CeTask.Status - Enum in org.sonar.api.ce.posttask
 
Change - Class in org.sonar.api.server.ws
Used to describe the changes that occurred on a web service action
Change(String, String) - Constructor for class org.sonar.api.server.ws.Change
 
CHANGEABILITY_COMPLIANCE - Static variable in class org.sonar.api.server.rule.RulesDefinition.SubCharacteristics
Deprecated.
Related to characteristic CHANGEABILITY
CHANGED - org.sonar.api.batch.fs.InputFile.Status
Deprecated.
 
changelog() - Method in class org.sonar.api.server.ws.WebService.Action
 
charset() - Method in interface org.sonar.api.batch.fs.InputFile
Charset to be used to decode this specific file.
checkArgument(boolean) - Static method in class org.sonar.api.utils.Preconditions
 
checkArgument(boolean, String) - Static method in class org.sonar.api.utils.Preconditions
 
checkArgument(boolean, String, Object...) - Static method in class org.sonar.api.utils.Preconditions
 
CheckFactory - Class in org.sonar.api.batch.rule
Creates Checks.
CheckFactory(ActiveRules) - Constructor for class org.sonar.api.batch.rule.CheckFactory
 
checkNotNull(Object) - Static method in class org.sonar.api.utils.Preconditions
 
Checks<C> - Class in org.sonar.api.batch.rule
Instantiates checks (objects that provide implementation of coding rules) that use sonar-check-api annotations.
checkState(boolean, String) - Static method in class org.sonar.api.utils.Preconditions
 
checkState(boolean, String, Object...) - Static method in class org.sonar.api.utils.Preconditions
 
CLASS_COMPLEXITY - Static variable in class org.sonar.api.measures.CoreMetrics
Deprecated.
since 6.7
CLASS_COMPLEXITY_KEY - Static variable in class org.sonar.api.measures.CoreMetrics
Deprecated.
since 6.7
CLASSES - Static variable in class org.sonar.api.measures.CoreMetrics
 
CLASSES_KEY - Static variable in class org.sonar.api.measures.CoreMetrics
 
clean() - Method in interface org.sonar.api.batch.scm.IgnoreCommand
To be called after the last call to IgnoreCommand.isIgnored(Path).
clear() - Method in class org.sonar.api.utils.log.ListInterceptor
 
clear() - Method in class org.sonar.api.utils.log.LogTester
 
clearConditions() - Method in class org.sonar.api.ce.posttask.PostProjectAnalysisTaskTester.QualityGateBuilder
 
clone() - Method in class org.sonar.api.profiles.RulesProfile
 
clone() - Method in class org.sonar.api.rules.ActiveRule
 
clone() - Method in class org.sonar.api.rules.ActiveRuleParam
 
close() - Method in class org.sonar.api.utils.text.CsvWriter
 
close() - Method in class org.sonar.api.utils.text.JsonWriter
 
close() - Method in class org.sonar.api.utils.text.XmlWriter
 
close(AutoCloseable) - Method in class org.sonar.api.utils.System2
Closes the object and throws an IllegalStateException on error.
CLOSE - Static variable in interface org.sonar.api.issue.DefaultTransitions
 
closeDate() - Method in interface org.sonar.api.issue.Issue
Date when status was set to Issue.STATUS_CLOSED, else null.
CODE_SMELL - org.sonar.api.rules.RuleType
 
CODE_SMELLS - Static variable in class org.sonar.api.measures.CoreMetrics
SonarQube Quality Model
CODE_SMELLS_KEY - Static variable in class org.sonar.api.measures.CoreMetrics
SonarQube Quality Model
CODEVIEWER - Static variable in annotation type org.sonar.api.web.UserRole
 
coefficient() - Method in interface org.sonar.api.server.debt.DebtRemediationFunction
Deprecated.
coefficient() - Method in class org.sonar.api.server.debt.internal.DefaultDebtRemediationFunction
Deprecated.
COGNITIVE_COMPLEXITY - Static variable in class org.sonar.api.measures.CoreMetrics
 
COGNITIVE_COMPLEXITY_KEY - Static variable in class org.sonar.api.measures.CoreMetrics
 
Command - Class in org.sonar.api.utils.command
 
CommandException - Exception in org.sonar.api.utils.command
 
CommandException(Command, String, Throwable) - Constructor for exception org.sonar.api.utils.command.CommandException
 
CommandException(Command, Throwable) - Constructor for exception org.sonar.api.utils.command.CommandException
 
CommandExecutor - Class in org.sonar.api.utils.command
Synchronously execute a native command line.
COMMENT - org.sonar.api.batch.sensor.highlighting.TypeOfText
 
COMMENT_LINES - Static variable in class org.sonar.api.measures.CoreMetrics
 
COMMENT_LINES_DATA - Static variable in class org.sonar.api.measures.CoreMetrics
Deprecated.
in 7.3. Measures are no longer sent within analysis reports, and by consequence no longer persisted nor available from web API.
COMMENT_LINES_DATA_KEY - Static variable in class org.sonar.api.measures.CoreMetrics
Deprecated.
in 7.3. Measures are no longer sent within analysis reports, and by consequence no longer persisted nor available from web API.
COMMENT_LINES_DENSITY - Static variable in class org.sonar.api.measures.CoreMetrics
 
COMMENT_LINES_DENSITY_KEY - Static variable in class org.sonar.api.measures.CoreMetrics
Moved to Size domain since 6.2
COMMENT_LINES_KEY - Static variable in class org.sonar.api.measures.CoreMetrics
Moved to Size domain since 6.2
comments() - Method in interface org.sonar.api.issue.Issue
Deprecated.
since 7.2, comments are not more available
COMMUNITY - org.sonar.api.SonarEdition
 
compareTo(RuleKey) - Method in class org.sonar.api.rule.RuleKey
 
compareTo(TaskDefinition) - Method in class org.sonar.api.task.TaskDefinition
Deprecated.
 
compareTo(Node) - Method in class org.sonar.api.utils.dag.Node
 
compareTo(Version) - Method in class org.sonar.api.utils.Version
 
COMPILER_RELATED_PORTABILITY - Static variable in class org.sonar.api.server.rule.RulesDefinition.SubCharacteristics
Deprecated.
Related to characteristic PORTABILITY
COMPLEXITY - Static variable in class org.sonar.api.measures.CoreMetrics
 
COMPLEXITY_IN_CLASSES - Static variable in class org.sonar.api.measures.CoreMetrics
Deprecated.
since 6.7
COMPLEXITY_IN_CLASSES_KEY - Static variable in class org.sonar.api.measures.CoreMetrics
Deprecated.
since 6.7
COMPLEXITY_IN_FUNCTIONS - Static variable in class org.sonar.api.measures.CoreMetrics
Deprecated.
since 6.7
COMPLEXITY_IN_FUNCTIONS_KEY - Static variable in class org.sonar.api.measures.CoreMetrics
Deprecated.
since 6.7
COMPLEXITY_KEY - Static variable in class org.sonar.api.measures.CoreMetrics
 
Component - Interface in org.sonar.api.ce.measure
Component that can be used in a MeasureComputer
COMPONENT - org.sonar.api.web.page.Page.Scope
 
Component.FileAttributes - Interface in org.sonar.api.ce.measure
 
Component.Type - Enum in org.sonar.api.ce.measure
 
componentKey() - Method in interface org.sonar.api.batch.postjob.issue.PostJobIssue
Component key like foo:src/Foo.php
componentKey() - Method in interface org.sonar.api.issue.Issue
Components are modules ("my_project"), directories ("my_project:my/dir") or files ("my_project:my/file.c").
componentKey() - Method in interface org.sonar.api.scan.issue.filter.FilterableIssue
Deprecated.
since 7.6 filtering issue should not depend on the key
componentUuid() - Method in interface org.sonar.api.issue.Issue
 
compute(MeasureComputer.MeasureComputerContext) - Method in interface org.sonar.api.ce.measure.MeasureComputer
This method will be called on each component of the projects.
COMPUTE_ENGINE - org.sonar.api.SonarQubeSide
 
ComputeEngineSide - Annotation Type in org.sonar.api.ce
Same as ScannerSide but for components for the Compute Engine Server.
conditions(int, int, int) - Method in interface org.sonar.api.batch.sensor.coverage.NewCoverage
Call this method as many time as needed to report coverage of conditions.
CONDITIONS_TO_COVER - Static variable in class org.sonar.api.measures.CoreMetrics
 
CONDITIONS_TO_COVER_KEY - Static variable in class org.sonar.api.measures.CoreMetrics
 
config() - Method in interface org.sonar.api.batch.postjob.PostJobContext
Get configuration of the current project.
config() - Method in interface org.sonar.api.batch.sensor.SensorContext
Get settings of the project.
Configuration - Interface in org.sonar.api.config
Component to get effective configuration.
CONFIGURATION - org.sonar.api.web.Section
Deprecated.
 
CONFIGURATION - Static variable in annotation type org.sonar.api.web.NavigationSection
Deprecated.
 
CONFIRM - Static variable in interface org.sonar.api.issue.DefaultTransitions
 
CONFIRMED_ISSUES - Static variable in class org.sonar.api.measures.CoreMetrics
 
CONFIRMED_ISSUES_KEY - Static variable in class org.sonar.api.measures.CoreMetrics
 
CONSTANT - org.sonar.api.batch.sensor.highlighting.TypeOfText
 
CONSTANT_ISSUE - org.sonar.api.server.debt.DebtRemediationFunction.Type
The cost to fix all the issues of the rule is the same whatever the number of issues of this rule in the file.
constantPerIssue(String) - Method in interface org.sonar.api.server.rule.RulesDefinition.DebtRemediationFunctions
Shortcut for create(Type.CONSTANT_ISSUE, null, base effort).
consumeLine(String) - Method in interface org.sonar.api.utils.command.StreamConsumer
 
consumeLine(String) - Method in class org.sonar.api.utils.command.StringStreamConsumer
 
contents() - Method in interface org.sonar.api.batch.fs.InputFile
Fetches the entire contents of the file, decoding with the InputFile.charset().
Context - Class in org.sonar.api.web.page
 
Context() - Constructor for class org.sonar.api.server.profile.BuiltInQualityProfilesDefinition.Context
 
Context() - Constructor for class org.sonar.api.server.rule.RulesDefinition.Context
 
Context() - Constructor for class org.sonar.api.server.ws.WebService.Context
 
Context() - Constructor for class org.sonar.api.web.page.Context
 
Context(String, String, HttpServletRequest) - Constructor for class org.sonar.api.security.Authenticator.Context
 
Context(String, HttpServletRequest) - Constructor for class org.sonar.api.security.ExternalGroupsProvider.Context
 
Context(String, HttpServletRequest) - Constructor for class org.sonar.api.security.ExternalUsersProvider.Context
 
Context(SonarRuntime) - Constructor for class org.sonar.api.Plugin.Context
For unit tests only.
controller(String) - Method in class org.sonar.api.server.ws.WebService.Context
 
controllers() - Method in class org.sonar.api.server.ws.WebService.Context
 
convert(Collection<String>) - Static method in class org.sonar.api.server.rule.RuleTagsToTypeConverter
 
Converter() - Constructor for class org.sonar.api.utils.KeyValueFormat.Converter
 
CORE_ALLOW_USERS_TO_SIGNUP_DEAULT_VALUE - Static variable in interface org.sonar.api.CoreProperties
 
CORE_ALLOW_USERS_TO_SIGNUP_PROPERTY - Static variable in interface org.sonar.api.CoreProperties
Deprecated.
since 6.3. This feature is not supported anymore
CORE_AUTHENTICATOR_CLASS - Static variable in interface org.sonar.api.CoreProperties
Deprecated.
since 2.14. See http://jira.sonarsource.com/browse/SONAR-3153. Replaced by CoreProperties.CORE_AUTHENTICATOR_REALM.
CORE_AUTHENTICATOR_CREATE_USERS - Static variable in interface org.sonar.api.CoreProperties
Deprecated.
since 6.3. This feature is not supported anymore
CORE_AUTHENTICATOR_IGNORE_STARTUP_FAILURE - Static variable in interface org.sonar.api.CoreProperties
Deprecated.
since 7.1, this setting should not be used by plugin
CORE_AUTHENTICATOR_LOCAL_USERS - Static variable in interface org.sonar.api.CoreProperties
Deprecated.
no more used since 5.5
CORE_AUTHENTICATOR_REALM - Static variable in interface org.sonar.api.CoreProperties
Deprecated.
since 7.1, this setting should not be used by plugin
CORE_AUTHENTICATOR_UPDATE_USER_ATTRIBUTES - Static variable in interface org.sonar.api.CoreProperties
Deprecated.
since 5.4. This feature is not supported anymore. See http://jira.sonarsource.com/browse/SONAR-7219
CORE_DEFAULT_GROUP - Static variable in interface org.sonar.api.CoreProperties
Deprecated.
since 6.4. The default group is hardcoded to 'sonar-users'
CORE_DEFAULT_GROUP_DEFAULT_VALUE - Static variable in interface org.sonar.api.CoreProperties
Deprecated.
since 6.4. The default group is hardcoded to 'sonar-users'
CORE_FORCE_AUTHENTICATION_DEFAULT_VALUE - Static variable in interface org.sonar.api.CoreProperties
 
CORE_FORCE_AUTHENTICATION_PROPERTY - Static variable in interface org.sonar.api.CoreProperties
 
CORE_PREVENT_AUTOMATIC_PROJECT_CREATION - Static variable in interface org.sonar.api.CoreProperties
Deprecated.
replaced in 5.2 by the permission 'provisioning'
CoreMetrics - Class in org.sonar.api.measures
 
CoreProperties - Interface in org.sonar.api
Non-exhaustive list of constants of core properties.
countCoveredLines() - Method in interface org.sonar.api.test.TestCase
Deprecated.
 
countTestCasesOfLine(Integer) - Method in interface org.sonar.api.test.Testable
Deprecated.
 
COVERAGE - Static variable in class org.sonar.api.measures.CoreMetrics
 
COVERAGE_KEY - Static variable in class org.sonar.api.measures.CoreMetrics
 
CoverageAlreadyExistsException - Exception in org.sonar.api.test.exception
Deprecated.
since 5.6 feature will be removed soon
CoverageAlreadyExistsException(String) - Constructor for exception org.sonar.api.test.exception.CoverageAlreadyExistsException
Deprecated.
 
coverageBlock(Testable) - Method in interface org.sonar.api.test.TestCase
Deprecated.
 
coverageBlock(TestCase) - Method in interface org.sonar.api.test.Testable
Deprecated.
 
CoverageBlock - Interface in org.sonar.api.test
Deprecated.
since 5.6. Feature will be removed without any alternatives.
coverageBlocks() - Method in interface org.sonar.api.test.Testable
Deprecated.
 
coverageBlocks() - Method in interface org.sonar.api.test.TestCase
Deprecated.
 
CoverageType - Enum in org.sonar.api.batch.sensor.coverage
Deprecated.
since 6.2 SonarQube merge all coverage reports and don't keep track of different test category
CPD_CROSS_PROJECT - Static variable in interface org.sonar.api.CoreProperties
Deprecated.
since 6.7
CPD_EXCLUSIONS - Static variable in interface org.sonar.api.CoreProperties
 
CPP_DOC - org.sonar.api.batch.sensor.highlighting.TypeOfText
Deprecated.
CPU_EFFICIENCY - Static variable in class org.sonar.api.server.rule.RulesDefinition.SubCharacteristics
Deprecated.
Related to characteristic EFFICIENCY
create() - Static method in class org.sonar.api.batch.bootstrap.ProjectDefinition
Deprecated.
 
create() - Method in class org.sonar.api.measures.Metric.Builder
Creates a new metric definition based on the properties set on this metric builder.
create() - Static method in class org.sonar.api.profiles.RulesProfile
 
create() - Static method in class org.sonar.api.rules.Rule
 
create() - Static method in class org.sonar.api.rules.RuleQuery
 
create() - Static method in class org.sonar.api.utils.command.CommandExecutor
 
create() - Static method in class org.sonar.api.utils.ValidationMessages
 
create() - Static method in class org.sonar.api.web.Dashboard
Deprecated.
Creates a new Dashboard.
create(int, int) - Static method in class org.sonar.api.utils.Version
 
create(int, int, int) - Static method in class org.sonar.api.utils.Paging
Deprecated.
since 5.2 please use the #forPgeIndex(...) builder method
create(int, int, int) - Static method in class org.sonar.api.utils.Version
 
create(int, int, int, String) - Static method in class org.sonar.api.utils.Version
Deprecated.
in 6.3 to avoid ambiguity with build number (see Version.buildNumber()
create(long) - Static method in class org.sonar.api.utils.Duration
Create a Duration from a number of minutes.
create(long) - Method in class org.sonar.api.utils.Durations
Create a Duration object from a number of minutes
create(String) - Method in class org.sonar.api.batch.rule.CheckFactory
 
create(String) - Static method in class org.sonar.api.utils.command.Command
Create a command line without any arguments
create(String) - Static method in class org.sonar.api.utils.WildcardPattern
Creates pattern with "/" as a directory separator.
create(String) - Static method in class org.sonar.api.web.ServletFilter.UrlPattern
Defines only a single inclusion pattern.
create(String[]) - Static method in class org.sonar.api.utils.WildcardPattern
Creates array of patterns with "/" as a directory separator.
create(String, String) - Static method in class org.sonar.api.config.GlobalPropertyChangeHandler.PropertyChange
 
create(String, String) - Static method in class org.sonar.api.profiles.RulesProfile
 
create(String, String) - Static method in class org.sonar.api.rules.Rule
Create with all required fields
create(String, String) - Static method in class org.sonar.api.utils.WildcardPattern
Creates pattern with specified separator for directories.
create(String, String, String) - Static method in class org.sonar.api.rules.Rule
Create with all required fields
create(DebtRemediationFunction.Type, String, String) - Method in interface org.sonar.api.server.rule.RulesDefinition.DebtRemediationFunctions
Flexible way to create a DebtRemediationFunction.
create(Logger) - Static method in class org.sonar.api.utils.log.Profiler
 
createAction(String) - Method in class org.sonar.api.server.ws.WebService.NewController
 
createBuiltInQualityProfile(String, String) - Method in class org.sonar.api.server.profile.BuiltInQualityProfilesDefinition.Context
createController(String) - Method in class org.sonar.api.server.ws.WebService.Context
Create a new controller.
createDashboard() - Method in class org.sonar.api.web.DashboardTemplate
Deprecated.
Returns the Dashboard object that represents the dashboard to use.
createdAt() - Method in interface org.sonar.api.issue.IssueComment
Deprecated.
 
createExternalRepository(String, String) - Method in class org.sonar.api.server.rule.RulesDefinition.AbstractContext
Creates a repository of rules from external rule engines.
createExternalRepository(String, String) - Method in class org.sonar.api.server.rule.RulesDefinition.Context
 
createFieldsParam(Collection<?>) - Method in class org.sonar.api.server.ws.WebService.NewAction
 
createFor(InputFile) - Method in interface org.sonar.api.measures.FileLinesContextFactory
 
createIfDebug(Logger) - Static method in class org.sonar.api.utils.log.Profiler
 
createIfTrace(Logger) - Static method in class org.sonar.api.utils.log.Profiler
 
createIssuesForRuleRepositories(String...) - Method in interface org.sonar.api.batch.sensor.SensorDescriptor
List rule repositories this Sensor create issues for.
createIssuesForRuleRepository(String...) - Method in interface org.sonar.api.batch.sensor.SensorDescriptor
Rule repository this Sensor create issues for.
createMeasure(boolean) - Static method in class org.sonar.api.ce.measure.test.TestMeasure
 
createMeasure(double) - Static method in class org.sonar.api.ce.measure.test.TestMeasure
 
createMeasure(int) - Static method in class org.sonar.api.ce.measure.test.TestMeasure
 
createMeasure(long) - Static method in class org.sonar.api.ce.measure.test.TestMeasure
 
createMeasure(String) - Static method in class org.sonar.api.ce.measure.test.TestMeasure
 
createPageParam() - Method in class org.sonar.api.server.ws.WebService.NewAction
 
createPageSize(int, int) - Method in class org.sonar.api.server.ws.WebService.NewAction
 
createParam(String) - Method in class org.sonar.api.server.rule.RulesDefinition.NewRule
Create a parameter with given unique key.
createParam(String) - Method in class org.sonar.api.server.ws.WebService.NewAction
 
createParameter() - Method in class org.sonar.api.rules.Rule
 
createParameter(String) - Method in class org.sonar.api.rules.Rule
 
createProfile(ValidationMessages) - Method in class org.sonar.api.profiles.ProfileDefinition
Deprecated.
 
createRepository(String, String) - Method in class org.sonar.api.server.rule.RulesDefinition.AbstractContext
 
createRepository(String, String) - Method in class org.sonar.api.server.rule.RulesDefinition.Context
 
createRule(String) - Method in class org.sonar.api.server.rule.internal.DefaultNewRepository
 
createRule(String) - Method in interface org.sonar.api.server.rule.RulesDefinition.NewExtendedRepository
Create a rule with specified key.
createRules() - Method in class org.sonar.api.rules.RuleRepository
Deprecated.
 
createSearchQuery(String, String...) - Method in class org.sonar.api.server.ws.WebService.NewAction
Creates the parameter WebService.Param.TEXT_QUERY, which is used to search for a subset of fields containing the supplied string.
createSortParams(Collection<V>, V, boolean) - Method in class org.sonar.api.server.ws.WebService.NewAction
Add predefined parameters related to sorting of results.
creationDate() - Method in interface org.sonar.api.issue.Issue
 
creationDate() - Method in interface org.sonar.api.scan.issue.filter.FilterableIssue
Deprecated.
since 6.6 useless since creation date is computed on server side
CRITICAL - org.sonar.api.batch.rule.Severity
 
CRITICAL - org.sonar.api.rules.RulePriority
Deprecated.
 
CRITICAL - Static variable in class org.sonar.api.rule.Severity
 
CRITICAL_VIOLATIONS - Static variable in class org.sonar.api.measures.CoreMetrics
 
CRITICAL_VIOLATIONS_KEY - Static variable in class org.sonar.api.measures.CoreMetrics
 
cssClass() - Method in enum org.sonar.api.batch.sensor.highlighting.TypeOfText
For internal use
CsvWriter - Class in org.sonar.api.utils.text
 
currentPluginKey() - Method in class org.sonar.api.server.rule.RulesDefinition.Context
 
CyclicDependenciesException - Exception in org.sonar.api.utils.dag
 
CyclicDependenciesException(String) - Constructor for exception org.sonar.api.utils.dag.CyclicDependenciesException
 

D

Dashboard - Class in org.sonar.api.web
Deprecated.
since 6.2, this extension is ignored as dashboards have been removed
Dashboard.Widget - Class in org.sonar.api.web
Deprecated.
Note that this class is an inner class to avoid confusion with the extension point org.sonar.api.web.Widget.
DashboardLayout - Enum in org.sonar.api.web
Deprecated.
since 6.2, this extension is ignored as dashboards have been removed
DashboardTemplate - Class in org.sonar.api.web
Deprecated.
since 6.2, this extension is ignored as dashboards have been removed
DashboardTemplate() - Constructor for class org.sonar.api.web.DashboardTemplate
Deprecated.
 
DATA - org.sonar.api.measures.Metric.ValueType
 
DATA_CHANGEABILITY - Static variable in class org.sonar.api.server.rule.RulesDefinition.SubCharacteristics
Deprecated.
Related to characteristic CHANGEABILITY
DATA_RELIABILITY - Static variable in class org.sonar.api.server.rule.RulesDefinition.SubCharacteristics
Deprecated.
Related to characteristic RELIABILITY
DatabaseProperties - Interface in org.sonar.api.database
Deprecated.
since 7.1, plugins don't connect to database
DATACENTER - org.sonar.api.SonarEdition
 
date() - Method in class org.sonar.api.batch.scm.BlameLine
 
date(Date) - Method in class org.sonar.api.batch.scm.BlameLine
Mandatory field
DATE_FORMAT - Static variable in class org.sonar.api.utils.DateUtils
 
DATETIME_FORMAT - Static variable in class org.sonar.api.utils.DateUtils
 
dateToLong(Date) - Static method in class org.sonar.api.utils.DateUtils
 
DateUtils - Class in org.sonar.api.utils
Parses and formats RFC 822 dates.
DAY - Static variable in class org.sonar.api.utils.Duration
 
debtRemediationFunction() - Method in class org.sonar.api.server.rule.internal.DefaultRule
 
debtRemediationFunction() - Method in class org.sonar.api.server.rule.RulesDefinition.Rule
 
DebtRemediationFunction - Interface in org.sonar.api.server.debt
Function used to calculate the remediation cost of an issue.
DebtRemediationFunction.Type - Enum in org.sonar.api.server.debt
 
debtRemediationFunctions() - Method in class org.sonar.api.server.rule.RulesDefinition.NewRule
debtSubCharacteristic() - Method in class org.sonar.api.server.rule.internal.DefaultRule
Deprecated.
debtSubCharacteristic() - Method in class org.sonar.api.server.rule.RulesDefinition.Rule
Deprecated.
in 5.5. SQALE Quality Model is replaced by SonarQube Quality Model. null is always returned. See https://jira.sonarsource.com/browse/MMF-184
debug(String) - Method in interface org.sonar.api.utils.log.Logger
Logs a DEBUG message.
debug(String, Object) - Method in interface org.sonar.api.utils.log.Logger
Logs an DEBUG parameterized message according to the specified format and argument.
debug(String, Object...) - Method in interface org.sonar.api.utils.log.Logger
Logs an DEBUG parameterized message according to the specified format and arguments.
debug(String, Object, Object) - Method in interface org.sonar.api.utils.log.Logger
Logs an DEBUG parameterized message according to the specified format and arguments.
debug(Supplier<String>) - Method in interface org.sonar.api.utils.log.Logger
Logs a DEBUG message which is only to be constructed if the logging level is such that the message will actually be logged.
DEBUG - org.sonar.api.utils.log.LoggerLevel
 
declaration() - Method in class org.sonar.api.utils.text.XmlWriter
 
decode(String) - Method in class org.sonar.api.utils.Durations
Convert the text to a Duration
Example : decode("9d 10 h") -> Duration.encode("10d2h")
decode(String, int) - Static method in class org.sonar.api.utils.Duration
Create a Duration from a text duration and the number of hours in a day.
decrypt(String) - Method in class org.sonar.api.config.Encryption
 
DEFAULT - org.sonar.api.batch.Phase.Name
 
DEFAULT - org.sonar.api.web.WidgetLayoutType
Deprecated.
 
DEFAULT_CONNECT_TIMEOUT_IN_MILLISECONDS - Static variable in class org.sonar.api.utils.HttpDownloader
 
DEFAULT_DECIMAL_SCALE - Static variable in class org.sonar.api.measures.Metric
 
DEFAULT_ISSUE_ASSIGNEE - Static variable in interface org.sonar.api.CoreProperties
 
DEFAULT_PRIORITY - Static variable in class org.sonar.api.rules.Rule
The default priority given to a rule if not explicitly set
DEFAULT_READ_TIMEOUT_IN_MILLISECONDS - Static variable in class org.sonar.api.utils.HttpDownloader
 
DefaultDebtRemediationFunction - Class in org.sonar.api.server.debt.internal
 
DefaultDebtRemediationFunction(DebtRemediationFunction.Type, String, String) - Constructor for class org.sonar.api.server.debt.internal.DefaultDebtRemediationFunction
 
DefaultGroups - Class in org.sonar.api.security
Name of the default user groups
DefaultNewParam - Class in org.sonar.api.server.rule.internal
 
DefaultNewRepository - Class in org.sonar.api.server.rule.internal
 
DefaultNewRepository(RulesDefinition.Context, String, String, boolean) - Constructor for class org.sonar.api.server.rule.internal.DefaultNewRepository
 
DefaultParam - Class in org.sonar.api.server.rule.internal
 
DefaultRepository - Class in org.sonar.api.server.rule.internal
 
DefaultRepository(DefaultNewRepository, RulesDefinition.Repository) - Constructor for class org.sonar.api.server.rule.internal.DefaultRepository
 
DefaultRule - Class in org.sonar.api.server.rule.internal
 
defaultScope() - Static method in enum org.sonar.api.rule.RuleScope
 
defaultSeverity() - Static method in class org.sonar.api.rule.Severity
 
defaultStatus() - Static method in enum org.sonar.api.rule.RuleStatus
 
DefaultTab - Annotation Type in org.sonar.api.web
Deprecated.
since 6.3 see PageDefinition. This class is ignored.
DefaultTransitions - Interface in org.sonar.api.issue
 
defaultValue() - Method in class org.sonar.api.config.PropertyDefinition
 
defaultValue() - Method in annotation type org.sonar.api.Property
The empty string "" is considered as null, so it's not possible to have empty strings for default values.
defaultValue() - Method in class org.sonar.api.server.rule.internal.DefaultNewParam
 
defaultValue() - Method in class org.sonar.api.server.rule.internal.DefaultParam
 
defaultValue() - Method in interface org.sonar.api.server.rule.RulesDefinition.Param
 
defaultValue() - Method in class org.sonar.api.server.ws.WebService.Param
 
defaultValue() - Method in annotation type org.sonar.api.web.WidgetProperty
Deprecated.
 
defaultValue(String) - Method in class org.sonar.api.config.PropertyDefinition.Builder
 
Definable<T> - Interface in org.sonar.api.server.ws
 
define(MeasureComputer.MeasureComputerDefinitionContext) - Method in interface org.sonar.api.ce.measure.MeasureComputer
Use to define which metrics are required to compute some measures on some given metrics
define(Plugin.Context) - Method in interface org.sonar.api.Plugin
This method is executed at runtime when: Web Server starts Compute Engine starts Scanner starts
define(Plugin.Context) - Method in class org.sonar.api.SonarPlugin
Deprecated.
 
define(BuiltInQualityProfilesDefinition.Context) - Method in interface org.sonar.api.server.profile.BuiltInQualityProfilesDefinition
This method is executed when server is started.
define(RulesDefinition.Context) - Method in interface org.sonar.api.server.rule.RulesDefinition
This method is executed when server is started.
define(WebService.Context) - Method in interface org.sonar.api.server.ws.WebService
Executed once at server startup.
define(Context) - Method in interface org.sonar.api.web.page.PageDefinition
This method is executed when server is started
define(T) - Method in interface org.sonar.api.server.ws.Definable
 
definitions() - Static method in class org.sonar.api.config.EmailSettings
 
deliver(Notification, String) - Method in class org.sonar.api.notifications.NotificationChannel
Deprecated.
Implements the delivery of the given notification to the given user.
DependedUpon - Annotation Type in org.sonar.api.batch
 
DependsUpon - Annotation Type in org.sonar.api.batch
 
DEPRECATED - org.sonar.api.rule.RuleStatus
 
deprecatedKey() - Method in class org.sonar.api.config.PropertyDefinition
 
deprecatedKey() - Method in annotation type org.sonar.api.Property
Relocation of key.
deprecatedKey() - Method in class org.sonar.api.server.ws.WebService.Action
 
deprecatedKey() - Method in class org.sonar.api.server.ws.WebService.Param
 
deprecatedKey(String) - Method in class org.sonar.api.config.PropertyDefinition.Builder
 
deprecatedKeySince() - Method in class org.sonar.api.server.ws.WebService.Param
 
deprecatedRuleKeys() - Method in class org.sonar.api.server.rule.internal.DefaultRule
 
deprecatedRuleKeys() - Method in class org.sonar.api.server.rule.RulesDefinition.Rule
Deprecated rules keys for this rule.
deprecatedSince() - Method in class org.sonar.api.server.ws.WebService.Action
 
deprecatedSince() - Method in class org.sonar.api.server.ws.WebService.Param
 
describe(PostJobDescriptor) - Method in interface org.sonar.api.batch.postjob.PostJob
Populate PostJobDescriptor of this PostJob.
describe(SensorDescriptor) - Method in interface org.sonar.api.batch.sensor.Sensor
Populate SensorDescriptor of this sensor.
describe(SensorDescriptor) - Method in interface org.sonar.api.scanner.sensor.ProjectSensor
Populate SensorDescriptor of this sensor.
description() - Method in interface org.sonar.api.batch.rule.Rule
 
description() - Method in interface org.sonar.api.batch.rule.RuleParam
 
description() - Method in interface org.sonar.api.batch.sensor.rule.AdHocRule
Description of the rule.
description() - Method in class org.sonar.api.config.PropertyDefinition
 
description() - Method in class org.sonar.api.config.PropertyFieldDefinition
 
description() - Method in annotation type org.sonar.api.Property
 
description() - Method in annotation type org.sonar.api.PropertyField
If not empty, this description will be displayed on the Settings page.
description() - Method in class org.sonar.api.server.rule.internal.DefaultNewParam
 
description() - Method in class org.sonar.api.server.rule.internal.DefaultParam
 
description() - Method in interface org.sonar.api.server.rule.RulesDefinition.Param
 
description() - Method in class org.sonar.api.server.ws.WebService.Action
 
description() - Method in class org.sonar.api.server.ws.WebService.Controller
 
description() - Method in class org.sonar.api.server.ws.WebService.Param
 
description() - Method in class org.sonar.api.task.TaskDefinition
Deprecated.
 
description() - Method in annotation type org.sonar.api.web.WidgetProperty
Deprecated.
 
description(String) - Method in interface org.sonar.api.batch.sensor.rule.NewAdHocRule
The description of the rule.
description(String) - Method in class org.sonar.api.config.PropertyDefinition.Builder
 
description(String) - Method in class org.sonar.api.config.PropertyFieldDefinition.Builder
 
description(String) - Method in class org.sonar.api.task.TaskDefinition.Builder
Deprecated.
 
description(URI) - Method in class org.sonar.api.utils.UriReader
Returns a detailed description of the given uri.
description(URI) - Method in class org.sonar.api.utils.UriReader.SchemeProcessor
 
Description - Annotation Type in org.sonar.api.web
Deprecated.
since 6.3 see PageDefinition. This class is ignored.
DESELECTED - org.sonar.api.server.ws.WebService.SelectionMode
 
DEVELOPER - org.sonar.api.SonarEdition
 
DEVELOPMENT_COST - Static variable in interface org.sonar.api.CoreProperties
 
DEVELOPMENT_COST - Static variable in class org.sonar.api.measures.CoreMetrics
 
DEVELOPMENT_COST_DEF_VALUE - Static variable in interface org.sonar.api.CoreProperties
 
DEVELOPMENT_COST_KEY - Static variable in class org.sonar.api.measures.CoreMetrics
 
dir() - Method in class org.sonar.api.scan.filesystem.PathResolver.RelativePath
Deprecated.
 
DirectAcyclicGraph - Class in org.sonar.api.utils.dag
DirectAcyclicGraph(Object...) - Constructor for class org.sonar.api.utils.dag.DirectAcyclicGraph
 
DIRECTION_BETTER - Static variable in class org.sonar.api.measures.Metric
A metric bigger value means an improvement
DIRECTION_NONE - Static variable in class org.sonar.api.measures.Metric
The metric direction has no meaning
DIRECTION_WORST - Static variable in class org.sonar.api.measures.Metric
A metric bigger value means a degradation
DIRECTORIES - Static variable in class org.sonar.api.measures.CoreMetrics
Deprecated.
since 7.7 - no longer computed
DIRECTORIES_KEY - Static variable in class org.sonar.api.measures.CoreMetrics
Deprecated.
since 7.7 - no longer computed
DIRECTORY - org.sonar.api.ce.measure.Component.Type
 
DIRECTORY - Static variable in class org.sonar.api.resources.Qualifiers
 
DIRECTORY - Static variable in class org.sonar.api.resources.Scopes
For example directory or Java package.
Display - Class in org.sonar.api.server.authentication
Display information provided by the Identity Provider to be displayed into the login form.
Display.Builder - Class in org.sonar.api.server.authentication
 
DISTRIB - org.sonar.api.measures.Metric.ValueType
 
doAuthenticate(Authenticator.Context) - Method in class org.sonar.api.security.Authenticator
 
doesCover() - Method in interface org.sonar.api.test.TestCase
Deprecated.
 
doesNotMatchPathPattern(String) - Method in interface org.sonar.api.batch.fs.FilePredicates
Predicate that gets the files that do not match the given wildcard pattern.
doesNotMatchPathPatterns(String[]) - Method in interface org.sonar.api.batch.fs.FilePredicates
Predicate that gets the files that do not match any of the given wildcard patterns.
doesOverride() - Method in class org.sonar.api.rules.ActiveRule
 
doGetAuthenticator() - Method in class org.sonar.api.security.SecurityRealm
 
doGetGroups(String) - Method in class org.sonar.api.security.ExternalGroupsProvider
doGetGroups(ExternalGroupsProvider.Context) - Method in class org.sonar.api.security.ExternalGroupsProvider
Override this method in order to load user group information.
doGetPattern() - Method in class org.sonar.api.web.ServletFilter
Override to change URL.
doGetUserDetails(String) - Method in class org.sonar.api.security.ExternalUsersProvider
doGetUserDetails(ExternalUsersProvider.Context) - Method in class org.sonar.api.security.ExternalUsersProvider
Override this method in order load user information.
DOMAIN_COMPLEXITY - Static variable in class org.sonar.api.measures.CoreMetrics
 
DOMAIN_COVERAGE - Static variable in class org.sonar.api.measures.CoreMetrics
 
DOMAIN_DOCUMENTATION - Static variable in class org.sonar.api.measures.CoreMetrics
Deprecated.
since 6.2. Merged into CoreMetrics.DOMAIN_SIZE
DOMAIN_DUPLICATION - Static variable in class org.sonar.api.measures.CoreMetrics
Deprecated.
DOMAIN_DUPLICATIONS - Static variable in class org.sonar.api.measures.CoreMetrics
 
DOMAIN_GENERAL - Static variable in class org.sonar.api.measures.CoreMetrics
 
DOMAIN_ISSUES - Static variable in class org.sonar.api.measures.CoreMetrics
 
DOMAIN_MAINTAINABILITY - Static variable in class org.sonar.api.measures.CoreMetrics
SonarQube Quality Model
DOMAIN_RELEASABILITY - Static variable in class org.sonar.api.measures.CoreMetrics
 
DOMAIN_RELIABILITY - Static variable in class org.sonar.api.measures.CoreMetrics
SonarQube Quality Model
DOMAIN_SCM - Static variable in class org.sonar.api.measures.CoreMetrics
 
DOMAIN_SECURITY - Static variable in class org.sonar.api.measures.CoreMetrics
SonarQube Quality Model
DOMAIN_SIZE - Static variable in class org.sonar.api.measures.CoreMetrics
 
done() - Method in interface org.sonar.api.server.profile.BuiltInQualityProfilesDefinition.NewBuiltInQualityProfile
 
done() - Method in class org.sonar.api.server.profile.BuiltInQualityProfilesDefinition.NewBuiltInQualityProfileImpl
 
done() - Method in class org.sonar.api.server.rule.internal.DefaultNewRepository
 
done() - Method in interface org.sonar.api.server.rule.RulesDefinition.NewExtendedRepository
 
done() - Method in class org.sonar.api.server.ws.WebService.NewController
Important - this method must be called in order to apply changes and make the controller available in WebService.Context.controllers()
doOnNewUser(NewUserHandler.Context) - Method in interface org.sonar.api.platform.NewUserHandler
 
download(URI) - Method in class org.sonar.api.utils.HttpDownloader
 
download(URI, File) - Method in class org.sonar.api.utils.HttpDownloader
 
downloadPlainText(URI, String) - Method in class org.sonar.api.utils.HttpDownloader
 
DUPLICATED_BLOCKS - Static variable in class org.sonar.api.measures.CoreMetrics
 
DUPLICATED_BLOCKS_KEY - Static variable in class org.sonar.api.measures.CoreMetrics
 
DUPLICATED_FILES - Static variable in class org.sonar.api.measures.CoreMetrics
For files: if it contains duplicates, then 1, otherwise 0.
DUPLICATED_FILES_KEY - Static variable in class org.sonar.api.measures.CoreMetrics
 
DUPLICATED_LINES - Static variable in class org.sonar.api.measures.CoreMetrics
 
DUPLICATED_LINES_DENSITY - Static variable in class org.sonar.api.measures.CoreMetrics
 
DUPLICATED_LINES_DENSITY_KEY - Static variable in class org.sonar.api.measures.CoreMetrics
 
DUPLICATED_LINES_KEY - Static variable in class org.sonar.api.measures.CoreMetrics
 
DUPLICATIONS_DATA - Static variable in class org.sonar.api.measures.CoreMetrics
Deprecated.
since 4.5. Internal storage of duplication is not an API.
DUPLICATIONS_DATA_KEY - Static variable in class org.sonar.api.measures.CoreMetrics
Deprecated.
since 4.5. Internal storage of duplication is not an API.
Duration - Class in org.sonar.api.utils
 
durationInMs() - Method in interface org.sonar.api.test.TestCase
Deprecated.
Duration in milliseconds
Durations - Class in org.sonar.api.utils
 
Durations() - Constructor for class org.sonar.api.utils.Durations
 
Durations.DurationFormat - Enum in org.sonar.api.utils
Deprecated.
since 6.3, only one format is available

E

EFFICIENCY_COMPLIANCE - Static variable in class org.sonar.api.server.rule.RulesDefinition.SubCharacteristics
Deprecated.
Related to characteristic EFFICIENCY
effort() - Method in interface org.sonar.api.ce.measure.Issue
 
effort() - Method in class org.sonar.api.ce.measure.test.TestIssue
 
effort() - Method in interface org.sonar.api.issue.Issue
 
EFFORT_TO_REACH_MAINTAINABILITY_RATING_A - Static variable in class org.sonar.api.measures.CoreMetrics
 
EFFORT_TO_REACH_MAINTAINABILITY_RATING_A_KEY - Static variable in class org.sonar.api.measures.CoreMetrics
 
effortToFixDescription() - Method in class org.sonar.api.server.rule.internal.DefaultRule
Deprecated.
effortToFixDescription() - Method in class org.sonar.api.server.rule.RulesDefinition.Rule
Deprecated.
email() - Method in interface org.sonar.api.user.User
 
EmailSettings - Class in org.sonar.api.config
 
EmailSettings(Configuration, Server) - Constructor for class org.sonar.api.config.EmailSettings
 
emptyAsNull() - Method in interface org.sonar.api.server.ws.Request.StringParam
Returns a Request.StringParam object which methods Request.Param.getValue() and Request.Param.or(Supplier) will return null rather than an empty String when the param is present and its value is an empty String.
encode(int) - Method in class org.sonar.api.utils.Duration
Return the duration in text, by using the given hours in day parameter to process hours.
encode(Duration) - Method in class org.sonar.api.utils.Durations
Return the string value of the Duration.
encoding() - Method in interface org.sonar.api.batch.fs.FileSystem
Default encoding of files in this project.
ENCODING_PROPERTY - Static variable in interface org.sonar.api.CoreProperties
To determine value of this property use FileSystem.encoding().
encrypt(String) - Method in class org.sonar.api.config.Encryption
 
Encryption - Class in org.sonar.api.config
 
Encryption(String) - Constructor for class org.sonar.api.config.Encryption
 
ENCRYPTION_SECRET_KEY_PATH - Static variable in interface org.sonar.api.CoreProperties
 
end() - Method in interface org.sonar.api.batch.fs.TextRange
End position of the range
end() - Method in class org.sonar.api.utils.text.XmlWriter
 
end(String) - Method in class org.sonar.api.utils.text.XmlWriter
endArray() - Method in class org.sonar.api.utils.text.JsonWriter
Ends encoding the current array.
endObject() - Method in class org.sonar.api.utils.text.JsonWriter
Ends encoding the current object.
engineId() - Method in interface org.sonar.api.batch.sensor.issue.ExternalIssue
 
engineId() - Method in interface org.sonar.api.batch.sensor.rule.AdHocRule
Unique identifier of the external analyzer (e.g.
engineId(String) - Method in interface org.sonar.api.batch.sensor.issue.NewExternalIssue
Unique identifier of the external analyzer (e.g.
engineId(String) - Method in interface org.sonar.api.batch.sensor.rule.NewAdHocRule
Unique identifier of the external analyzer (e.g.
ENTERPRISE - org.sonar.api.SonarEdition
 
envVariable(String) - Method in class org.sonar.api.utils.System2
Shortcut for System.getenv(String)
envVariables() - Method in class org.sonar.api.utils.System2
Shortcut for System.getenv()
equals(Object) - Method in class org.sonar.api.batch.bootstrap.ProjectDefinition
Deprecated.
 
equals(Object) - Method in class org.sonar.api.batch.scm.BlameLine
 
equals(Object) - Method in class org.sonar.api.ce.measure.test.TestComponent
 
equals(Object) - Method in class org.sonar.api.config.Category
 
equals(Object) - Method in class org.sonar.api.database.model.User
Deprecated.
 
equals(Object) - Method in class org.sonar.api.measures.Metric
 
equals(Object) - Method in class org.sonar.api.notifications.Notification
Deprecated.
 
equals(Object) - Method in class org.sonar.api.profiles.ProfileExporter
 
equals(Object) - Method in class org.sonar.api.profiles.ProfileImporter
 
equals(Object) - Method in class org.sonar.api.profiles.RulesProfile
 
equals(Object) - Method in class org.sonar.api.resources.AbstractLanguage
 
equals(Object) - Method in class org.sonar.api.resources.ResourceType
 
equals(Object) - Method in class org.sonar.api.rule.RuleKey
 
equals(Object) - Method in class org.sonar.api.rules.ActiveRule
 
equals(Object) - Method in class org.sonar.api.rules.ActiveRuleParam
 
equals(Object) - Method in class org.sonar.api.rules.Rule
 
equals(Object) - Method in class org.sonar.api.rules.RuleParam
 
equals(Object) - Method in class org.sonar.api.server.debt.internal.DefaultDebtRemediationFunction
 
equals(Object) - Method in class org.sonar.api.server.profile.BuiltInQualityProfilesDefinition.BuiltInQualityProfileImpl
 
equals(Object) - Method in class org.sonar.api.server.rule.internal.DefaultParam
 
equals(Object) - Method in class org.sonar.api.server.rule.internal.DefaultRepository
 
equals(Object) - Method in class org.sonar.api.server.rule.internal.DefaultRule
 
equals(Object) - Method in class org.sonar.api.server.rule.RuleParamType
 
equals(Object) - Method in class org.sonar.api.task.TaskDefinition
Deprecated.
 
equals(Object) - Method in class org.sonar.api.utils.dag.Node
 
equals(Object) - Method in class org.sonar.api.utils.Duration
 
equals(Object) - Method in class org.sonar.api.utils.Version
 
EQUALS - org.sonar.api.ce.posttask.QualityGate.Operator
Deprecated.
in 7.6. Using this operator will have no effect.
error(String) - Method in interface org.sonar.api.utils.log.Logger
Logs an ERROR level message.
error(String, Object) - Method in interface org.sonar.api.utils.log.Logger
Logs an ERROR parameterized message according to the specified format and argument.
error(String, Object...) - Method in interface org.sonar.api.utils.log.Logger
Logs a ERROR parameterized message according to the specified format and arguments.
error(String, Object, Object) - Method in interface org.sonar.api.utils.log.Logger
Logs a ERROR parameterized message according to the specified format and arguments.
error(String, Throwable) - Method in interface org.sonar.api.utils.log.Logger
Logs an exception at the ERROR level with an accompanying message.
ERROR - org.sonar.api.ce.posttask.QualityGate.EvaluationStatus
Condition evaluated as ERROR, error thresholds has been reached (and most likely warning thresholds too).
ERROR - org.sonar.api.ce.posttask.QualityGate.Status
at least one error threshold is reached
ERROR - org.sonar.api.measures.Metric.Level
 
ERROR - org.sonar.api.test.TestCase.Status
Deprecated.
 
ERROR - org.sonar.api.utils.log.LoggerLevel
 
ERRORS - Static variable in class org.sonar.api.server.rule.RulesDefinition.SubCharacteristics
Deprecated.
Related to characteristic SECURITY
exampleValue() - Method in class org.sonar.api.server.ws.WebService.Param
 
EXCEPTION_HANDLING - Static variable in class org.sonar.api.server.rule.RulesDefinition.SubCharacteristics
Deprecated.
Related to characteristic RELIABILITY
excludes(String...) - Method in class org.sonar.api.web.ServletFilter.UrlPattern.Builder
 
excludes(Collection<String>) - Method in class org.sonar.api.web.ServletFilter.UrlPattern.Builder
 
EXECUTABLE_LINES_DATA - Static variable in class org.sonar.api.measures.CoreMetrics
Information about executable lines of code in file.
EXECUTABLE_LINES_DATA_KEY - Static variable in class org.sonar.api.measures.CoreMetrics
 
execute() - Method in class org.sonar.api.ce.posttask.PostProjectAnalysisTaskTester
 
execute() - Method in interface org.sonar.api.task.Task
Deprecated.
 
execute(PostJobContext) - Method in interface org.sonar.api.batch.postjob.PostJob
Called at the end of the analysis.
execute(SensorContext) - Method in interface org.sonar.api.batch.sensor.Sensor
The actual sensor code.
execute(SensorContext) - Method in interface org.sonar.api.scanner.sensor.ProjectSensor
The actual sensor code.
execute(Command, long) - Method in class org.sonar.api.utils.command.CommandExecutor
Execute command and display error and output streams in log.
execute(Command, StreamConsumer, StreamConsumer, long) - Method in class org.sonar.api.utils.command.CommandExecutor
 
exportProfile(RulesProfile, Writer) - Method in class org.sonar.api.profiles.ProfileExporter
Export activated rule from a quality profile to a writer Note that the quality profile can contain some rules from other plugins.
extendedRepositories() - Method in class org.sonar.api.server.rule.RulesDefinition.AbstractContext
Deprecated.
returns empty list since 5.2. Concept of "extended repository" was misleading and not valuable. Simply declare repositories and use RulesDefinition.AbstractContext.repositories(). See http://jira.sonarsource.com/browse/SONAR-6709
extendedRepositories() - Method in class org.sonar.api.server.rule.RulesDefinition.Context
Deprecated.
extendedRepositories(String) - Method in class org.sonar.api.server.rule.RulesDefinition.AbstractContext
Deprecated.
returns empty list since 5.2. Concept of "extended repository" was misleading and not valuable. Simply declare repositories and use RulesDefinition.AbstractContext.repositories(). See http://jira.sonarsource.com/browse/SONAR-6709
extendedRepositories(String) - Method in class org.sonar.api.server.rule.RulesDefinition.Context
Deprecated.
extendRepository(String, String) - Method in class org.sonar.api.server.rule.RulesDefinition.AbstractContext
extendRepository(String, String) - Method in class org.sonar.api.server.rule.RulesDefinition.Context
Deprecated.
ExtensionPoint - Annotation Type in org.sonar.api
Marker annotation for all the interfaces that are extension point (ie can be implemented by plugins and will be called at some point of time by the platform).
ExtensionProvider - Class in org.sonar.api
Deprecated.
since 6.0 should no more be used
ExtensionProvider() - Constructor for class org.sonar.api.ExtensionProvider
Deprecated.
 
EXTERNAL_RULE_REPO_PREFIX - Static variable in class org.sonar.api.rule.RuleKey
 
ExternalGroupsProvider - Class in org.sonar.api.security
Note that prefix "do" for names of methods is reserved for future enhancements, thus should not be used in subclasses.
ExternalGroupsProvider() - Constructor for class org.sonar.api.security.ExternalGroupsProvider
 
ExternalGroupsProvider.Context - Class in org.sonar.api.security
 
ExternalIssue - Interface in org.sonar.api.batch.sensor.issue
Represents an issue imported from an external rule engine by a Sensor.
ExternalUsersProvider - Class in org.sonar.api.security
Note that prefix "do" for names of methods is reserved for future enhancements, thus should not be used in subclasses.
ExternalUsersProvider() - Constructor for class org.sonar.api.security.ExternalUsersProvider
 
ExternalUsersProvider.Context - Class in org.sonar.api.security
 

F

FACETS - Static variable in class org.sonar.api.server.ws.WebService.Param
 
FAILED - org.sonar.api.ce.posttask.CeTask.Status
 
FAILURE - org.sonar.api.test.TestCase.Status
Deprecated.
 
FALSE_POSITIVE - Static variable in interface org.sonar.api.issue.DefaultTransitions
 
FALSE_POSITIVE_ISSUES - Static variable in class org.sonar.api.measures.CoreMetrics
 
FALSE_POSITIVE_ISSUES_KEY - Static variable in class org.sonar.api.measures.CoreMetrics
 
FAULT_TOLERANCE - Static variable in class org.sonar.api.server.rule.RulesDefinition.SubCharacteristics
Deprecated.
Related to characteristic RELIABILITY
FIELD_SEPARATOR - Static variable in class org.sonar.api.utils.KeyValueFormat
 
fields() - Method in class org.sonar.api.config.PropertyDefinition
 
fields() - Method in annotation type org.sonar.api.Property
A Property with fields is considered a property set.
fields(List<PropertyFieldDefinition>) - Method in class org.sonar.api.config.PropertyDefinition.Builder
 
fields(PropertyFieldDefinition, PropertyFieldDefinition...) - Method in class org.sonar.api.config.PropertyDefinition.Builder
 
FIELDS - Static variable in class org.sonar.api.server.ws.WebService.Param
 
FieldUtils2 - Class in org.sonar.api.utils
Add features missing in org.apache.commons.lang.reflect.FieldUtils.
file() - Method in interface org.sonar.api.batch.fs.IndexedFile
file() - Method in interface org.sonar.api.batch.fs.InputDir
Deprecated.
The underlying absolute File
file() - Method in interface org.sonar.api.batch.fs.InputFile
Deprecated.
since 6.6 use InputFile.inputStream() for file content, IndexedFile.filename() for file name, IndexedFile.uri() for an unique identifier, and InputFile.toString() for logging
file() - Method in interface org.sonar.api.batch.fs.InputPath
Deprecated.
since 6.5 use InputPath.uri()
FILE - org.sonar.api.ce.measure.Component.Type
 
FILE - Static variable in class org.sonar.api.resources.Qualifiers
 
FILE - Static variable in class org.sonar.api.resources.Scopes
For example a Java file.
FILE_COMPLEXITY - Static variable in class org.sonar.api.measures.CoreMetrics
Deprecated.
since 6.7
FILE_COMPLEXITY_DISTRIBUTION - Static variable in class org.sonar.api.measures.CoreMetrics
Deprecated.
since 6.7
FILE_COMPLEXITY_DISTRIBUTION_KEY - Static variable in class org.sonar.api.measures.CoreMetrics
Deprecated.
since 6.7
FILE_COMPLEXITY_KEY - Static variable in class org.sonar.api.measures.CoreMetrics
Deprecated.
since 6.7
FileAttributesImpl(String, boolean) - Constructor for class org.sonar.api.ce.measure.test.TestComponent.FileAttributesImpl
 
FileExclusions - Class in org.sonar.api.scan.filesystem
Deprecated.
since 7.6
FileExclusions(Configuration) - Constructor for class org.sonar.api.scan.filesystem.FileExclusions
Deprecated.
 
FileLinesContext - Interface in org.sonar.api.measures
Provides facility to store measures for the lines of file.
FileLinesContextFactory - Interface in org.sonar.api.measures
This interface is not intended to be implemented by clients.
filename() - Method in interface org.sonar.api.batch.fs.IndexedFile
Filename for this file (inclusing extension).
FilePredicate - Interface in org.sonar.api.batch.fs
Determines if a file must be kept in search results.
FilePredicates - Interface in org.sonar.api.batch.fs
Factory of FilePredicate
files(FilePredicate) - Method in interface org.sonar.api.batch.fs.FileSystem
Deprecated.
since 6.6 Plugins should avoid working with File and prefer working with InputFile
FILES - Static variable in class org.sonar.api.measures.CoreMetrics
Computed by the platform.
FILES_KEY - Static variable in class org.sonar.api.measures.CoreMetrics
 
filesToBlame() - Method in interface org.sonar.api.batch.scm.BlameCommand.BlameInput
List of files that should be blamed.
fileSystem() - Method in interface org.sonar.api.batch.scm.BlameCommand.BlameInput
Filesystem of the current (sub )project.
fileSystem() - Method in interface org.sonar.api.batch.sensor.SensorContext
Get filesystem of the project.
FileSystem - Interface in org.sonar.api.batch.fs
The FileSystem manages all the source files to be analyzed.
FileSystem.Index - Interface in org.sonar.api.batch.fs
Interface of the underlying file index.
fillInStackTrace() - Method in exception org.sonar.api.utils.MessageException
Does not fill in the stack trace
FILTER - org.sonar.api.web.WidgetPropertyType
Deprecated.
Measure Filter id
FilterableIssue - Interface in org.sonar.api.scan.issue.filter
Deprecated.
since 7.6
find(RuleKey) - Method in interface org.sonar.api.batch.rule.ActiveRules
Find a ActiveRule by the associated rule key.
find(RuleKey) - Method in interface org.sonar.api.batch.rule.Rules
Deprecated.
Get a rule by its key.
find(RuleQuery) - Method in interface org.sonar.api.rules.RuleFinder
 
findAll() - Method in interface org.sonar.api.batch.measure.MetricFinder
 
findAll() - Method in interface org.sonar.api.batch.rule.ActiveRules
All the active rules, whatever their repository and related language.
findAll() - Method in interface org.sonar.api.batch.rule.Rules
Deprecated.
 
findAll() - Method in interface org.sonar.api.measures.MetricFinder
Deprecated.
 
findAll(List<String>) - Method in interface org.sonar.api.batch.measure.MetricFinder
 
findAll(List<String>) - Method in interface org.sonar.api.measures.MetricFinder
Deprecated.
 
findAll(RuleQuery) - Method in interface org.sonar.api.rules.RuleFinder
 
findById(int) - Method in interface org.sonar.api.measures.MetricFinder
Deprecated.
 
findById(int) - Method in interface org.sonar.api.rules.RuleFinder
Deprecated.
findByInternalKey(String, String) - Method in interface org.sonar.api.batch.rule.ActiveRules
Find a ActiveRule by the associated internal key.
findByInternalKey(String, String) - Method in interface org.sonar.api.batch.rule.Rules
Deprecated.
 
findByKey(String) - Method in interface org.sonar.api.batch.measure.MetricFinder
 
findByKey(String) - Method in interface org.sonar.api.measures.MetricFinder
Deprecated.
 
findByKey(String, String) - Method in interface org.sonar.api.rules.RuleFinder
 
findByKey(RuleKey) - Method in interface org.sonar.api.rules.RuleFinder
 
findByLanguage(String) - Method in interface org.sonar.api.batch.rule.ActiveRules
The active rules for a given language, like java
findByRepository(String) - Method in interface org.sonar.api.batch.rule.ActiveRules
The active rules for a given repository, like findbugs
findByRepository(String) - Method in interface org.sonar.api.batch.rule.Rules
Deprecated.
Get the rules of the given repository.
finished(PostProjectAnalysisTask.Context) - Method in interface org.sonar.api.ce.posttask.PostProjectAnalysisTask
 
finished(PostProjectAnalysisTask.ProjectAnalysis) - Method in interface org.sonar.api.ce.posttask.PostProjectAnalysisTask
Deprecated.
FLOAT - org.sonar.api.measures.Metric.ValueType
 
FLOAT - org.sonar.api.PropertyType
Floating point number
FLOAT - org.sonar.api.web.WidgetPropertyType
Deprecated.
Floating point number
FLOAT - Static variable in class org.sonar.api.server.rule.RuleParamType
 
flows() - Method in interface org.sonar.api.batch.sensor.issue.IIssue
List of flows for this issue.
flows() - Method in interface org.sonar.api.batch.sensor.issue.Issue
List of flows for this issue.
Footer - Interface in org.sonar.api.web
Deprecated.
since 6.3. This extension is ignored.
forCssClass(String) - Static method in enum org.sonar.api.batch.sensor.highlighting.TypeOfText
 
format(String, Object...) - Method in class org.sonar.api.utils.LocalizedMessages
 
format(Locale, Duration) - Method in class org.sonar.api.utils.Durations
Deprecated.
since 6.3 as the Locale.ENGLISH is always used. Use Durations.format(Duration) instead
format(Locale, Duration, Durations.DurationFormat) - Method in class org.sonar.api.utils.Durations
Deprecated.
since 6.3 as the Locale.ENGLISH is always used. Use Durations.format(Duration) instead
format(Map) - Static method in class org.sonar.api.utils.KeyValueFormat
 
format(Map<K, V>, KeyValueFormat.Converter<K>, KeyValueFormat.Converter<V>) - Static method in class org.sonar.api.utils.KeyValueFormat
 
format(Duration) - Method in class org.sonar.api.utils.Durations
Return the formatted work duration using the english bundles.
formatDate(Instant) - Static method in class org.sonar.api.utils.DateUtils
Warning: relies on default timezone!
formatDate(Date) - Static method in class org.sonar.api.utils.DateUtils
Warning: relies on default timezone!
formatDate(Locale, Date) - Method in interface org.sonar.api.i18n.I18n
Deprecated.
Return the formatted date.
formatDateTime(long) - Static method in class org.sonar.api.utils.DateUtils
Warning: relies on default timezone!
formatDateTime(OffsetDateTime) - Static method in class org.sonar.api.utils.DateUtils
 
formatDateTime(Date) - Static method in class org.sonar.api.utils.DateUtils
Warning: relies on default timezone!
formatDateTime(Locale, Date) - Method in interface org.sonar.api.i18n.I18n
Deprecated.
Return the formatted datetime.
formatDateTimeNullSafe(Date) - Static method in class org.sonar.api.utils.DateUtils
Warning: relies on default timezone!
formatDouble(Locale, Double) - Method in interface org.sonar.api.i18n.I18n
Deprecated.
Return the formatted decimal, with always one fraction digit.
formatDuration(long) - Static method in class org.sonar.api.utils.TimeUtils
Label for a duration, expressed in numbers of ms, seconds or minutes.
formatIntDate(Map<Integer, Date>) - Static method in class org.sonar.api.utils.KeyValueFormat
 
formatIntDateTime(Map<Integer, Date>) - Static method in class org.sonar.api.utils.KeyValueFormat
 
formatIntDouble(Map<Integer, Double>) - Static method in class org.sonar.api.utils.KeyValueFormat
 
formatInteger(Locale, Integer) - Method in interface org.sonar.api.i18n.I18n
Deprecated.
Return the formatted integer.
formatIntString(Map<Integer, String>) - Static method in class org.sonar.api.utils.KeyValueFormat
 
formatQuietly(String, Object...) - Method in class org.sonar.api.utils.LocalizedMessages
 
formatStringInt(Map<String, Integer>) - Static method in class org.sonar.api.utils.KeyValueFormat
 
forMetric(Metric<G>) - Method in interface org.sonar.api.batch.sensor.measure.NewMeasure
Set the metric this measure belong to.
forPageIndex(int) - Static method in class org.sonar.api.utils.Paging
 
forRule(RuleKey) - Method in interface org.sonar.api.batch.sensor.issue.NewExternalIssue
Deprecated.
since 7.4. It is misleading, because of the "external_" prefix that is added on server side. Use NewExternalIssue.engineId(String) and NewExternalIssue.ruleId(String)
forRule(RuleKey) - Method in interface org.sonar.api.batch.sensor.issue.NewIssue
The RuleKey of the issue.
FROM - Static variable in class org.sonar.api.config.EmailSettings
 
FROM_DEFAULT - Static variable in class org.sonar.api.config.EmailSettings
 
FROM_NAME - Static variable in class org.sonar.api.config.EmailSettings
 
FROM_NAME_DEFAULT - Static variable in class org.sonar.api.config.EmailSettings
 
fromCheckPriority(Priority) - Static method in enum org.sonar.api.rules.RulePriority
Deprecated.
 
fromKey(String) - Static method in enum org.sonar.api.web.page.Page.Qualifier
 
fromParam(String) - Static method in enum org.sonar.api.server.ws.WebService.SelectionMode
 
FUNCTION_COMPLEXITY - Static variable in class org.sonar.api.measures.CoreMetrics
Deprecated.
since 6.7
FUNCTION_COMPLEXITY_DISTRIBUTION - Static variable in class org.sonar.api.measures.CoreMetrics
Deprecated.
since 6.7
FUNCTION_COMPLEXITY_DISTRIBUTION_KEY - Static variable in class org.sonar.api.measures.CoreMetrics
Deprecated.
since 6.7
FUNCTION_COMPLEXITY_KEY - Static variable in class org.sonar.api.measures.CoreMetrics
Deprecated.
since 6.7
FUNCTIONS - Static variable in class org.sonar.api.measures.CoreMetrics
 
FUNCTIONS_KEY - Static variable in class org.sonar.api.measures.CoreMetrics
Computed by the platform.

G

gap() - Method in interface org.sonar.api.batch.sensor.issue.Issue
Gap used to compute the effort for fixing the issue.
gap() - Method in interface org.sonar.api.issue.Issue
Arbitrary distance to threshold for resolving the issue.
gap() - Method in interface org.sonar.api.scan.issue.filter.FilterableIssue
Deprecated.
 
gap(Double) - Method in interface org.sonar.api.batch.sensor.issue.NewIssue
Gap used for the computation of the effort.
gapDescription() - Method in class org.sonar.api.server.rule.internal.DefaultRule
 
gapDescription() - Method in class org.sonar.api.server.rule.RulesDefinition.Rule
 
gapMultiplier() - Method in interface org.sonar.api.server.debt.DebtRemediationFunction
gapMultiplier() - Method in class org.sonar.api.server.debt.internal.DefaultDebtRemediationFunction
 
generateCsrfState() - Method in interface org.sonar.api.server.authentication.OAuth2IdentityProvider.InitContext
Generate a non-guessable state to prevent Cross Site Request Forgery.
GENERATED_LINES - Static variable in class org.sonar.api.measures.CoreMetrics
 
GENERATED_LINES_KEY - Static variable in class org.sonar.api.measures.CoreMetrics
 
GENERATED_NCLOC - Static variable in class org.sonar.api.measures.CoreMetrics
 
GENERATED_NCLOC_KEY - Static variable in class org.sonar.api.measures.CoreMetrics
 
generateRandomSecretKey() - Method in class org.sonar.api.config.Encryption
 
get() - Method in class org.sonar.api.batch.bootstrap.ProjectReactor
Deprecated.
 
get() - Method in class org.sonar.api.SonarQubeVersion
Deprecated.
 
get(Class<?>) - Static method in class org.sonar.api.utils.log.Loggers
 
get(String) - Method in interface org.sonar.api.config.Configuration
The effective value of the specified property.
get(String) - Method in class org.sonar.api.config.PropertyDefinitions
 
get(String) - Method in class org.sonar.api.config.Settings
Deprecated.
 
get(String) - Method in class org.sonar.api.resources.Languages
Return a language from the current object based on its key
get(String) - Method in class org.sonar.api.resources.ResourceTypes
 
get(String) - Static method in class org.sonar.api.utils.log.Loggers
 
getActiveRule() - Method in class org.sonar.api.rules.ActiveRuleParam
 
getActiveRule(String, String) - Method in class org.sonar.api.profiles.RulesProfile
Note: disabled rules are excluded.
getActiveRule(Rule) - Method in class org.sonar.api.profiles.RulesProfile
Note: disabled rules are excluded.
getActiveRuleByConfigKey(String, String) - Method in class org.sonar.api.profiles.RulesProfile
Note: disabled rules are excluded.
getActiveRuleParams() - Method in class org.sonar.api.rules.ActiveRule
 
getActiveRules() - Method in class org.sonar.api.profiles.RulesProfile
 
getActiveRules(boolean) - Method in class org.sonar.api.profiles.RulesProfile
 
getActiveRules(RulePriority) - Method in class org.sonar.api.profiles.RulesProfile
Note: disabled rules are excluded.
getActiveRulesByRepository(String) - Method in class org.sonar.api.profiles.RulesProfile
Get the active rules of a specific repository.
getAll() - Method in class org.sonar.api.config.PropertyDefinitions
 
getAll() - Method in class org.sonar.api.resources.ResourceTypes
 
getAnalysis() - Method in interface org.sonar.api.ce.posttask.PostProjectAnalysisTask.ProjectAnalysis
Analysis containing the UUID of the analysis and the date
getAnalysisDate() - Method in interface org.sonar.api.ce.posttask.PostProjectAnalysisTask.ProjectAnalysis
Deprecated.
use {@link #getAnalysis().getDate()} instead
getAnalysisUuid() - Method in interface org.sonar.api.ce.posttask.Analysis
UUID of the analysis
getAnnotation(Object, Class<A>) - Static method in class org.sonar.api.utils.AnnotationUtils
Searches for a class annotation.
getApiVersion() - Method in interface org.sonar.api.SonarRuntime
Version of API (sonar-plugin-api artifact) at runtime.
getArgs() - Method in class org.sonar.api.utils.log.LogAndArguments
 
getArguments() - Method in class org.sonar.api.utils.command.Command
 
getBackgroundColor() - Method in class org.sonar.api.server.authentication.Display
Background color for the provider button displayed in the login form.
getBaseDir() - Method in class org.sonar.api.batch.bootstrap.ProjectDefinition
Deprecated.
 
getBestValue() - Method in class org.sonar.api.measures.Metric
 
getBoolean(String) - Method in interface org.sonar.api.config.Configuration
Effective value as boolean.
getBoolean(String) - Method in class org.sonar.api.config.Settings
Deprecated.
Effective value as boolean.
getBooleanProperty(String) - Method in class org.sonar.api.resources.ResourceType
Returns the value of the property for this resource type.
getBooleanValue() - Method in interface org.sonar.api.ce.measure.Measure
The value of this measure as a boolean.
getBooleanValue() - Method in class org.sonar.api.ce.measure.test.TestMeasure
 
getBootConfiguration() - Method in class org.sonar.api.Plugin.Context
The configuration that contains only the few properties required to bootstrap the process, for example: - conf/sonar.properties and persisted properties on web server and Compute Engine sides.
getBranch() - Method in interface org.sonar.api.ce.posttask.PostProjectAnalysisTask.ProjectAnalysis
The branch that is being analyzed.
getBuildDir() - Method in class org.sonar.api.batch.bootstrap.ProjectDefinition
Deprecated.
since 6.1 notion of buildDir is not well defined
getBytes() - Method in interface org.sonar.api.server.ws.LocalConnector.LocalResponse
Response body
getCallbackUrl() - Method in interface org.sonar.api.server.authentication.OAuth2IdentityProvider.OAuth2Context
The callback URL that must be used by the identity provider
getCardinality() - Method in class org.sonar.api.rules.Rule
Deprecated.
since 4.4, use Rule.isTemplate()
getCategory(String) - Method in class org.sonar.api.config.PropertyDefinitions
 
getCategory(Property) - Method in class org.sonar.api.config.PropertyDefinitions
 
getCeTask() - Method in interface org.sonar.api.ce.posttask.PostProjectAnalysisTask.ProjectAnalysis
Details of the Compute Engine task in which the project analysis was run.
getCharacteristicId() - Method in class org.sonar.api.rules.Rule
Deprecated.
getCharacteristicKey() - Method in class org.sonar.api.rules.Rule
Deprecated.
in 5.5. SQALE Quality Model is replaced by SonarQube Quality Model.
getChildren(String) - Method in class org.sonar.api.resources.ResourceTypeTree
 
getChildrenMeasures(String) - Method in interface org.sonar.api.ce.measure.MeasureComputer.MeasureComputerContext
Returns measures from a given metric on children of the current component.
getChildrenMeasures(String) - Method in class org.sonar.api.ce.measure.test.TestMeasureComputerContext
 
getClassAnnotation(Object, Class<A>) - Static method in class org.sonar.api.utils.AnnotationUtils
Deprecated.
getCode() - Method in enum org.sonar.api.web.DashboardLayout
Deprecated.
 
getColorName() - Method in enum org.sonar.api.measures.Metric.Level
 
getColumns() - Method in enum org.sonar.api.web.DashboardLayout
Deprecated.
 
getCommand() - Method in exception org.sonar.api.utils.command.CommandException
 
getComponent() - Method in interface org.sonar.api.ce.measure.MeasureComputer.MeasureComputerContext
Returns the current component.
getComponent() - Method in class org.sonar.api.ce.measure.test.TestMeasureComputerContext
 
getComponentQualifiers() - Method in class org.sonar.api.web.page.Page
 
getConditions() - Method in interface org.sonar.api.ce.posttask.QualityGate
Conditions of the Quality Gate.
getConfigKey() - Method in class org.sonar.api.rules.ActiveRule
 
getConfigKey() - Method in class org.sonar.api.rules.Rule
 
getConfigKey() - Method in class org.sonar.api.rules.RuleQuery
 
getContextPath() - Method in class org.sonar.api.platform.Server
Context path of web server.
getCreatedAt() - Method in class org.sonar.api.batch.rule.LoadedActiveRule
 
getCreatedAt() - Method in class org.sonar.api.rules.Rule
 
getDate() - Method in interface org.sonar.api.ce.posttask.Analysis
Date of the analysis.
getDate() - Method in interface org.sonar.api.ce.posttask.PostProjectAnalysisTask.ProjectAnalysis
Deprecated.
use {@link #getAnalysis().getDate()} instead. When PostProjectAnalysisTask.ProjectAnalysis.getAnalysis() returns empty, the current date will be returned.
getDate(String) - Method in class org.sonar.api.config.Settings
Deprecated.
Effective value as Date, without time fields.
getDateTime(String) - Method in class org.sonar.api.config.Settings
Deprecated.
Effective value as Date, with time fields.
getDbConstant() - Method in enum org.sonar.api.rules.RuleType
 
getDecimalScale() - Method in class org.sonar.api.measures.Metric
Return the number scale if metric type is Metric.ValueType.FLOAT, else null
getDefaultCharacteristicId() - Method in class org.sonar.api.rules.Rule
Deprecated.
getDefaultCharacteristicKey() - Method in class org.sonar.api.rules.Rule
Deprecated.
in 5.5. SQALE Quality Model is replaced by SonarQube Quality Model.
getDefaultMessage() - Method in class org.sonar.api.notifications.Notification
Deprecated.
Returns the default message to display for this notification.
getDefaultProfile() - Method in class org.sonar.api.profiles.RulesProfile
 
getDefaultSubCharacteristicKey() - Method in class org.sonar.api.rules.Rule
Deprecated.
in 5.5. SQALE Quality Model is replaced by SonarQube Quality Model.
getDefaultTimeZone() - Method in class org.sonar.api.utils.System2
 
getDefaultValue() - Method in class org.sonar.api.rules.RuleParam
 
getDefaultValue(String) - Method in class org.sonar.api.config.PropertyDefinitions
 
getDefaultValue(String) - Method in class org.sonar.api.config.Settings
Deprecated.
 
getDefaultValueAsBoolean() - Method in class org.sonar.api.rules.RuleParam
 
getDefaultValueAsInteger() - Method in class org.sonar.api.rules.RuleParam
 
getDefinition(String) - Method in class org.sonar.api.config.Settings
Deprecated.
The definition related to the specified property.
getDefinitions() - Method in class org.sonar.api.config.Settings
Deprecated.
All the property definitions declared by core and plugins.
getDeleteHistoricalData() - Method in class org.sonar.api.measures.Metric
 
getDependencies() - Method in class org.sonar.api.utils.dag.Node
 
getDeprecatedKey(String) - Method in class org.sonar.api.config.PropertyDefinitions
 
getDescription() - Method in class org.sonar.api.batch.bootstrap.ProjectDefinition
Deprecated.
 
getDescription() - Method in interface org.sonar.api.ce.posttask.PostProjectAnalysisTask
A short description or name for the task.
getDescription() - Method in class org.sonar.api.measures.Metric
 
getDescription() - Method in class org.sonar.api.rules.Rule
 
getDescription() - Method in class org.sonar.api.rules.RuleParam
 
getDescription() - Method in class org.sonar.api.server.ws.Change
 
getDescription() - Method in class org.sonar.api.web.Dashboard
Deprecated.
Returns the description of the dashboard.
getDescription(String, String) - Method in interface org.sonar.api.i18n.RuleI18n
Deprecated.
Returns the description of the rule identified by its repository key and rule key.
getDescription(String, String, Locale) - Method in interface org.sonar.api.i18n.RuleI18n
Deprecated.
since 4.1. Rules are not localized anymore. See http://jira.sonarsource.com/browse/SONAR-4885
getDirection() - Method in class org.sonar.api.measures.Metric
 
getDirectory() - Method in class org.sonar.api.utils.command.Command
 
getDisplay() - Method in interface org.sonar.api.server.authentication.IdentityProvider
Display information for the login form
getDomain() - Method in class org.sonar.api.measures.Metric
 
getDouble(String) - Method in interface org.sonar.api.config.Configuration
Effective value as Double.
getDouble(String) - Method in class org.sonar.api.config.Settings
Deprecated.
Effective value as Double.
getDoubleValue() - Method in interface org.sonar.api.ce.measure.Measure
The value of this measure as a double.
getDoubleValue() - Method in class org.sonar.api.ce.measure.test.TestMeasure
 
getEdition() - Method in interface org.sonar.api.SonarRuntime
The SonarQube/SonarCloud edition being executed at runtime.
getEmail() - Method in class org.sonar.api.database.model.User
Deprecated.
 
getEmail() - Method in class org.sonar.api.platform.NewUserHandler.Context
 
getEmail() - Method in class org.sonar.api.security.UserDetails
 
getEmail() - Method in class org.sonar.api.server.authentication.UserIdentity
Optional non-blank email.
getEnabled() - Method in class org.sonar.api.measures.Metric
 
getEncryption() - Method in class org.sonar.api.config.Settings
Deprecated.
 
getEndLine() - Method in class org.sonar.api.batch.sensor.cpd.internal.TokensLine
getEndUnit() - Method in class org.sonar.api.batch.sensor.cpd.internal.TokensLine
 
getEnvironmentVariables() - Method in class org.sonar.api.utils.command.Command
Environment variables that are propagated during command execution.
getErrorKey() - Method in class org.sonar.api.config.PropertyDefinition.Result
 
getErrors() - Method in class org.sonar.api.utils.ValidationMessages
 
getErrorThreshold() - Method in interface org.sonar.api.ce.posttask.QualityGate.Condition
The threshold value which makes the quality gates status change to QualityGate.EvaluationStatus.ERROR when it's reached.
getExclusions() - Method in class org.sonar.api.web.ServletFilter.UrlPattern
 
getExecutable() - Method in class org.sonar.api.utils.command.Command
 
getExtensions() - Method in class org.sonar.api.Plugin.Context
 
getExtensions() - Method in class org.sonar.api.SonarPlugin
Deprecated.
Classes of the implemented extensions.
getFields(Class, boolean) - Static method in class org.sonar.api.utils.FieldUtils2
Get accessible Field breaking scope if requested.
getFieldValue(String) - Method in class org.sonar.api.notifications.Notification
Deprecated.
Returns the value of a field.
getFileAttributes() - Method in interface org.sonar.api.ce.measure.Component
The attributes of the Component if it's type is File.
getFileAttributes() - Method in class org.sonar.api.ce.measure.test.TestComponent
 
getFileName() - Method in interface org.sonar.api.server.ws.Request.Part
 
getFilesByExtension(String) - Method in interface org.sonar.api.batch.fs.FileSystem.Index
 
getFilesByName(String) - Method in interface org.sonar.api.batch.fs.FileSystem.Index
 
getFileSuffixes() - Method in interface org.sonar.api.resources.Language
For example ["jav", "java"].
getFloat(String) - Method in interface org.sonar.api.config.Configuration
Effective value as Float.
getFloat(String) - Method in class org.sonar.api.config.Settings
Deprecated.
Effective value as Float.
getFormattedMsg() - Method in class org.sonar.api.utils.log.LogAndArguments
 
getFrom() - Method in class org.sonar.api.config.EmailSettings
 
getFromName() - Method in class org.sonar.api.config.EmailSettings
 
getGroups() - Method in class org.sonar.api.server.authentication.UserIdentity
List of group membership of the user.
getGroupsProvider() - Method in class org.sonar.api.security.SecurityRealm
 
getHashCode() - Method in class org.sonar.api.batch.sensor.cpd.internal.TokensLine
 
getHeader(String) - Method in interface org.sonar.api.server.ws.LocalConnector.LocalRequest
 
getHeader(String) - Method in interface org.sonar.api.server.ws.LocalConnector.LocalResponse
 
getHeader(String) - Method in interface org.sonar.api.server.ws.Response
 
getHeaderNames() - Method in interface org.sonar.api.server.ws.LocalConnector.LocalResponse
HTTP headers
getHeaderNames() - Method in interface org.sonar.api.server.ws.Response
 
getHeaders() - Method in class org.sonar.api.server.ws.Request
 
getHelpMessage() - Method in class org.sonar.api.server.authentication.Display
Optional help message to be displayed near the provider button.
getHomeDir() - Method in interface org.sonar.api.platform.ServerFileSystem
Root directory of the server installation
getHtml() - Method in interface org.sonar.api.web.Footer
Deprecated.
Static HTML
getIconPath() - Method in class org.sonar.api.resources.ResourceType
Returns the relative path of the icon used to represent the resource type
getIconPath() - Method in class org.sonar.api.server.authentication.Display
URL path to the provider icon, as deployed at runtime, for example "/static/authgithub/github.svg" (in this case "authgithub" is the plugin key.
getId() - Method in interface org.sonar.api.ce.posttask.CeTask
Id of the Compute Engine task.
getId() - Method in interface org.sonar.api.ce.posttask.QualityGate
The unique identifier of the Quality Gate.
getId() - Method in class org.sonar.api.database.BaseIdentifiable
Deprecated.
 
getId() - Method in class org.sonar.api.measures.Metric
For internal use only
getId() - Method in class org.sonar.api.platform.Server
UUID identifying the installation.
getId() - Method in class org.sonar.api.profiles.RulesProfile
 
getId() - Method in class org.sonar.api.rules.ActiveRule
 
getId() - Method in class org.sonar.api.rules.ActiveRuleParam
 
getId() - Method in class org.sonar.api.rules.Rule
 
getId() - Method in class org.sonar.api.rules.RuleParam
 
getId() - Method in class org.sonar.api.web.AbstractDashboardWidget
Deprecated.
 
getId() - Method in class org.sonar.api.web.Dashboard.Widget
Deprecated.
Returns the identifier of this widget.
getId() - Method in interface org.sonar.api.web.View
Deprecated.
 
getId() - Method in interface org.sonar.api.web.Webservice
Deprecated.
 
getInclusions() - Method in class org.sonar.api.web.ServletFilter.UrlPattern
 
getInfos() - Method in class org.sonar.api.utils.ValidationMessages
 
getInheritance() - Method in class org.sonar.api.rules.ActiveRule
For internal use only.
getInitialDbVersion() - Method in interface org.sonar.api.platform.ServerUpgradeStatus
The database version before the server startup.
getInputMetrics() - Method in interface org.sonar.api.ce.measure.MeasureComputer.MeasureComputerDefinition
Return the metric keys that can be read using MeasureComputer.MeasureComputerContext.
getInputMetrics() - Method in class org.sonar.api.ce.measure.test.TestMeasureComputerDefinition
 
getInputStream() - Method in interface org.sonar.api.server.ws.Request.Part
 
getInt(String) - Method in interface org.sonar.api.config.Configuration
Effective value as int.
getInt(String) - Method in class org.sonar.api.config.Settings
Deprecated.
Effective value as int.
getInternalKey() - Method in class org.sonar.api.batch.rule.LoadedActiveRule
 
getIntValue() - Method in interface org.sonar.api.ce.measure.Measure
The value of this measure as a integer.
getIntValue() - Method in class org.sonar.api.ce.measure.test.TestMeasure
 
getIssues() - Method in interface org.sonar.api.ce.measure.MeasureComputer.MeasureComputerContext
Return list of all issues (open, closed, etc.) of current component.
getIssues() - Method in class org.sonar.api.ce.measure.test.TestMeasureComputerContext
 
getKey() - Method in class org.sonar.api.batch.bootstrap.ProjectDefinition
Deprecated.
 
getKey() - Method in interface org.sonar.api.ce.measure.Component
 
getKey() - Method in class org.sonar.api.ce.measure.test.TestComponent
 
getKey() - Method in interface org.sonar.api.ce.posttask.Organization
 
getKey() - Method in interface org.sonar.api.ce.posttask.Project
The key of the project.
getKey() - Method in class org.sonar.api.config.GlobalPropertyChangeHandler.PropertyChange
 
getKey() - Method in class org.sonar.api.measures.Metric
 
getKey() - Method in class org.sonar.api.notifications.NotificationChannel
Deprecated.
Returns the unique key of this channel.
getKey() - Method in class org.sonar.api.profiles.ProfileExporter
 
getKey() - Method in class org.sonar.api.profiles.ProfileImporter
 
getKey() - Method in class org.sonar.api.resources.AbstractLanguage
For example "java".
getKey() - Method in interface org.sonar.api.resources.Language
For example "java".
getKey() - Method in class org.sonar.api.rules.ActiveRuleParam
 
getKey() - Method in class org.sonar.api.rules.Rule
 
getKey() - Method in class org.sonar.api.rules.RuleParam
 
getKey() - Method in class org.sonar.api.rules.RuleQuery
 
getKey() - Method in class org.sonar.api.rules.RuleRepository
Deprecated.
 
getKey() - Method in interface org.sonar.api.server.authentication.IdentityProvider
Unique key of provider, for example "github".
getKey() - Method in class org.sonar.api.web.page.Page
 
getKey() - Method in enum org.sonar.api.web.page.Page.Qualifier
 
getKeys() - Method in class org.sonar.api.utils.LocalizedMessages
 
getKeysStartingWith(String) - Method in class org.sonar.api.config.Settings
Deprecated.
 
getLabel() - Method in enum org.sonar.api.SonarEdition
 
getLanguage() - Method in class org.sonar.api.batch.rule.LoadedActiveRule
 
getLanguage() - Method in class org.sonar.api.profiles.RulesProfile
 
getLanguage() - Method in class org.sonar.api.rules.Rule
 
getLanguage() - Method in class org.sonar.api.rules.RuleRepository
Deprecated.
 
getLanguageKey() - Method in interface org.sonar.api.ce.measure.Component.FileAttributes
 
getLanguageKey() - Method in class org.sonar.api.ce.measure.test.TestComponent.FileAttributesImpl
 
getLayout() - Method in class org.sonar.api.web.Dashboard
Deprecated.
Returns the layout.
getLeaves() - Method in class org.sonar.api.resources.ResourceTypeTree
 
getLeavesQualifiers(String) - Method in class org.sonar.api.resources.ResourceTypes
 
getLevel() - Method in interface org.sonar.api.utils.log.Logger
 
getLevel() - Method in class org.sonar.api.utils.log.Loggers
 
getLocale() - Method in class org.sonar.api.utils.LocalizedMessages
 
getLogin() - Method in class org.sonar.api.database.model.User
Deprecated.
 
getLogin() - Method in class org.sonar.api.platform.NewUserHandler.Context
 
getLogin() - Method in class org.sonar.api.server.authentication.UserIdentity
User login, unique for the SonarQube platform.
getLoginPasswordAuthenticator() - Method in class org.sonar.api.security.SecurityRealm
Deprecated.
replaced by doGetAuthenticator in version 3.1
getLogs() - Method in class org.sonar.api.utils.log.ListInterceptor
 
getLogs() - Method in class org.sonar.api.utils.log.LogTester
Logs with arguments in chronological order (item at index 0 is the oldest one)
getLogs(LoggerLevel) - Method in class org.sonar.api.utils.log.ListInterceptor
 
getLogs(LoggerLevel) - Method in class org.sonar.api.utils.log.LogTester
Logs with arguments in chronological order (item at index 0 is the oldest one) for a given level
getLogStatistics() - Method in interface org.sonar.api.ce.posttask.PostProjectAnalysisTask.Context
 
getLogStatistics() - Method in class org.sonar.api.ce.posttask.PostProjectAnalysisTaskTester
 
getLong(String) - Method in interface org.sonar.api.config.Configuration
Effective value as long.
getLong(String) - Method in class org.sonar.api.config.Settings
Deprecated.
Effective value as long.
getLongValue() - Method in interface org.sonar.api.ce.measure.Measure
The value of this measure as a long.
getLongValue() - Method in class org.sonar.api.ce.measure.test.TestMeasure
 
getMeasure(String) - Method in interface org.sonar.api.ce.measure.MeasureComputer.MeasureComputerContext
Returns the measure from a given metric on the current component.
getMeasure(String) - Method in class org.sonar.api.ce.measure.test.TestMeasureComputerContext
 
getMediaType() - Method in interface org.sonar.api.server.ws.LocalConnector.LocalRequest
 
getMediaType() - Method in interface org.sonar.api.server.ws.LocalConnector.LocalResponse
 
getMediaType() - Method in class org.sonar.api.server.ws.Request
Returns the requested MIME type, or "application/octet-stream" if not specified.
getMethod() - Method in interface org.sonar.api.server.ws.LocalConnector.LocalRequest
HTTP method.
getMetric(String) - Static method in class org.sonar.api.measures.CoreMetrics
 
getMetricKey() - Method in interface org.sonar.api.ce.posttask.QualityGate.Condition
The key of the metric this condition has been evaluated on.
getMetrics() - Static method in class org.sonar.api.measures.CoreMetrics
 
getMetrics() - Method in interface org.sonar.api.measures.Metrics
 
getMimeType() - Method in class org.sonar.api.profiles.ProfileExporter
 
getMultiParam(String) - Method in interface org.sonar.api.server.ws.LocalConnector.LocalRequest
 
getName() - Method in class org.sonar.api.batch.bootstrap.ProjectDefinition
Deprecated.
 
getName() - Method in class org.sonar.api.batch.rule.LoadedActiveRule
 
getName() - Method in interface org.sonar.api.ce.posttask.Branch
 
getName() - Method in interface org.sonar.api.ce.posttask.Organization
 
getName() - Method in interface org.sonar.api.ce.posttask.Project
The name of the project.
getName() - Method in interface org.sonar.api.ce.posttask.QualityGate
Name of the Quality Gate.
getName() - Method in class org.sonar.api.database.model.User
Deprecated.
 
getName() - Method in class org.sonar.api.measures.Metric
 
getName() - Method in class org.sonar.api.platform.NewUserHandler.Context
 
getName() - Method in class org.sonar.api.profiles.ProfileExporter
 
getName() - Method in class org.sonar.api.profiles.ProfileImporter
 
getName() - Method in class org.sonar.api.profiles.RulesProfile
 
getName() - Method in class org.sonar.api.resources.AbstractLanguage
For example "Java"
getName() - Method in interface org.sonar.api.resources.Language
For example "Java"
getName() - Method in class org.sonar.api.rules.Rule
 
getName() - Method in class org.sonar.api.rules.RuleRepository
Deprecated.
 
getName() - Method in class org.sonar.api.security.SecurityRealm
 
getName() - Method in class org.sonar.api.security.UserDetails
 
getName() - Method in interface org.sonar.api.server.authentication.IdentityProvider
Name displayed in login form.
getName() - Method in class org.sonar.api.server.authentication.UserIdentity
Non-blank display name.
getName() - Method in class org.sonar.api.web.DashboardTemplate
Deprecated.
Dashboard name
getName() - Method in class org.sonar.api.web.page.Page
 
getName(boolean) - Method in class org.sonar.api.rules.RuleRepository
Deprecated.
 
getName(String, String) - Method in interface org.sonar.api.i18n.RuleI18n
Deprecated.
Returns the name of the rule identified by its repository key and rule key.
getName(String, String, Locale) - Method in interface org.sonar.api.i18n.RuleI18n
Deprecated.
since 4.1. Rules are not localized anymore. See http://jira.sonarsource.com/browse/SONAR-4885
getName(Rule) - Method in interface org.sonar.api.i18n.RuleI18n
Deprecated.
Returns the name of the rule.
getName(Rule, Locale) - Method in interface org.sonar.api.i18n.RuleI18n
Deprecated.
since 4.1. Rules are not localized anymore. See http://jira.sonarsource.com/browse/SONAR-4885
getNewKey(String) - Method in class org.sonar.api.config.PropertyDefinitions
 
getNewValue() - Method in class org.sonar.api.config.GlobalPropertyChangeHandler.PropertyChange
 
getNoteCreatedAt() - Method in class org.sonar.api.rules.ActiveRule
Deprecated.
in 4.4. Feature dropped.
getNoteData() - Method in class org.sonar.api.rules.ActiveRule
Deprecated.
in 4.4. Feature dropped.
getNoteUpdatedAt() - Method in class org.sonar.api.rules.ActiveRule
Deprecated.
in 4.4. Feature dropped.
getNoteUserLogin() - Method in class org.sonar.api.rules.ActiveRule
Deprecated.
in 4.4. Feature dropped.
getObject() - Method in class org.sonar.api.utils.dag.Node
 
getOperator() - Method in interface org.sonar.api.ce.posttask.QualityGate.Condition
The operator used to evaluate the error threshold against the value of the measure
getOrganization() - Method in interface org.sonar.api.ce.posttask.PostProjectAnalysisTask.ProjectAnalysis
When organizations are enabled in SonarQube, the organization the project belongs to.
getOriginalName() - Method in class org.sonar.api.batch.bootstrap.ProjectDefinition
Deprecated.
 
getOriginalProjectVersion() - Method in class org.sonar.api.batch.bootstrap.ProjectDefinition
Deprecated.
 
getOriginalVersion() - Method in class org.sonar.api.batch.bootstrap.ProjectDefinition
Deprecated.
getOutput() - Method in class org.sonar.api.utils.command.StringStreamConsumer
 
getOutputMetrics() - Method in interface org.sonar.api.ce.measure.MeasureComputer.MeasureComputerDefinition
Return the metric keys that can be create using MeasureComputer.MeasureComputerContext.
getOutputMetrics() - Method in class org.sonar.api.ce.measure.test.TestMeasureComputerDefinition
 
getOverriddenParams() - Method in class org.sonar.api.server.profile.BuiltInQualityProfilesDefinition.NewBuiltInActiveRule
 
getOverriddenSeverity() - Method in class org.sonar.api.rules.ActiveRule
Deprecated. 
getPages() - Method in class org.sonar.api.web.page.Context
 
getParam(String) - Method in class org.sonar.api.rules.Rule
 
getParam(String) - Method in interface org.sonar.api.server.ws.LocalConnector.LocalRequest
 
getParam(String) - Method in class org.sonar.api.server.ws.Request
 
getParam(String, BiFunction<Request, String, T>) - Method in class org.sonar.api.server.ws.Request
 
getParam(String, Consumer<String>) - Method in class org.sonar.api.server.ws.Request
 
getParamDescription(String, String, String) - Method in interface org.sonar.api.i18n.RuleI18n
Deprecated.
Returns the name of the rule parameter identified by the rules's key and repository key, and by the parameter key.
getParamDescription(String, String, String, Locale) - Method in interface org.sonar.api.i18n.RuleI18n
Deprecated.
since 4.1. Rules are not localized anymore. See http://jira.sonarsource.com/browse/SONAR-4885
getParameter(String) - Method in class org.sonar.api.rules.ActiveRule
 
getParameterMap() - Method in interface org.sonar.api.server.ws.LocalConnector.LocalRequest
 
getParamKey() - Method in class org.sonar.api.rules.ActiveRuleParam
 
getParams() - Method in class org.sonar.api.batch.rule.LoadedActiveRule
 
getParams() - Method in class org.sonar.api.rules.Rule
 
getParams() - Method in class org.sonar.api.server.ws.Request
 
getParent() - Method in class org.sonar.api.batch.bootstrap.ProjectDefinition
Deprecated.
 
getParent() - Method in class org.sonar.api.rules.Rule
Deprecated.
since 4.4, use Rule.getTemplate()
getParentName() - Method in class org.sonar.api.profiles.RulesProfile
Deprecated.
in 6.5
getPassword() - Method in class org.sonar.api.security.Authenticator.Context
Password can be null, for example when using CAS.
getPath() - Method in interface org.sonar.api.server.ws.LocalConnector.LocalRequest
URL path, which is the concatenation of controller path and action key, for example "api/issues/search"
getPath() - Method in class org.sonar.api.server.ws.Request
Return path of the request
getPermanentServerId() - Method in class org.sonar.api.platform.Server
Deprecated.
replaced by Server.getId() in 6.7.
getPluginKey() - Method in class org.sonar.api.web.page.Page
 
getPluginName() - Method in class org.sonar.api.rules.ActiveRule
Deprecated.
since 2.3 use ActiveRule.getRepositoryKey() instead
getPrefix() - Method in class org.sonar.api.config.EmailSettings
 
getPriority() - Method in class org.sonar.api.rules.ActiveRule
Deprecated.
since 2.5 use ActiveRule.getSeverity() instead. See http://jira.sonarsource.com/browse/SONAR-1829
getProduct() - Method in interface org.sonar.api.SonarRuntime
The product being executed at runtime.
getProject() - Method in interface org.sonar.api.ce.posttask.PostProjectAnalysisTask.ProjectAnalysis
Details of the analyzed project.
getProject(String) - Method in class org.sonar.api.batch.bootstrap.ProjectReactor
Deprecated.
 
getProjectAnalysis() - Method in interface org.sonar.api.ce.posttask.PostProjectAnalysisTask.Context
 
getProjects() - Method in class org.sonar.api.batch.bootstrap.ProjectReactor
Deprecated.
 
getProjectVersion() - Method in class org.sonar.api.batch.bootstrap.ProjectDefinition
Deprecated.
 
getProperties() - Method in class org.sonar.api.batch.bootstrap.ProjectDefinition
Deprecated.
getProperties() - Method in interface org.sonar.api.ce.posttask.ScannerContext
 
getProperties() - Method in class org.sonar.api.config.Settings
Deprecated.
Immutable map of the properties that have non-default values.
getProperties() - Method in class org.sonar.api.web.Dashboard.Widget
Deprecated.
Returns the properties of this widget.
getProperty(String) - Method in class org.sonar.api.web.Dashboard.Widget
Deprecated.
 
getPropertyValues(ClassLoader, String) - Static method in class org.sonar.api.utils.ManifestUtils
Search for a property in all the manifests found in the classloader
getProviderId() - Method in class org.sonar.api.server.authentication.UserIdentity
Optional unique ID for the related IdentityProvider.
getProviderLogin() - Method in class org.sonar.api.server.authentication.UserIdentity
Non-blank user login for the related IdentityProvider.
getPublicRootUrl() - Method in class org.sonar.api.platform.Server
Return the public root url, without trailing slash, for instance : https://nemo.sonarqube.org.
getQualifier() - Method in class org.sonar.api.resources.ResourceType
Qualifier is the unique key.
getQualitative() - Method in class org.sonar.api.measures.Metric
 
getQualityGate() - Method in interface org.sonar.api.ce.posttask.PostProjectAnalysisTask.ProjectAnalysis
Status and details of the Quality Gate of the project (if any was configured on the project).
getRawMsg() - Method in class org.sonar.api.utils.log.LogAndArguments
 
getRawString(String) - Method in class org.sonar.api.config.Settings
Deprecated.
The value that overrides the default value.
getReader() - Method in class org.sonar.api.server.ws.Request
 
getRepositoryKey() - Method in class org.sonar.api.rules.ActiveRule
 
getRepositoryKey() - Method in class org.sonar.api.rules.Rule
 
getRepositoryKey() - Method in class org.sonar.api.rules.RuleQuery
 
getRequest() - Method in class org.sonar.api.security.Authenticator.Context
 
getRequest() - Method in class org.sonar.api.security.ExternalGroupsProvider.Context
 
getRequest() - Method in class org.sonar.api.security.ExternalUsersProvider.Context
 
getRequest() - Method in interface org.sonar.api.server.authentication.BaseIdentityProvider.Context
Get the received HTTP request.
getRequest() - Method in interface org.sonar.api.server.authentication.OAuth2IdentityProvider.OAuth2Context
Get the received HTTP request.
getResource(String) - Method in class org.sonar.api.utils.System2
 
getResponse() - Method in interface org.sonar.api.server.authentication.BaseIdentityProvider.Context
Get the HTTP response to send
getResponse() - Method in interface org.sonar.api.server.authentication.OAuth2IdentityProvider.OAuth2Context
Get the HTTP response to send
getResponseCode() - Method in exception org.sonar.api.utils.HttpDownloader.HttpException
 
getResponseContent() - Method in exception org.sonar.api.utils.HttpDownloader.HttpException
 
getRevision() - Method in interface org.sonar.api.ce.posttask.Analysis
SCM revision, if declared during analysis
getRoot() - Method in class org.sonar.api.batch.bootstrap.ProjectReactor
Deprecated.
 
getRootDir() - Method in class org.sonar.api.platform.Server
Deprecated.
in 6.0. Replaced by ServerFileSystem.getHomeDir()
getRoots() - Method in class org.sonar.api.resources.ResourceTypes
 
getRootType() - Method in class org.sonar.api.resources.ResourceTypeTree
 
getRule() - Method in class org.sonar.api.rules.ActiveRule
 
getRule() - Method in class org.sonar.api.rules.RuleParam
 
getRuleKey() - Method in class org.sonar.api.batch.rule.LoadedActiveRule
 
getRuleKey() - Method in class org.sonar.api.rules.ActiveRule
 
getRuleKey(Class) - Static method in class org.sonar.api.rules.RuleAnnotationUtils
 
getRuleParam() - Method in class org.sonar.api.rules.ActiveRuleParam
 
getRulesProfile() - Method in class org.sonar.api.rules.ActiveRule
 
getRuntime() - Method in class org.sonar.api.Plugin.Context
Runtime environment.
getScannerContext() - Method in interface org.sonar.api.ce.posttask.PostProjectAnalysisTask.ProjectAnalysis
Context as defined by scanner through SensorContext.addContextProperty(String, String).
getScmRevisionId() - Method in interface org.sonar.api.ce.posttask.PostProjectAnalysisTask.ProjectAnalysis
Deprecated.
in 7.8, replaced by Analysis#getRevision()
getScope() - Method in class org.sonar.api.web.page.Page
 
getSecureConnection() - Method in class org.sonar.api.config.EmailSettings
 
getServerBaseURL() - Method in class org.sonar.api.config.EmailSettings
 
getServerBaseURL() - Method in interface org.sonar.api.server.authentication.BaseIdentityProvider.Context
Return the server base URL
getSettings() - Method in interface org.sonar.api.ce.measure.MeasureComputer.MeasureComputerContext
Returns settings of the current component.
getSettings() - Method in class org.sonar.api.ce.measure.test.TestMeasureComputerContext
 
getSeverity() - Method in class org.sonar.api.batch.rule.LoadedActiveRule
 
getSeverity() - Method in class org.sonar.api.rules.ActiveRule
 
getSeverity() - Method in class org.sonar.api.rules.Rule
 
getSmtpHost() - Method in class org.sonar.api.config.EmailSettings
 
getSmtpPassword() - Method in class org.sonar.api.config.EmailSettings
 
getSmtpPort() - Method in class org.sonar.api.config.EmailSettings
 
getSmtpUsername() - Method in class org.sonar.api.config.EmailSettings
 
getSonarQubeSide() - Method in interface org.sonar.api.SonarRuntime
The SonarQube/SonarCloud stack being executed at runtime.
getSonarQubeVersion() - Method in interface org.sonar.api.batch.sensor.SensorContext
Version of API at runtime, not at compilation time.
getSonarQubeVersion() - Method in class org.sonar.api.Plugin.Context
Shortcut on getRuntime().getApiVersion() since version 6.0.
getStartedAt() - Method in class org.sonar.api.platform.Server
Date when server started.
getStartLine() - Method in class org.sonar.api.batch.sensor.cpd.internal.TokensLine
 
getStartUnit() - Method in class org.sonar.api.batch.sensor.cpd.internal.TokensLine
 
getStatus() - Method in interface org.sonar.api.ce.posttask.CeTask
Indicates whether the Compute Engine task ended successfully or not.
getStatus() - Method in interface org.sonar.api.ce.posttask.QualityGate.Condition
Evaluation status of this condition
getStatus() - Method in interface org.sonar.api.ce.posttask.QualityGate
Status of the Quality Gate for the current project processing.
getStatus() - Method in class org.sonar.api.rules.Rule
 
getStatus() - Method in interface org.sonar.api.server.ws.LocalConnector.LocalResponse
 
getString(String) - Method in interface org.sonar.api.ce.measure.Settings
Returns the property as a string Matching on key is case sensitive
getString(String) - Method in class org.sonar.api.ce.measure.test.TestSettings
 
getString(String) - Method in class org.sonar.api.config.Settings
Deprecated.
The effective value of the specified property.
getStringArray(String) - Method in interface org.sonar.api.ce.measure.Settings
Returns the property as a an array Returns an empty array if no property is found for this key Matching on key is case sensitive
getStringArray(String) - Method in class org.sonar.api.ce.measure.test.TestSettings
 
getStringArray(String) - Method in interface org.sonar.api.config.Configuration
Used to read multi-valued properties.
getStringArray(String) - Method in class org.sonar.api.config.Settings
Deprecated.
Value is split by comma and trimmed.
getStringArrayBySeparator(String, String) - Method in class org.sonar.api.config.Settings
Deprecated.
Value is split and trimmed.
getStringLines(String) - Method in class org.sonar.api.config.Settings
Deprecated.
Value is split by carriage returns.
getStringProperty(String) - Method in class org.sonar.api.resources.ResourceType
Returns the value of the property for this resource type.
getStringValue() - Method in interface org.sonar.api.ce.measure.Measure
The value of this measure as a string.
getStringValue() - Method in class org.sonar.api.ce.measure.test.TestMeasure
 
getSubCategory(String) - Method in class org.sonar.api.config.PropertyDefinitions
 
getSubCharacteristicKey() - Method in class org.sonar.api.rules.Rule
Deprecated.
in 5.5. SQALE Quality Model is replaced by SonarQube Quality Model.
getSubProjects() - Method in class org.sonar.api.batch.bootstrap.ProjectDefinition
Deprecated.
 
getSuffixes(String...) - Method in class org.sonar.api.resources.Languages
 
getSupportedLanguages() - Method in class org.sonar.api.profiles.ProfileExporter
 
getSupportedLanguages() - Method in class org.sonar.api.profiles.ProfileImporter
 
getSupportedSchemes() - Method in class org.sonar.api.utils.UriReader.SchemeProcessor
 
getSystemTags() - Method in class org.sonar.api.rules.Rule
For internal use
getTags() - Method in class org.sonar.api.rules.Rule
For definition of rule only
getTempDir() - Method in interface org.sonar.api.platform.ServerFileSystem
Temporary directory, clean up on restarts
getTemplate() - Method in class org.sonar.api.rules.Rule
 
getTemplate() - Method in class org.sonar.api.web.AbstractRubyTemplate
Deprecated.
 
getTemplate() - Method in interface org.sonar.api.web.RubyRailsPage
Deprecated.
 
getTemplate() - Method in interface org.sonar.api.web.RubyRailsWidget
Deprecated.
 
getTemplatePath() - Method in class org.sonar.api.web.AbstractRubyTemplate
Deprecated.
the path of the template.
getTemplateRuleKey() - Method in class org.sonar.api.batch.rule.LoadedActiveRule
 
getTitle() - Method in class org.sonar.api.web.AbstractDashboardWidget
Deprecated.
 
getTitle() - Method in interface org.sonar.api.web.View
Deprecated.
 
getType() - Method in interface org.sonar.api.ce.measure.Component
 
getType() - Method in class org.sonar.api.ce.measure.test.TestComponent
 
getType() - Method in interface org.sonar.api.ce.posttask.Branch
 
getType() - Method in class org.sonar.api.measures.Metric
 
getType() - Method in class org.sonar.api.notifications.Notification
Deprecated.
Returns the type of the notification
getType() - Method in class org.sonar.api.rules.RuleParam
 
getTypes() - Method in class org.sonar.api.resources.ResourceTypeTree
 
getUpdatedAt() - Method in class org.sonar.api.batch.rule.LoadedActiveRule
 
getUpdatedAt() - Method in class org.sonar.api.rules.Rule
 
getUri() - Method in exception org.sonar.api.utils.HttpDownloader.HttpException
 
getUrl() - Method in class org.sonar.api.web.ServletFilter.UrlPattern
getURL() - Method in class org.sonar.api.platform.Server
Deprecated.
since 6.5, please use Server.getPublicRootUrl() instead
getUrlPathToJs() - Method in interface org.sonar.api.web.WebAnalytics
Returns the URL path to the Javascript file that will be loaded by the webapp.
getUsed() - Method in class org.sonar.api.profiles.RulesProfile
Deprecated.
profile versioning is dropped in 4.4. Always returns null.
getUserId() - Method in class org.sonar.api.security.UserDetails
 
getUserManaged() - Method in class org.sonar.api.measures.Metric
 
getUsername() - Method in class org.sonar.api.security.Authenticator.Context
Username can be null, for example when using CAS.
getUsername() - Method in class org.sonar.api.security.ExternalGroupsProvider.Context
 
getUsername() - Method in class org.sonar.api.security.ExternalUsersProvider.Context
 
getUsersProvider() - Method in class org.sonar.api.security.SecurityRealm
 
getUuid() - Method in interface org.sonar.api.ce.posttask.Project
The UUID of the project.
getValue() - Method in class org.sonar.api.batch.sensor.cpd.internal.TokensLine
 
getValue() - Method in interface org.sonar.api.ce.posttask.QualityGate.Condition
The value of the measure.
getValue() - Method in class org.sonar.api.rules.ActiveRuleParam
 
getValue() - Method in interface org.sonar.api.server.ws.Request.Param
 
getVersion() - Method in class org.sonar.api.batch.bootstrap.ProjectDefinition
Deprecated.
getVersion() - Method in class org.sonar.api.platform.Server
Non-null version of SonarQube at runtime
getVersion() - Method in class org.sonar.api.profiles.RulesProfile
Deprecated.
profile versioning is dropped in 4.4. Always returns -1.
getVersion() - Method in class org.sonar.api.server.ws.Change
 
getWarnings() - Method in class org.sonar.api.utils.ValidationMessages
 
getWarningThreshold() - Method in interface org.sonar.api.ce.posttask.QualityGate.Condition
Deprecated.
in 7.6. Implementations should always return null.
getWidgets() - Method in class org.sonar.api.web.Dashboard
Deprecated.
 
getWidgetsOfColumn(int) - Method in class org.sonar.api.web.Dashboard
Deprecated.
 
getWorkDir() - Method in class org.sonar.api.batch.bootstrap.ProjectDefinition
Deprecated.
 
getWorstValue() - Method in class org.sonar.api.measures.Metric
 
global() - Method in interface org.sonar.api.batch.sensor.SensorDescriptor
Deprecated.
since 7.6 change your Sensor to a ProjectSensor instead
global() - Method in class org.sonar.api.config.PropertyDefinition
Is the property displayed in global settings page ?
global() - Method in annotation type org.sonar.api.Property
Is the property displayed in global settings page ?
GLOBAL - org.sonar.api.web.page.Page.Scope
 
GLOBAL - Static variable in annotation type org.sonar.api.web.WidgetScope
Deprecated.
 
GLOBAL_EXCLUSIONS_PROPERTY - Static variable in interface org.sonar.api.CoreProperties
 
GLOBAL_TEST_EXCLUSIONS_PROPERTY - Static variable in interface org.sonar.api.CoreProperties
 
GLOBAL_WORKING_DIRECTORY - Static variable in interface org.sonar.api.CoreProperties
 
GLOBAL_WORKING_DIRECTORY_DEFAULT_VALUE - Static variable in interface org.sonar.api.CoreProperties
 
GlobalPropertyChangeHandler - Class in org.sonar.api.config
Observe changes of global properties done from web application.
GlobalPropertyChangeHandler() - Constructor for class org.sonar.api.config.GlobalPropertyChangeHandler
 
GlobalPropertyChangeHandler.PropertyChange - Class in org.sonar.api.config
 
GREATER_THAN - org.sonar.api.ce.posttask.QualityGate.Operator
 
GROUP_NAME_MAX_LENGTH - Static variable in class org.sonar.api.user.UserGroupValidation
 

H

handle(Request, Response) - Method in interface org.sonar.api.server.ws.RequestHandler
 
handleGetObject(String) - Method in class org.sonar.api.utils.LocalizedMessages
 
handler() - Method in class org.sonar.api.server.ws.WebService.Action
 
HARDWARE_RELATED_PORTABILITY - Static variable in class org.sonar.api.server.rule.RulesDefinition.SubCharacteristics
Deprecated.
Related to characteristic PORTABILITY
hasAbsolutePath(String) - Method in interface org.sonar.api.batch.fs.FilePredicates
Predicate that find file by its absolute path.
hasAnyStatus() - Method in interface org.sonar.api.batch.fs.FilePredicates
Explicitely look for InputFile having any InputFile.status()
hasDefaultValue(String) - Method in class org.sonar.api.config.Settings
Deprecated.
 
hasErrors() - Method in class org.sonar.api.utils.ValidationMessages
 
hasExtension(String) - Method in interface org.sonar.api.batch.fs.FilePredicates
Predicate that matches files by extension (case insensitive).
hasFilename(String) - Method in interface org.sonar.api.batch.fs.FilePredicates
Predicate that matches files by filename, in any directory.
hasFiles(FilePredicate) - Method in interface org.sonar.api.batch.fs.FileSystem
Returns true if at least one InputFile matches the given predicate.
hashCode() - Method in class org.sonar.api.batch.bootstrap.ProjectDefinition
Deprecated.
 
hashCode() - Method in class org.sonar.api.batch.scm.BlameLine
 
hashCode() - Method in class org.sonar.api.ce.measure.test.TestComponent
 
hashCode() - Method in class org.sonar.api.config.Category
 
hashCode() - Method in class org.sonar.api.database.model.User
Deprecated.
 
hashCode() - Method in class org.sonar.api.measures.Metric
 
hashCode() - Method in class org.sonar.api.notifications.Notification
Deprecated.
 
hashCode() - Method in class org.sonar.api.profiles.ProfileExporter
 
hashCode() - Method in class org.sonar.api.profiles.ProfileImporter
 
hashCode() - Method in class org.sonar.api.profiles.RulesProfile
 
hashCode() - Method in class org.sonar.api.resources.AbstractLanguage
 
hashCode() - Method in class org.sonar.api.resources.ResourceType
 
hashCode() - Method in class org.sonar.api.rule.RuleKey
 
hashCode() - Method in class org.sonar.api.rules.ActiveRule
 
hashCode() - Method in class org.sonar.api.rules.ActiveRuleParam
 
hashCode() - Method in class org.sonar.api.rules.Rule
 
hashCode() - Method in class org.sonar.api.rules.RuleParam
 
hashCode() - Method in class org.sonar.api.server.debt.internal.DefaultDebtRemediationFunction
 
hashCode() - Method in class org.sonar.api.server.profile.BuiltInQualityProfilesDefinition.BuiltInQualityProfileImpl
 
hashCode() - Method in class org.sonar.api.server.rule.internal.DefaultParam
 
hashCode() - Method in class org.sonar.api.server.rule.internal.DefaultRepository
 
hashCode() - Method in class org.sonar.api.server.rule.internal.DefaultRule
 
hashCode() - Method in class org.sonar.api.server.rule.RuleParamType
 
hashCode() - Method in class org.sonar.api.task.TaskDefinition
Deprecated.
 
hashCode() - Method in class org.sonar.api.utils.dag.Node
 
hashCode() - Method in class org.sonar.api.utils.Duration
 
hashCode() - Method in class org.sonar.api.utils.Version
 
hasInfos() - Method in class org.sonar.api.utils.ValidationMessages
 
hasKey(String) - Method in interface org.sonar.api.config.Configuration
 
hasKey(String) - Method in class org.sonar.api.config.Settings
Deprecated.
 
hasLanguage(String) - Method in interface org.sonar.api.batch.fs.FilePredicates
 
hasLanguages(String...) - Method in interface org.sonar.api.batch.fs.FilePredicates
 
hasLanguages(Collection<String>) - Method in interface org.sonar.api.batch.fs.FilePredicates
 
hasNextPage() - Method in class org.sonar.api.utils.Paging
 
hasParam(String) - Method in interface org.sonar.api.server.ws.LocalConnector.LocalRequest
 
hasParam(String) - Method in class org.sonar.api.server.ws.Request
Return true of the parameter is set in the request.
hasPath(String) - Method in interface org.sonar.api.batch.fs.FilePredicates
if the parameter represents an absolute path for the running environment, then returns FilePredicates.hasAbsolutePath(String), else FilePredicates.hasRelativePath(String)
hasProperty(String) - Method in class org.sonar.api.resources.ResourceType
 
hasRelativePath(String) - Method in interface org.sonar.api.batch.fs.FilePredicates
Predicate that gets a file by its relative path.
hasSecretKey() - Method in class org.sonar.api.config.Encryption
Checks the availability of the secret key, that is required to encrypt and decrypt.
hasSourceCode() - Method in class org.sonar.api.resources.ResourceType.Builder
Tells that the resources of this type will have source code.
hasSourceCode() - Method in class org.sonar.api.resources.ResourceType
Tells whether resources of this type has source code or not.
hasStatus(InputFile.Status) - Method in interface org.sonar.api.batch.fs.FilePredicates
Look for InputFile having a specific InputFile.status()
hasType(InputFile.Type) - Method in interface org.sonar.api.batch.fs.FilePredicates
 
hasURI(URI) - Method in interface org.sonar.api.batch.fs.FilePredicates
Predicate that gets a file by its IndexedFile.uri().
hasWarnings() - Method in class org.sonar.api.utils.ValidationMessages
 
header(String) - Method in class org.sonar.api.server.ws.Request
Optional value of the HTTP header with specified name.
hidden() - Method in class org.sonar.api.config.PropertyDefinition.Builder
Flag the property as hidden.
highlight(int, int, int, int, TypeOfText) - Method in interface org.sonar.api.batch.sensor.highlighting.NewHighlighting
Shortcut to avoid calling InputFile.newRange(int, int, int, int)
highlight(int, int, TypeOfText) - Method in interface org.sonar.api.batch.sensor.highlighting.NewHighlighting
Deprecated.
since 5.6 Only supported to ease migration from old API. Please prefer other highlight() methods.
highlight(TextRange, TypeOfText) - Method in interface org.sonar.api.batch.sensor.highlighting.NewHighlighting
Call this method to indicate the type of text in a range.
HOME - org.sonar.api.web.Section
Deprecated.
 
HOME - Static variable in annotation type org.sonar.api.web.NavigationSection
Deprecated.
 
HOUR - Static variable in class org.sonar.api.utils.Duration
 
HOURS_IN_DAY - Static variable in interface org.sonar.api.CoreProperties
Deprecated.
no more used since 6.3. See https://jira.sonarsource.com/browse/SONAR-8610
htmlDescription() - Method in class org.sonar.api.server.rule.internal.DefaultRule
 
htmlDescription() - Method in class org.sonar.api.server.rule.RulesDefinition.Rule
 
HttpDownloader - Class in org.sonar.api.utils
This component is available in IoC container, so it should be injected through a constructor parameter.
HttpDownloader() - Constructor for class org.sonar.api.utils.HttpDownloader
 
HttpDownloader.HttpException - Exception in org.sonar.api.utils
 
HttpException(URI, int) - Constructor for exception org.sonar.api.utils.HttpDownloader.HttpException
 
HttpException(URI, int, String) - Constructor for exception org.sonar.api.utils.HttpDownloader.HttpException
 

I

I18n - Interface in org.sonar.api.i18n
Deprecated.
since 7.8 as plugins as no reason to use it anymore
IdentityProvider - Interface in org.sonar.api.server.authentication
Entry-point to define a new Identity provider.
ignoreCommand() - Method in class org.sonar.api.batch.scm.ScmProvider
 
IgnoreCommand - Interface in org.sonar.api.batch.scm
 
IIssue - Interface in org.sonar.api.batch.sensor.issue
 
IllegalDurationException - Exception in org.sonar.api.test.exception
Deprecated.
since 5.6 feature will be removed soon
IllegalDurationException(String) - Constructor for exception org.sonar.api.test.exception.IllegalDurationException
Deprecated.
 
IMPORT_UNKNOWN_FILES_KEY - Static variable in interface org.sonar.api.CoreProperties
Deprecated.
since 6.3. No longer taken into consideration as all files are always imported.
importProfile(Reader, ValidationMessages) - Method in class org.sonar.api.profiles.ProfileImporter
Import the profile from a reader.
includeDeactivated() - Method in class org.sonar.api.user.UserQuery.Builder
 
includeDeactivated() - Method in class org.sonar.api.user.UserQuery
 
includes(String...) - Method in class org.sonar.api.web.ServletFilter.UrlPattern.Builder
Add inclusion patterns.
includes(Collection<String>) - Method in class org.sonar.api.web.ServletFilter.UrlPattern.Builder
Add exclusion patterns.
index() - Method in class org.sonar.api.config.PropertyDefinition
Order to display properties in Sonar UI.
index(int) - Method in class org.sonar.api.config.PropertyDefinition.Builder
Set the order index in Settings pages.
IndexedFile - Interface in org.sonar.api.batch.fs
Represents the indexed view of an InputFile.
indicativeSize() - Method in class org.sonar.api.config.PropertyFieldDefinition
Deprecated.
since 6.1, as it was only used for UI.
indicativeSize() - Method in annotation type org.sonar.api.PropertyField
Deprecated.
since 6.1, as it was only used for UI.
indicativeSize(int) - Method in class org.sonar.api.config.PropertyFieldDefinition.Builder
Deprecated.
since 6.1, as it was only used for UI.
info(String) - Method in interface org.sonar.api.utils.log.Logger
Logs an INFO level message.
info(String, Object) - Method in interface org.sonar.api.utils.log.Logger
Logs an INFO parameterized message according to the specified format and argument.
info(String, Object...) - Method in interface org.sonar.api.utils.log.Logger
Logs an INFO parameterized message according to the specified format and arguments.
info(String, Object, Object) - Method in interface org.sonar.api.utils.log.Logger
Logs an INFO parameterized message according to the specified format and arguments.
INFO - org.sonar.api.batch.rule.Severity
 
INFO - org.sonar.api.rules.RulePriority
Deprecated.
WARNING : DO NOT CHANGE THE ENUMERATION ORDER the enum ordinal is used for db persistence
INFO - org.sonar.api.utils.log.LoggerLevel
 
INFO - Static variable in class org.sonar.api.rule.Severity
 
INFO_VIOLATIONS - Static variable in class org.sonar.api.measures.CoreMetrics
 
INFO_VIOLATIONS_KEY - Static variable in class org.sonar.api.measures.CoreMetrics
 
INHERITED - Static variable in class org.sonar.api.rules.ActiveRule
 
init() - Method in interface org.sonar.api.security.LoginPasswordAuthenticator
Deprecated.
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
init() - Method in class org.sonar.api.security.SecurityRealm
Invoked during server startup and can be used to initialize internal state.
init(Path) - Method in interface org.sonar.api.batch.scm.IgnoreCommand
Must be called before the calling IgnoreCommand.isIgnored(Path) It should contains any operation (e.g.
init(BaseIdentityProvider.Context) - Method in interface org.sonar.api.server.authentication.BaseIdentityProvider
Entry-point of authentication workflow.
init(OAuth2IdentityProvider.InitContext) - Method in interface org.sonar.api.server.authentication.OAuth2IdentityProvider
Entry-point of authentication workflow.
INPUT_VALIDATION_AND_REPRESENTATION - Static variable in class org.sonar.api.server.rule.RulesDefinition.SubCharacteristics
Deprecated.
Related to characteristic SECURITY
inputComponent() - Method in interface org.sonar.api.batch.postjob.issue.PostJobIssue
The InputComponent this issue belongs to.
inputComponent() - Method in interface org.sonar.api.batch.sensor.issue.IssueLocation
The InputComponent this location belongs to.
inputComponent() - Method in interface org.sonar.api.batch.sensor.measure.Measure
The InputComponent this measure belongs to.
InputComponent - Interface in org.sonar.api.batch.fs
Common interface for all input components.
inputDir(File) - Method in interface org.sonar.api.batch.fs.FileSystem
Deprecated.
since 6.6 Ability to report issues or measures on directories will soon be dropped. Report issues on project if needed.
InputDir - Interface in org.sonar.api.batch.fs
Deprecated.
since 6.6 Ability to report issues or measures on directories will soon be dropped. Report issues on project if needed.
inputFile() - Method in interface org.sonar.api.batch.sensor.error.AnalysisError
The file that was being processed when the error occurred.
inputFile(String) - Method in interface org.sonar.api.batch.fs.FileSystem.Index
 
inputFile(FilePredicate) - Method in interface org.sonar.api.batch.fs.FileSystem
Returns the single element matching the predicate.
InputFile - Interface in org.sonar.api.batch.fs
This layer over File adds information for code analyzers.
InputFile.Status - Enum in org.sonar.api.batch.fs
Deprecated.
since 7.7 preview mode was dropped
InputFile.Type - Enum in org.sonar.api.batch.fs
 
InputFileFilter - Interface in org.sonar.api.batch.fs
Extension point to exclude some files from inspection
inputFiles() - Method in interface org.sonar.api.batch.fs.FileSystem.Index
 
inputFiles(FilePredicate) - Method in interface org.sonar.api.batch.fs.FileSystem
Input files matching the given attributes.
InputModule - Interface in org.sonar.api.batch.fs
Deprecated.
since 7.6 modules are deprecated. Use InputProject instead.
InputPath - Interface in org.sonar.api.batch.fs
Layer over File for files or directories.
InputProject - Interface in org.sonar.api.scanner.fs
Used to create issues and measures on project.
inputStream() - Method in interface org.sonar.api.batch.fs.IndexedFile
Creates a stream of the file's contents.
inputStream() - Method in interface org.sonar.api.batch.fs.InputFile
Creates a stream of the file's contents.
INSTANCE - Static variable in class org.sonar.api.utils.System2
 
InstantiationStrategy - Annotation Type in org.sonar.api.batch
Deprecated.
since 7.6 removal of modules and tasks is planned. All extensions should progressively move to the project scope, using ScannerSide
INSTRUCTION_RELIABILITY - Static variable in class org.sonar.api.server.rule.RulesDefinition.SubCharacteristics
Deprecated.
Related to characteristic RELIABILITY
INT - org.sonar.api.measures.Metric.ValueType
 
INTEGER - org.sonar.api.PropertyType
Integer value, positive or negative
INTEGER - org.sonar.api.web.WidgetPropertyType
Deprecated.
Integer value, positive or negative
INTEGER - Static variable in class org.sonar.api.server.rule.RuleParamType
 
INTEGRATION_TESTABILITY - Static variable in class org.sonar.api.server.rule.RulesDefinition.SubCharacteristics
Deprecated.
Related to characteristic TESTABILITY
internalKey() - Method in interface org.sonar.api.batch.rule.ActiveRule
Optional key declared and used by the underlying rule engine.
internalKey() - Method in interface org.sonar.api.batch.rule.Rule
 
internalKey() - Method in class org.sonar.api.server.rule.internal.DefaultRule
 
internalKey() - Method in class org.sonar.api.server.rule.RulesDefinition.Rule
 
is(File) - Method in interface org.sonar.api.batch.fs.FilePredicates
Warning - may not be supported in SonarLint
isActivated() - Method in class org.sonar.api.web.Dashboard
Deprecated.
A dashboard can be activated for all anonymous users or users who haven't configured their own dashboards.
isAdmin() - Method in class org.sonar.api.web.page.Page
 
isAnyone(String) - Static method in class org.sonar.api.security.DefaultGroups
 
isCancelled() - Method in interface org.sonar.api.batch.sensor.SensorContext
Test if a cancellation of the analysis was requested.
isCopied() - Method in interface org.sonar.api.issue.Issue
During a scan returns true if the issue is copied from another branch.
isDataType() - Method in class org.sonar.api.measures.Metric
 
isDebugEnabled() - Method in interface org.sonar.api.utils.log.Logger
 
isDebugEnabled() - Method in class org.sonar.api.utils.log.Profiler
 
isDefault() - Method in interface org.sonar.api.server.profile.BuiltInQualityProfilesDefinition.BuiltInQualityProfile
 
isDefault() - Method in class org.sonar.api.server.profile.BuiltInQualityProfilesDefinition.BuiltInQualityProfileImpl
 
isDefault() - Method in interface org.sonar.api.server.profile.BuiltInQualityProfilesDefinition.NewBuiltInQualityProfile
 
isDefault() - Method in class org.sonar.api.server.profile.BuiltInQualityProfilesDefinition.NewBuiltInQualityProfileImpl
 
isDev() - Method in class org.sonar.api.platform.Server
Deprecated.
in 6.6
isEmpty() - Method in interface org.sonar.api.batch.fs.InputFile
Check if the file content is empty (ignore potential BOM).
isEmpty() - Method in class org.sonar.api.ce.measure.RangeDistributionBuilder
 
isEnabled() - Method in class org.sonar.api.rules.ActiveRule
 
isEnabled() - Method in class org.sonar.api.rules.Rule
 
isEnabled() - Method in interface org.sonar.api.server.authentication.IdentityProvider
Is the provider fully configured and enabled ? If true, then the provider is available in login form.
isEncrypted(String) - Method in class org.sonar.api.config.Encryption
 
isExternal() - Method in class org.sonar.api.server.rule.internal.DefaultNewRepository
 
isExternal() - Method in class org.sonar.api.server.rule.internal.DefaultRepository
 
isExternal() - Method in interface org.sonar.api.server.rule.RulesDefinition.NewRepository
 
isExternal() - Method in interface org.sonar.api.server.rule.RulesDefinition.Repository
 
isFile() - Method in interface org.sonar.api.batch.fs.InputComponent
Is the component an InputFile
isFreshInstall() - Method in interface org.sonar.api.platform.ServerUpgradeStatus
Has the database been created from scratch during the current startup ?
isGlobal() - Method in class org.sonar.api.web.Dashboard
Deprecated.
A dashboard is global when it doesn't display information from a project but rather more general information.
isGreaterThan(Duration) - Method in class org.sonar.api.utils.Duration
Return true if the given duration is greater than the current one.
isGreaterThanOrEqual(Version) - Method in class org.sonar.api.SonarQubeVersion
Deprecated.
 
isGreaterThanOrEqual(Version) - Method in class org.sonar.api.utils.Version
 
isHidden() - Method in class org.sonar.api.measures.Metric
 
isHigherThan(String, String) - Static method in class org.sonar.api.resources.Scopes
 
isHigherThanOrEquals(String, String) - Static method in class org.sonar.api.resources.Scopes
 
isIgnored(Path) - Method in interface org.sonar.api.batch.scm.IgnoreCommand
Check if a file is ignored by the scm.
isInherited() - Method in class org.sonar.api.rules.ActiveRule
 
isInternal() - Method in class org.sonar.api.server.ws.WebService.Action
 
isInternal() - Method in class org.sonar.api.server.ws.WebService.Controller
Returns true if all the actions are for internal use
isInternal() - Method in class org.sonar.api.server.ws.WebService.Param
Is the parameter internal ?
isIssues() - Method in interface org.sonar.api.batch.AnalysisMode
Deprecated.
 
isJavaAtLeast17() - Method in class org.sonar.api.utils.System2
Deprecated.
in 6.4. Java 8+ is required, so this method always returns true.
isMain() - Method in interface org.sonar.api.ce.posttask.Branch
 
isNew() - Method in interface org.sonar.api.batch.postjob.issue.PostJobIssue
If the issue a new one.
isNew() - Method in interface org.sonar.api.issue.Issue
During a scan return if the current issue is a new one.
isNewShell() - Method in class org.sonar.api.utils.command.Command
true if a new shell should be used to execute the command.
isNumericType() - Method in class org.sonar.api.measures.Metric
 
isOnLeakPeriod() - Method in interface org.sonar.api.ce.posttask.QualityGate.Condition
Deprecated.
in 7.6. Implementations should always return false. Conditions "on leak period" were removed. Use "New X" conditions instead.
isOptimizedBestValue() - Method in class org.sonar.api.measures.Metric
 
isOsMac() - Method in class org.sonar.api.utils.System2
True if this is Mac system.
isOsWindows() - Method in class org.sonar.api.utils.System2
True if this is MS Windows.
isPercentageType() - Method in class org.sonar.api.measures.Metric
 
isPost() - Method in class org.sonar.api.server.ws.WebService.Action
 
isPresent() - Method in interface org.sonar.api.server.ws.Request.Param
 
isPreview() - Method in interface org.sonar.api.batch.AnalysisMode
Deprecated.
 
isPublish() - Method in interface org.sonar.api.batch.AnalysisMode
Deprecated.
 
isQualifierPresent(String) - Method in class org.sonar.api.resources.ResourceTypes
 
isRequired() - Method in class org.sonar.api.server.ws.WebService.Param
Is the parameter required or optional ?
isSecured() - Method in class org.sonar.api.platform.Server
Deprecated.
since 5.6, use instead HttpServletRequest.getHeader(String) and check that X-Forwarded-Proto header is set to "https".
isSpecial() - Method in class org.sonar.api.config.Category
 
Issue - Interface in org.sonar.api.batch.sensor.issue
Represents an issue detected by a Sensor.
Issue - Interface in org.sonar.api.ce.measure
Issue that can be used in a MeasureComputer
Issue - Interface in org.sonar.api.issue
 
ISSUE_ADMIN - Static variable in annotation type org.sonar.api.web.UserRole
 
ISSUE_FILTER - org.sonar.api.web.WidgetPropertyType
Deprecated.
Issue Filter id
Issue.Flow - Interface in org.sonar.api.batch.sensor.issue
 
IssueComment - Interface in org.sonar.api.issue
Deprecated.
since 7.2, comments are no more available
IssueFilter - Interface in org.sonar.api.scan.issue.filter
Deprecated.
since 7.6
IssueFilterChain - Interface in org.sonar.api.scan.issue.filter
A filter chain is an object provided to issues filters for fine control over the filtering logic.
issueKey() - Method in interface org.sonar.api.issue.IssueComment
Deprecated.
 
IssueLocation - Interface in org.sonar.api.batch.sensor.issue
Represents an issue location.
issues() - Method in interface org.sonar.api.batch.postjob.PostJobContext
Deprecated.
since 7.3 the preview/issues mode is deprecated since 6.7
isTemplate() - Method in class org.sonar.api.rules.Rule
 
isTraceEnabled() - Method in interface org.sonar.api.utils.log.Logger
 
isTraceEnabled() - Method in class org.sonar.api.utils.log.Profiler
 
isUnitTest() - Method in interface org.sonar.api.ce.measure.Component.FileAttributes
 
isUnitTest() - Method in class org.sonar.api.ce.measure.test.TestComponent.FileAttributesImpl
 
isUpgraded() - Method in interface org.sonar.api.platform.ServerUpgradeStatus
Has the database been upgraded during the current startup ? Return false when ServerUpgradeStatus.isFreshInstall() is true.
isValid() - Method in class org.sonar.api.config.PropertyDefinition.Result
 
isValid(String) - Static method in class org.sonar.api.server.rule.RuleTagFormat
 
IT - org.sonar.api.batch.sensor.coverage.CoverageType
Deprecated.
 

J

JsonWriter - Class in org.sonar.api.utils.text
Writes JSON as a stream.

K

key() - Method in interface org.sonar.api.batch.fs.InputComponent
Component key shared by all part of SonarQube (scanner, server, WS...).
key() - Method in interface org.sonar.api.batch.measure.Metric
 
key() - Method in interface org.sonar.api.batch.postjob.issue.PostJobIssue
Key of the issue.
key() - Method in interface org.sonar.api.batch.rule.Rule
 
key() - Method in interface org.sonar.api.batch.rule.RuleParam
 
key() - Method in class org.sonar.api.batch.scm.ScmProvider
Unique identifier of the provider.
key() - Method in interface org.sonar.api.ce.measure.Issue
 
key() - Method in class org.sonar.api.ce.measure.test.TestIssue
 
key() - Method in class org.sonar.api.config.Category
 
key() - Method in class org.sonar.api.config.PropertyDefinition
Unique key within all plugins.
key() - Method in class org.sonar.api.config.PropertyFieldDefinition
 
key() - Method in interface org.sonar.api.issue.Issue
Unique generated key.
key() - Method in interface org.sonar.api.issue.IssueComment
Deprecated.
 
key() - Method in class org.sonar.api.measures.Metric
 
key() - Method in annotation type org.sonar.api.Property
Unique key within all plugins.
key() - Method in annotation type org.sonar.api.PropertyField
Unique key within a property.
key() - Method in class org.sonar.api.server.profile.BuiltInQualityProfilesDefinition.NewOverriddenParam
 
key() - Method in class org.sonar.api.server.profile.BuiltInQualityProfilesDefinition.OverriddenParam
 
key() - Method in class org.sonar.api.server.rule.internal.DefaultNewParam
 
key() - Method in class org.sonar.api.server.rule.internal.DefaultNewRepository
 
key() - Method in class org.sonar.api.server.rule.internal.DefaultParam
 
key() - Method in class org.sonar.api.server.rule.internal.DefaultRepository
 
key() - Method in class org.sonar.api.server.rule.internal.DefaultRule
 
key() - Method in interface org.sonar.api.server.rule.RulesDefinition.ExtendedRepository
 
key() - Method in interface org.sonar.api.server.rule.RulesDefinition.NewExtendedRepository
 
key() - Method in class org.sonar.api.server.rule.RulesDefinition.NewParam
 
key() - Method in class org.sonar.api.server.rule.RulesDefinition.NewRule
 
key() - Method in interface org.sonar.api.server.rule.RulesDefinition.Param
 
key() - Method in class org.sonar.api.server.rule.RulesDefinition.Rule
 
key() - Method in class org.sonar.api.server.ws.WebService.Action
 
key() - Method in class org.sonar.api.server.ws.WebService.Param
 
key() - Method in class org.sonar.api.task.TaskDefinition
Deprecated.
 
key() - Method in annotation type org.sonar.api.web.WidgetProperty
Deprecated.
 
key(String) - Method in class org.sonar.api.task.TaskDefinition.Builder
Deprecated.
 
KeyValueFormat - Class in org.sonar.api.utils
Formats and parses key/value pairs with the text representation : "key1=value1;key2=value2".
KeyValueFormat.Converter<T> - Class in org.sonar.api.utils
 
KeyValueFormat.DateConverter - Class in org.sonar.api.utils
 
KeyValueFormat.DoubleConverter - Class in org.sonar.api.utils
 
KeyValueFormat.IntegerConverter - Class in org.sonar.api.utils
 
KeyValueFormat.PriorityConverter - Class in org.sonar.api.utils
 
KeyValueFormat.StringConverter - Class in org.sonar.api.utils
 
KeyValueFormat.ToStringConverter - Class in org.sonar.api.utils
 
KEYWORD - org.sonar.api.batch.sensor.highlighting.TypeOfText
 
KEYWORD_LIGHT - org.sonar.api.batch.sensor.highlighting.TypeOfText
 

L

l10nKey() - Method in exception org.sonar.api.utils.MessageException
 
l10nParams() - Method in exception org.sonar.api.utils.MessageException
 
label() - Method in class org.sonar.api.web.ServletFilter.UrlPattern
 
language() - Method in interface org.sonar.api.batch.fs.IndexedFile
Language, for example "java" or "php".
language() - Method in interface org.sonar.api.batch.fs.InputFile
Language, for example "java" or "php".
language() - Method in interface org.sonar.api.batch.rule.ActiveRule
Language of rule, for example java
language() - Method in interface org.sonar.api.issue.Issue
 
language() - Method in interface org.sonar.api.server.profile.BuiltInQualityProfilesDefinition.BuiltInQualityProfile
 
language() - Method in class org.sonar.api.server.profile.BuiltInQualityProfilesDefinition.BuiltInQualityProfileImpl
 
language() - Method in interface org.sonar.api.server.profile.BuiltInQualityProfilesDefinition.NewBuiltInQualityProfile
 
language() - Method in class org.sonar.api.server.profile.BuiltInQualityProfilesDefinition.NewBuiltInQualityProfileImpl
 
language() - Method in class org.sonar.api.server.rule.internal.DefaultNewRepository
 
language() - Method in class org.sonar.api.server.rule.internal.DefaultRepository
 
language() - Method in interface org.sonar.api.server.rule.RulesDefinition.ExtendedRepository
 
Language - Interface in org.sonar.api.resources
The extension point to define a new language
LANGUAGE_RELATED_PORTABILITY - Static variable in class org.sonar.api.server.rule.RulesDefinition.SubCharacteristics
Deprecated.
Related to characteristic PORTABILITY
LANGUAGE_SPECIFIC_PARAMETERS - Static variable in interface org.sonar.api.CoreProperties
 
LANGUAGE_SPECIFIC_PARAMETERS_LANGUAGE_KEY - Static variable in interface org.sonar.api.CoreProperties
 
LANGUAGE_SPECIFIC_PARAMETERS_MAN_DAYS_KEY - Static variable in interface org.sonar.api.CoreProperties
 
LANGUAGE_SPECIFIC_PARAMETERS_SIZE_METRIC_KEY - Static variable in interface org.sonar.api.CoreProperties
 
languages() - Method in interface org.sonar.api.batch.fs.FileSystem
Languages detected in all files, whatever their type (main or test)
Languages - Class in org.sonar.api.resources
A class to store the list of languages
Languages() - Constructor for class org.sonar.api.resources.Languages
No languages are installed
Languages(Language...) - Constructor for class org.sonar.api.resources.Languages
Creates a list of languages
LAST_COMMIT_DATE - Static variable in class org.sonar.api.measures.CoreMetrics
Date of the most recent commit.
LAST_COMMIT_DATE_KEY - Static variable in class org.sonar.api.measures.CoreMetrics
 
LESS_THAN - org.sonar.api.ce.posttask.QualityGate.Operator
 
LEVEL - org.sonar.api.measures.Metric.ValueType
 
LIBRARY - Static variable in class org.sonar.api.resources.Qualifiers
Deprecated.
since 5.2 No more design features
LICENSE - org.sonar.api.PropertyType
Deprecated.
in 6.7.
lifespan() - Method in annotation type org.sonarsource.api.sonarlint.SonarLintSide
Control the lifecycle of the component in the IoC container.
line() - Method in interface org.sonar.api.batch.fs.TextPointer
The logical line where this pointer is located.
line() - Method in interface org.sonar.api.batch.postjob.issue.PostJobIssue
Line of the issue.
line() - Method in interface org.sonar.api.issue.Issue
Optional line number.
line() - Method in interface org.sonar.api.scan.issue.filter.FilterableIssue
Deprecated.
since 7.2. Use FilterableIssue.textRange() instead.
LINE_COVERAGE - Static variable in class org.sonar.api.measures.CoreMetrics
 
LINE_COVERAGE_KEY - Static variable in class org.sonar.api.measures.CoreMetrics
 
linear(String) - Method in interface org.sonar.api.server.rule.RulesDefinition.DebtRemediationFunctions
Shortcut for create(Type.LINEAR, gap multiplier, null).
LINEAR - org.sonar.api.server.debt.DebtRemediationFunction.Type
The cost to fix an issue of this type depends on the magnitude of the issue.
LINEAR_OFFSET - org.sonar.api.server.debt.DebtRemediationFunction.Type
It takes a certain amount of time to deal with an issue of this type (this is the gap multiplier).
linearWithOffset(String, String) - Method in interface org.sonar.api.server.rule.RulesDefinition.DebtRemediationFunctions
Shortcut for create(Type.LINEAR_OFFSET, gap multiplier, base effort).
lineHits(int, int) - Method in interface org.sonar.api.batch.sensor.coverage.NewCoverage
Call this method as many time as needed to report coverage hits per line.
lineOffset() - Method in interface org.sonar.api.batch.fs.TextPointer
The offset of this pointer in the current line.
lines() - Method in interface org.sonar.api.batch.fs.InputFile
Number of physical lines.
lines() - Method in interface org.sonar.api.test.CoverageBlock
Deprecated.
 
LINES - Static variable in class org.sonar.api.measures.CoreMetrics
 
LINES_KEY - Static variable in class org.sonar.api.measures.CoreMetrics
Computed by the platform since SQ 5.1
LINES_TO_COVER - Static variable in class org.sonar.api.measures.CoreMetrics
 
LINES_TO_COVER_KEY - Static variable in class org.sonar.api.measures.CoreMetrics
 
LINKS_CI - Static variable in interface org.sonar.api.CoreProperties
 
LINKS_HOME_PAGE - Static variable in interface org.sonar.api.CoreProperties
 
LINKS_ISSUE_TRACKER - Static variable in interface org.sonar.api.CoreProperties
 
LINKS_SOURCES - Static variable in interface org.sonar.api.CoreProperties
 
LINKS_SOURCES_DEV - Static variable in interface org.sonar.api.CoreProperties
Deprecated.
since 7.1, developer connection link is no more feed
ListInterceptor - Class in org.sonar.api.utils.log
 
ListInterceptor() - Constructor for class org.sonar.api.utils.log.ListInterceptor
 
load(BuiltInQualityProfilesDefinition.NewBuiltInQualityProfile, String, Class...) - Method in class org.sonar.api.server.profile.BuiltInQualityProfileAnnotationLoader
 
load(RulesDefinition.NewExtendedRepository, Class...) - Method in class org.sonar.api.server.rule.RulesDefinitionAnnotationLoader
 
load(RulesDefinition.NewRepository) - Method in class org.sonar.api.server.rule.RulesDefinitionI18nLoader
Loads descriptions of rules and related rule parameters.
load(RulesDefinition.NewRepository, InputStream, String) - Method in class org.sonar.api.server.rule.RulesDefinitionXmlLoader
Loads rules by reading the XML input stream.
load(RulesDefinition.NewRepository, InputStream, Charset) - Method in class org.sonar.api.server.rule.RulesDefinitionXmlLoader
 
load(RulesDefinition.NewRepository, Reader) - Method in class org.sonar.api.server.rule.RulesDefinitionXmlLoader
Loads rules by reading the XML input stream.
LoadedActiveRule - Class in org.sonar.api.batch.rule
 
LoadedActiveRule() - Constructor for class org.sonar.api.batch.rule.LoadedActiveRule
 
loadTemplateFromCache() - Method in class org.sonar.api.web.AbstractRubyTemplate
Deprecated.
 
localConnector() - Method in class org.sonar.api.server.ws.Request
Allows a web service to call another web service.
LocalConnector - Interface in org.sonar.api.server.ws
This class allows a web service to call another web service through the sonar-ws library.
LocalConnector.LocalRequest - Interface in org.sonar.api.server.ws
 
LocalConnector.LocalResponse - Interface in org.sonar.api.server.ws
 
LocalizedMessages - Class in org.sonar.api.utils
 
LocalizedMessages(Locale, String...) - Constructor for class org.sonar.api.utils.LocalizedMessages
Constructs a resource bundle from a list of other resource bundles.
location() - Method in interface org.sonar.api.batch.sensor.error.AnalysisError
Location of the error.
locations() - Method in interface org.sonar.api.batch.sensor.issue.Issue.Flow
 
log(Logger) - Method in class org.sonar.api.utils.ValidationMessages
Deprecated.
replaced by ValidationMessages.log(org.sonar.api.utils.log.Logger) since deprecation of slf4j in 5.1
log(Logger) - Method in class org.sonar.api.utils.ValidationMessages
 
log(LoggerLevel, String) - Method in class org.sonar.api.utils.log.ListInterceptor
 
log(LoggerLevel, String, Object) - Method in class org.sonar.api.utils.log.ListInterceptor
 
log(LoggerLevel, String, Object...) - Method in class org.sonar.api.utils.log.ListInterceptor
 
log(LoggerLevel, String, Object, Object) - Method in class org.sonar.api.utils.log.ListInterceptor
 
log(LoggerLevel, String, Throwable) - Method in class org.sonar.api.utils.log.ListInterceptor
 
LogAndArguments - Class in org.sonar.api.utils.log
 
Logger - Interface in org.sonar.api.utils.log
SonarQube plugins are not coupled with external logging libraries like SLF4J or Logback.
LoggerLevel - Enum in org.sonar.api.utils.log
 
Loggers - Class in org.sonar.api.utils.log
 
Loggers() - Constructor for class org.sonar.api.utils.log.Loggers
 
LOGIC_CHANGEABILITY - Static variable in class org.sonar.api.server.rule.RulesDefinition.SubCharacteristics
Deprecated.
Related to characteristic CHANGEABILITY
LOGIC_RELIABILITY - Static variable in class org.sonar.api.server.rule.RulesDefinition.SubCharacteristics
Deprecated.
Related to characteristic RELIABILITY
login() - Method in interface org.sonar.api.user.User
 
LOGIN - Static variable in interface org.sonar.api.CoreProperties
 
LoginPasswordAuthenticator - Interface in org.sonar.api.security
Deprecated.
replaced by Authenticator in version 3.1
logins() - Method in class org.sonar.api.user.UserQuery
 
logins(String...) - Method in class org.sonar.api.user.UserQuery.Builder
 
logins(Collection<String>) - Method in class org.sonar.api.user.UserQuery.Builder
 
logs() - Method in class org.sonar.api.utils.log.ListInterceptor
 
logs() - Method in class org.sonar.api.utils.log.LogTester
Logs in chronological order (item at index 0 is the oldest one)
logs(LoggerLevel) - Method in class org.sonar.api.utils.log.ListInterceptor
 
logs(LoggerLevel) - Method in class org.sonar.api.utils.log.LogTester
Logs in chronological order (item at index 0 is the oldest one) for a given level
LogTester - Class in org.sonar.api.utils.log
For tests only
This JUnit rule allows to configure and access logs in tests.
LogTester() - Constructor for class org.sonar.api.utils.log.LogTester
 
LONG - org.sonar.api.ce.posttask.Branch.Type
 
LONG - org.sonar.api.PropertyType
Deprecated.
since 6.3, this type is useless as Dashboards have been removed
LONG_LIVED_BRANCHES_REGEX - Static variable in interface org.sonar.api.CoreProperties
 
longToDate(Long) - Static method in class org.sonar.api.utils.DateUtils
 

M

MAIN - org.sonar.api.batch.fs.InputFile.Type
 
MAIN - org.sonar.api.rule.RuleScope
 
MAINTAINABILITY_COMPLIANCE - Static variable in class org.sonar.api.server.rule.RulesDefinition.SubCharacteristics
Deprecated.
Related to characteristic MAINTAINABILITY
major() - Method in class org.sonar.api.utils.Version
 
MAJOR - org.sonar.api.batch.rule.Severity
 
MAJOR - org.sonar.api.rules.RulePriority
Deprecated.
 
MAJOR - Static variable in class org.sonar.api.rule.Severity
 
MAJOR_VIOLATIONS - Static variable in class org.sonar.api.measures.CoreMetrics
 
MAJOR_VIOLATIONS_KEY - Static variable in class org.sonar.api.measures.CoreMetrics
 
mandatoryMultiParam(String) - Method in class org.sonar.api.server.ws.Request
 
mandatoryParam(String) - Method in class org.sonar.api.server.ws.Request
Returns a non-null value.
mandatoryParamAsBoolean(String) - Method in class org.sonar.api.server.ws.Request
Returns a boolean value.
mandatoryParamAsEnum(String, Class<E>) - Method in class org.sonar.api.server.ws.Request
 
mandatoryParamAsInt(String) - Method in class org.sonar.api.server.ws.Request
Returns an int value.
mandatoryParamAsLong(String) - Method in class org.sonar.api.server.ws.Request
Returns a long value.
mandatoryParamAsPart(String) - Method in class org.sonar.api.server.ws.Request
 
mandatoryParamAsStrings(String) - Method in class org.sonar.api.server.ws.Request
 
ManifestUtils - Class in org.sonar.api.utils
 
markdownDescription() - Method in class org.sonar.api.server.rule.internal.DefaultRule
 
markdownDescription() - Method in class org.sonar.api.server.rule.RulesDefinition.Rule
 
markdownText() - Method in interface org.sonar.api.issue.IssueComment
Deprecated.
 
markForPublishing(InputFile) - Method in interface org.sonar.api.batch.sensor.SensorContext
Indicate that a file should be published in the report sent to SonarQube.
match(String) - Method in class org.sonar.api.utils.WildcardPattern
Returns true if specified value matches this pattern.
match(WildcardPattern[], String) - Static method in class org.sonar.api.utils.WildcardPattern
Returns true if specified value matches one of specified patterns.
matches(String) - Method in class org.sonar.api.web.ServletFilter.UrlPattern
 
matchesPathPattern(String) - Method in interface org.sonar.api.batch.fs.FilePredicates
Predicate that gets the files which "path" matches a wildcard pattern.
matchesPathPatterns(String[]) - Method in interface org.sonar.api.batch.fs.FilePredicates
Predicate that gets the files matching at least one wildcard pattern.
MAX_DECIMAL_SCALE - Static variable in class org.sonar.api.measures.Metric
The maximum supported value of scale for decimal metrics
maximumLength() - Method in class org.sonar.api.server.ws.WebService.Param
Specify the maximum length of the value used in this parameter
maximumValue() - Method in class org.sonar.api.server.ws.WebService.Param
Specify the maximum value of the numeric variable used in this parameter
maxValuesAllowed() - Method in class org.sonar.api.server.ws.WebService.Param
Specify the maximum number of values allowed when using Request.multiParam(String)
Measure<G extends java.io.Serializable> - Interface in org.sonar.api.batch.sensor.measure
Measure on File, Directory or Project.
Measure - Interface in org.sonar.api.ce.measure
Measure used in MeasureComputer
MeasureComputer - Interface in org.sonar.api.ce.measure
Define how to compute new measures on some metrics declared by Metrics.
MeasureComputer.MeasureComputerContext - Interface in org.sonar.api.ce.measure
Context specific to the computation of the measure(s) of a given component
MeasureComputer.MeasureComputerDefinition - Interface in org.sonar.api.ce.measure
 
MeasureComputer.MeasureComputerDefinition.Builder - Interface in org.sonar.api.ce.measure
 
MeasureComputer.MeasureComputerDefinitionContext - Interface in org.sonar.api.ce.measure
Context specific to the definition of the measure computer
MeasureComputerDefinitionBuilderImpl() - Constructor for class org.sonar.api.ce.measure.test.TestMeasureComputerDefinition.MeasureComputerDefinitionBuilderImpl
 
MEMORY_EFFICIENCY - Static variable in class org.sonar.api.server.rule.RulesDefinition.SubCharacteristics
Deprecated.
Related to characteristic EFFICIENCY
merge(Metric) - Method in class org.sonar.api.measures.Metric
Merge with fields from other metric.
message() - Method in interface org.sonar.api.batch.postjob.issue.PostJobIssue
Message of the issue.
message() - Method in interface org.sonar.api.batch.sensor.error.AnalysisError
A description of the error.
message() - Method in interface org.sonar.api.batch.sensor.issue.IssueLocation
Message of the issue.
message() - Method in interface org.sonar.api.issue.Issue
 
message() - Method in interface org.sonar.api.scan.issue.filter.FilterableIssue
Deprecated.
 
message() - Method in interface org.sonar.api.test.TestCase
Deprecated.
 
message(String) - Method in interface org.sonar.api.batch.sensor.error.NewAnalysisError
Message about the error.
message(String) - Method in interface org.sonar.api.batch.sensor.issue.NewIssueLocation
Optional, but recommended, plain-text message for this location.
message(Locale, String, String, Object...) - Method in interface org.sonar.api.i18n.I18n
Deprecated.
Searches the message of the key for the locale in the list of available bundles.
MESSAGE_MAX_SIZE - Static variable in interface org.sonar.api.batch.sensor.issue.NewIssueLocation
Maximum number of characters in the message.
MESSAGE_MAX_SIZE - Static variable in interface org.sonar.api.issue.Issue
Maximum number of characters in the message.
MessageException - Exception in org.sonar.api.utils
Runtime exception for "functional" error.
MessageException(String) - Constructor for exception org.sonar.api.utils.MessageException
 
method() - Method in class org.sonar.api.server.ws.Request
Returns the name of the HTTP method with which this request was made.
metric() - Method in interface org.sonar.api.batch.sensor.measure.Measure
The metric this measure belong to.
Metric<G extends java.io.Serializable> - Class in org.sonar.api.measures
Used to define a metric in a plugin.
Metric<G extends java.io.Serializable> - Interface in org.sonar.api.batch.measure
 
Metric() - Constructor for class org.sonar.api.measures.Metric
Deprecated.
in 1.12. Use the Metric.Builder factory.
Metric(String) - Constructor for class org.sonar.api.measures.Metric
Deprecated.
since 2.7 use the Metric.Builder factory.
Metric(String, String, String, Metric.ValueType, Integer, Boolean, String) - Constructor for class org.sonar.api.measures.Metric
Deprecated.
since 2.7 use the Metric.Builder factory.
Metric(String, Metric.ValueType) - Constructor for class org.sonar.api.measures.Metric
Deprecated.
since 2.7 use the Metric.Builder factory.
METRIC - org.sonar.api.PropertyType
Deprecated.
since 6.3, this type is useless as Dashboards have been removed
METRIC - org.sonar.api.web.WidgetPropertyType
Deprecated.
Sonar Metric
METRIC_LEVEL - org.sonar.api.PropertyType
Deprecated.
since 6.3, this type is useless as Dashboards have been removed
Metric.Builder - Class in org.sonar.api.measures
Metric.Builder is used to create metric definitions.
Metric.Level - Enum in org.sonar.api.measures
 
Metric.ValueType - Enum in org.sonar.api.measures
 
MetricFinder - Interface in org.sonar.api.batch.measure
 
MetricFinder - Interface in org.sonar.api.measures
Deprecated.
since 5.1 use MetricFinder on scanner side.
metrics() - Method in annotation type org.sonar.api.web.DefaultTab
Deprecated.
 
Metrics - Interface in org.sonar.api.measures
This is the extension point used by plugins to declare new metrics.
MILLISEC - org.sonar.api.measures.Metric.ValueType
 
minimumLength() - Method in class org.sonar.api.server.ws.WebService.Param
Specify the minimum length of the value used in this parameter
minor() - Method in class org.sonar.api.utils.Version
 
MINOR - org.sonar.api.batch.rule.Severity
 
MINOR - org.sonar.api.rules.RulePriority
Deprecated.
 
MINOR - Static variable in class org.sonar.api.rule.Severity
 
MINOR_VIOLATIONS - Static variable in class org.sonar.api.measures.CoreMetrics
 
MINOR_VIOLATIONS_KEY - Static variable in class org.sonar.api.measures.CoreMetrics
 
MINUTE - Static variable in class org.sonar.api.utils.Duration
 
MODULARITY - Static variable in class org.sonar.api.server.rule.RulesDefinition.SubCharacteristics
Deprecated.
Related to characteristic REUSABILITY
module() - Method in interface org.sonar.api.batch.sensor.SensorContext
Deprecated.
since 7.6 modules are deprecated. Use SensorContext.project() instead.
module() - Method in annotation type org.sonar.api.Property
Is the property displayed in module settings page ? A module is a maven sub-project.
MODULE - org.sonar.api.ce.measure.Component.Type
 
MODULE - org.sonar.api.web.page.Page.Qualifier
 
MODULE - Static variable in class org.sonar.api.resources.Qualifiers
Deprecated.
since 7.7 as modules doesn't exist anymore
MODULE_LEVEL_ARCHIVED_SETTINGS - Static variable in interface org.sonar.api.CoreProperties
 
MSG_PARAMETER_MISSING - Static variable in class org.sonar.api.server.ws.Request
 
multiParam(String) - Method in class org.sonar.api.server.ws.Request
 
multiple() - Method in class org.sonar.api.server.rule.RuleParamType
 
MULTIPLE_ANALYSES - Static variable in annotation type org.sonarsource.api.sonarlint.SonarLintSide
The component will be instantiated once and reused by all analyses, as long as the SonarLint engine is not restarted.
multipleListOfValues(String...) - Static method in class org.sonar.api.server.rule.RuleParamType
 
multiply(int) - Method in class org.sonar.api.utils.Duration
Multiply the duration with the given factor.
multiValues() - Method in class org.sonar.api.config.PropertyDefinition
 
multiValues() - Method in annotation type org.sonar.api.Property
Can the property take multiple values.
multiValues(boolean) - Method in class org.sonar.api.config.PropertyDefinition.Builder
 
mustBeRoot() - Method in class org.sonar.api.user.UserQuery.Builder
 
mustBeRoot() - Method in class org.sonar.api.user.UserQuery
 
mustNotBeRoot() - Method in class org.sonar.api.user.UserQuery.Builder
 
MutableTestable - Interface in org.sonar.api.test
Deprecated.
since 5.6. Feature will be removed without any alternatives.
MutableTestCase - Interface in org.sonar.api.test
Deprecated.
since 5.6. Feature will be removed without any alternatives.
MutableTestPlan - Interface in org.sonar.api.test
Deprecated.
since 5.6. Feature will be removed without any alternatives.

N

name() - Method in annotation type org.sonar.api.batch.Phase
 
name() - Method in interface org.sonar.api.batch.rule.Rule
 
name() - Method in interface org.sonar.api.batch.sensor.rule.AdHocRule
Name of the rule.
name() - Method in class org.sonar.api.config.PropertyDefinition
 
name() - Method in class org.sonar.api.config.PropertyFieldDefinition
 
name() - Method in annotation type org.sonar.api.Property
 
name() - Method in annotation type org.sonar.api.PropertyField
This name will be displayed on the Settings page.
name() - Method in interface org.sonar.api.server.profile.BuiltInQualityProfilesDefinition.BuiltInQualityProfile
 
name() - Method in class org.sonar.api.server.profile.BuiltInQualityProfilesDefinition.BuiltInQualityProfileImpl
 
name() - Method in interface org.sonar.api.server.profile.BuiltInQualityProfilesDefinition.NewBuiltInQualityProfile
 
name() - Method in class org.sonar.api.server.profile.BuiltInQualityProfilesDefinition.NewBuiltInQualityProfileImpl
 
name() - Method in class org.sonar.api.server.rule.internal.DefaultNewParam
 
name() - Method in class org.sonar.api.server.rule.internal.DefaultNewRepository
 
name() - Method in class org.sonar.api.server.rule.internal.DefaultParam
 
name() - Method in class org.sonar.api.server.rule.internal.DefaultRepository
 
name() - Method in class org.sonar.api.server.rule.internal.DefaultRule
 
name() - Method in interface org.sonar.api.server.rule.RulesDefinition.Param
 
name() - Method in interface org.sonar.api.server.rule.RulesDefinition.Repository
 
name() - Method in class org.sonar.api.server.rule.RulesDefinition.Rule
 
name() - Method in interface org.sonar.api.test.TestCase
Deprecated.
 
name() - Method in interface org.sonar.api.user.User
 
name(String) - Method in interface org.sonar.api.batch.postjob.PostJobDescriptor
Displayable name of the PostJob.
name(String) - Method in interface org.sonar.api.batch.sensor.rule.NewAdHocRule
The name of the rule.
name(String) - Method in interface org.sonar.api.batch.sensor.SensorDescriptor
Displayable name of the Sensor.
name(String) - Method in class org.sonar.api.config.PropertyDefinition.Builder
 
name(String) - Method in class org.sonar.api.config.PropertyFieldDefinition.Builder
 
name(String) - Method in class org.sonar.api.utils.text.JsonWriter
Encodes the property name.
names() - Static method in enum org.sonar.api.measures.Metric.Level
 
names() - Static method in enum org.sonar.api.measures.Metric.ValueType
 
names() - Static method in enum org.sonar.api.rules.RuleType
 
NavigationSection - Annotation Type in org.sonar.api.web
Deprecated.
since 6.3 see PageDefinition. This class is ignored.
NCLOC - Static variable in class org.sonar.api.measures.CoreMetrics
 
NCLOC_DATA - Static variable in class org.sonar.api.measures.CoreMetrics
Information about lines of code in file.
NCLOC_DATA_KEY - Static variable in class org.sonar.api.measures.CoreMetrics
 
NCLOC_KEY - Static variable in class org.sonar.api.measures.CoreMetrics
 
NCLOC_LANGUAGE_DISTRIBUTION - Static variable in class org.sonar.api.measures.CoreMetrics
 
NCLOC_LANGUAGE_DISTRIBUTION_KEY - Static variable in class org.sonar.api.measures.CoreMetrics
 
NETWORK_USE - Static variable in class org.sonar.api.server.rule.RulesDefinition.SubCharacteristics
Deprecated.
Related to characteristic EFFICIENCY
NEW_BLOCKER_VIOLATIONS - Static variable in class org.sonar.api.measures.CoreMetrics
 
NEW_BLOCKER_VIOLATIONS_KEY - Static variable in class org.sonar.api.measures.CoreMetrics
 
NEW_BLOCKS_DUPLICATED - Static variable in class org.sonar.api.measures.CoreMetrics
 
NEW_BLOCKS_DUPLICATED_KEY - Static variable in class org.sonar.api.measures.CoreMetrics
 
NEW_BRANCH_COVERAGE - Static variable in class org.sonar.api.measures.CoreMetrics
 
NEW_BRANCH_COVERAGE_KEY - Static variable in class org.sonar.api.measures.CoreMetrics
 
NEW_BUGS - Static variable in class org.sonar.api.measures.CoreMetrics
SonarQube Quality Model
NEW_BUGS_KEY - Static variable in class org.sonar.api.measures.CoreMetrics
SonarQube Quality Model
NEW_CODE_SMELLS - Static variable in class org.sonar.api.measures.CoreMetrics
SonarQube Quality Model
NEW_CODE_SMELLS_KEY - Static variable in class org.sonar.api.measures.CoreMetrics
SonarQube Quality Model
NEW_CONDITIONS_TO_COVER - Static variable in class org.sonar.api.measures.CoreMetrics
 
NEW_CONDITIONS_TO_COVER_KEY - Static variable in class org.sonar.api.measures.CoreMetrics
 
NEW_COVERAGE - Static variable in class org.sonar.api.measures.CoreMetrics
 
NEW_COVERAGE_KEY - Static variable in class org.sonar.api.measures.CoreMetrics
 
NEW_CRITICAL_VIOLATIONS - Static variable in class org.sonar.api.measures.CoreMetrics
 
NEW_CRITICAL_VIOLATIONS_KEY - Static variable in class org.sonar.api.measures.CoreMetrics
 
NEW_DEVELOPMENT_COST - Static variable in class org.sonar.api.measures.CoreMetrics
 
NEW_DEVELOPMENT_COST_KEY - Static variable in class org.sonar.api.measures.CoreMetrics
 
NEW_DUPLICATED_LINES - Static variable in class org.sonar.api.measures.CoreMetrics
 
NEW_DUPLICATED_LINES_DENSITY - Static variable in class org.sonar.api.measures.CoreMetrics
 
NEW_DUPLICATED_LINES_DENSITY_KEY - Static variable in class org.sonar.api.measures.CoreMetrics
 
NEW_DUPLICATED_LINES_KEY - Static variable in class org.sonar.api.measures.CoreMetrics
 
NEW_INFO_VIOLATIONS - Static variable in class org.sonar.api.measures.CoreMetrics
 
NEW_INFO_VIOLATIONS_KEY - Static variable in class org.sonar.api.measures.CoreMetrics
 
NEW_LINE_COVERAGE - Static variable in class org.sonar.api.measures.CoreMetrics
 
NEW_LINE_COVERAGE_KEY - Static variable in class org.sonar.api.measures.CoreMetrics
 
NEW_LINES - Static variable in class org.sonar.api.measures.CoreMetrics
 
NEW_LINES_KEY - Static variable in class org.sonar.api.measures.CoreMetrics
 
NEW_LINES_TO_COVER - Static variable in class org.sonar.api.measures.CoreMetrics
 
NEW_LINES_TO_COVER_KEY - Static variable in class org.sonar.api.measures.CoreMetrics
 
NEW_MAINTAINABILITY_RATING - Static variable in class org.sonar.api.measures.CoreMetrics
 
NEW_MAINTAINABILITY_RATING_KEY - Static variable in class org.sonar.api.measures.CoreMetrics
 
NEW_MAJOR_VIOLATIONS - Static variable in class org.sonar.api.measures.CoreMetrics
 
NEW_MAJOR_VIOLATIONS_KEY - Static variable in class org.sonar.api.measures.CoreMetrics
 
NEW_MINOR_VIOLATIONS - Static variable in class org.sonar.api.measures.CoreMetrics
 
NEW_MINOR_VIOLATIONS_KEY - Static variable in class org.sonar.api.measures.CoreMetrics
 
NEW_RELIABILITY_RATING - Static variable in class org.sonar.api.measures.CoreMetrics
 
NEW_RELIABILITY_RATING_KEY - Static variable in class org.sonar.api.measures.CoreMetrics
 
NEW_RELIABILITY_REMEDIATION_EFFORT - Static variable in class org.sonar.api.measures.CoreMetrics
 
NEW_RELIABILITY_REMEDIATION_EFFORT_KEY - Static variable in class org.sonar.api.measures.CoreMetrics
 
NEW_SECURITY_HOTSPOTS - Static variable in class org.sonar.api.measures.CoreMetrics
 
NEW_SECURITY_HOTSPOTS_KEY - Static variable in class org.sonar.api.measures.CoreMetrics
 
NEW_SECURITY_RATING - Static variable in class org.sonar.api.measures.CoreMetrics
 
NEW_SECURITY_RATING_KEY - Static variable in class org.sonar.api.measures.CoreMetrics
 
NEW_SECURITY_REMEDIATION_EFFORT - Static variable in class org.sonar.api.measures.CoreMetrics
 
NEW_SECURITY_REMEDIATION_EFFORT_KEY - Static variable in class org.sonar.api.measures.CoreMetrics
 
NEW_SQALE_DEBT_RATIO - Static variable in class org.sonar.api.measures.CoreMetrics
 
NEW_SQALE_DEBT_RATIO_KEY - Static variable in class org.sonar.api.measures.CoreMetrics
 
NEW_TECHNICAL_DEBT - Static variable in class org.sonar.api.measures.CoreMetrics
 
NEW_TECHNICAL_DEBT_KEY - Static variable in class org.sonar.api.measures.CoreMetrics
 
NEW_UNCOVERED_CONDITIONS - Static variable in class org.sonar.api.measures.CoreMetrics
 
NEW_UNCOVERED_CONDITIONS_KEY - Static variable in class org.sonar.api.measures.CoreMetrics
 
NEW_UNCOVERED_LINES - Static variable in class org.sonar.api.measures.CoreMetrics
 
NEW_UNCOVERED_LINES_KEY - Static variable in class org.sonar.api.measures.CoreMetrics
 
NEW_VIOLATIONS - Static variable in class org.sonar.api.measures.CoreMetrics
 
NEW_VIOLATIONS_KEY - Static variable in class org.sonar.api.measures.CoreMetrics
 
NEW_VULNERABILITIES - Static variable in class org.sonar.api.measures.CoreMetrics
SonarQube Quality Model
NEW_VULNERABILITIES_KEY - Static variable in class org.sonar.api.measures.CoreMetrics
SonarQube Quality Model
newAdHocRule() - Method in interface org.sonar.api.batch.sensor.SensorContext
Fluent builder to create a new AdHocRule.
NewAdHocRule - Interface in org.sonar.api.batch.sensor.rule
Builder for a rule imported from an external rule engine by a Sensor.
newAnalysisError() - Method in interface org.sonar.api.batch.sensor.SensorContext
Builder to declare errors that happened while processing a source file.
NewAnalysisError - Interface in org.sonar.api.batch.sensor.error
Represents an analysis error, such as a parsing error, that occurs during the execution of a Sensor.
newBranchBuilder() - Static method in class org.sonar.api.ce.posttask.PostProjectAnalysisTaskTester
 
newCeTaskBuilder() - Static method in class org.sonar.api.ce.posttask.PostProjectAnalysisTaskTester
 
newConditionBuilder() - Static method in class org.sonar.api.ce.posttask.PostProjectAnalysisTaskTester
 
newCoverage() - Method in interface org.sonar.api.batch.sensor.SensorContext
Builder to define coverage in a file.
NewCoverage - Interface in org.sonar.api.batch.sensor.coverage
This class is used to report code coverage on files.
newCpdTokens() - Method in interface org.sonar.api.batch.sensor.SensorContext
Builder to define CPD tokens in a file.
NewCpdTokens - Interface in org.sonar.api.batch.sensor.cpd
This builder is used to define tokens used by CPD algorithm on files.
newDateConverter() - Static method in class org.sonar.api.utils.KeyValueFormat
 
newDateConverter(String) - Static method in class org.sonar.api.utils.KeyValueFormat
 
newDateTimeConverter() - Static method in class org.sonar.api.utils.KeyValueFormat
 
newDefinitionBuilder() - Method in interface org.sonar.api.ce.measure.MeasureComputer.MeasureComputerDefinitionContext
 
newDefinitionBuilder() - Method in class org.sonar.api.ce.measure.test.TestMeasureComputerDefinitionContext
 
newDir() - Method in interface org.sonar.api.utils.TempFolder
Create a directory in temp folder with a random unique name.
newDir(String) - Method in interface org.sonar.api.utils.TempFolder
Create a directory in temp folder using provided name.
newDoubleConverter() - Static method in class org.sonar.api.utils.KeyValueFormat
 
newExternalIssue() - Method in interface org.sonar.api.batch.sensor.SensorContext
Fluent builder to create a new ExternalIssue.
NewExternalIssue - Interface in org.sonar.api.batch.sensor.issue
Builder for an issue imported from an external rule engine by a Sensor.
newFile() - Method in interface org.sonar.api.utils.TempFolder
 
newFile(String, String) - Method in interface org.sonar.api.utils.TempFolder
 
newHighlighting() - Method in interface org.sonar.api.batch.sensor.SensorContext
Builder to define highlighting of a file.
NewHighlighting - Interface in org.sonar.api.batch.sensor.highlighting
This builder is used to define syntax highlighting (aka code coloration) on files.
newInstance(String) - Method in class org.sonar.api.utils.log.Loggers
 
newIntegerConverter() - Static method in class org.sonar.api.utils.KeyValueFormat
 
newIssue() - Method in interface org.sonar.api.batch.sensor.SensorContext
Fluent builder to create a new Issue.
NewIssue - Interface in org.sonar.api.batch.sensor.issue
Represents an issue detected by a Sensor.
NewIssueLocation - Interface in org.sonar.api.batch.sensor.issue
Represents one issue location.
newJsonWriter() - Method in interface org.sonar.api.server.ws.Response
Non streamable JsonWriter.
newLocation() - Method in interface org.sonar.api.batch.sensor.issue.NewExternalIssue
Create a new location for this issue.
newLocation() - Method in interface org.sonar.api.batch.sensor.issue.NewIssue
Create a new location for this issue.
newMeasure() - Method in interface org.sonar.api.batch.sensor.SensorContext
Fluent builder to create a new Measure.
NewMeasure<G extends java.io.Serializable> - Interface in org.sonar.api.batch.sensor.measure
Builder to create new Measure.
newOrganizationBuilder() - Static method in class org.sonar.api.ce.posttask.PostProjectAnalysisTaskTester
 
NewParam() - Constructor for class org.sonar.api.server.rule.RulesDefinition.NewParam
 
newPointer(int, int) - Method in interface org.sonar.api.batch.fs.InputFile
Returns a TextPointer in the given file.
newPriorityConverter() - Static method in class org.sonar.api.utils.KeyValueFormat
 
newProjectBuilder() - Static method in class org.sonar.api.ce.posttask.PostProjectAnalysisTaskTester
 
newQualityGateBuilder() - Static method in class org.sonar.api.ce.posttask.PostProjectAnalysisTaskTester
 
newRange(int, int, int, int) - Method in interface org.sonar.api.batch.fs.InputFile
Returns a TextRange in the given file.
newRange(TextPointer, TextPointer) - Method in interface org.sonar.api.batch.fs.InputFile
Returns a TextRange in the given file.
newReference(int, int) - Method in interface org.sonar.api.batch.sensor.symbol.NewSymbol
Deprecated.
since 6.1 Only supported to ease migration from old API. Please prefer other newReference() methods.
newReference(int, int, int, int) - Method in interface org.sonar.api.batch.sensor.symbol.NewSymbol
Shortcut to avoid calling InputFile.newRange(int, int, int, int)
newReference(TextRange) - Method in interface org.sonar.api.batch.sensor.symbol.NewSymbol
Register a new symbol.
NewRule() - Constructor for class org.sonar.api.server.rule.RulesDefinition.NewRule
 
newRules() - Method in class org.sonar.api.server.rule.internal.DefaultNewRepository
 
newScannerContextBuilder() - Static method in class org.sonar.api.ce.posttask.PostProjectAnalysisTaskTester
 
newSignificantCode() - Method in interface org.sonar.api.batch.sensor.SensorContext
Builder to declare which parts of the code is significant code.
NewSignificantCode - Interface in org.sonar.api.batch.sensor.code
This object is used to report ranges of a file which contain significant code.
newStringConverter() - Static method in class org.sonar.api.utils.KeyValueFormat
 
newSymbol(int, int) - Method in interface org.sonar.api.batch.sensor.symbol.NewSymbolTable
Deprecated.
since 5.6 Only supported to ease migration from old API. Please prefer NewSymbolTable.newSymbol(int, int, int, int).
newSymbol(int, int, int, int) - Method in interface org.sonar.api.batch.sensor.symbol.NewSymbolTable
Shortcut to avoid calling InputFile.newRange(int, int, int, int)
newSymbol(TextRange) - Method in interface org.sonar.api.batch.sensor.symbol.NewSymbolTable
Register a new symbol declaration.
NewSymbol - Interface in org.sonar.api.batch.sensor.symbol
This builder is used to define symbol references on files.
newSymbolTable() - Method in interface org.sonar.api.batch.sensor.SensorContext
Builder to define symbol table of a file.
NewSymbolTable - Interface in org.sonar.api.batch.sensor.symbol
This builder is used to define symbol references on files.
newToStringConverter() - Static method in class org.sonar.api.utils.KeyValueFormat
 
NewUserHandler - Interface in org.sonar.api.platform
 
NewUserHandler.Context - Class in org.sonar.api.platform
 
NewUserHandler.Context.Builder - Class in org.sonar.api.platform
 
newXmlWriter() - Method in interface org.sonar.api.server.ws.Response
 
NO_VALUE - org.sonar.api.ce.posttask.QualityGate.EvaluationStatus
No measure found or measure had no value.
noContent() - Method in interface org.sonar.api.server.ws.Response
 
Node - Class in org.sonar.api.utils.dag
 
Node(Object) - Constructor for class org.sonar.api.utils.dag.Node
 
none() - Method in interface org.sonar.api.batch.fs.FilePredicates
Predicate that always evaluates to false
NONE - org.sonar.api.web.WidgetLayoutType
Deprecated.
 
NoSonarFilter - Class in org.sonar.api.issue
Issue filter used to ignore issues created on lines commented with the tag "NOSONAR".
NoSonarFilter() - Constructor for class org.sonar.api.issue.NoSonarFilter
 
noSonarInFile(InputFile, Set<Integer>) - Method in class org.sonar.api.issue.NoSonarFilter
Register lines in a file that contains the NOSONAR flag.
not(FilePredicate) - Method in interface org.sonar.api.batch.fs.FilePredicates
 
NOT_EQUALS - org.sonar.api.ce.posttask.QualityGate.Operator
Deprecated.
in 7.6. Using this operator will have no effect.
Notification - Class in org.sonar.api.notifications
Deprecated.
in 7.8. See NotificationChannel.
Notification(String) - Constructor for class org.sonar.api.notifications.Notification
Deprecated.
Create a new Notification of the given type.
NotificationChannel - Class in org.sonar.api.notifications
Deprecated.
in 7.8. This API is not usable, incomplete and suffers from significant performance hotspots.
NotificationChannel() - Constructor for class org.sonar.api.notifications.NotificationChannel
Deprecated.
 
now() - Method in class org.sonar.api.utils.System2
Shortcut for System.currentTimeMillis() Since 6.4 you can also inject Clock instead of System2

O

OAuth2IdentityProvider - Interface in org.sonar.api.server.authentication
 
OAuth2IdentityProvider.CallbackContext - Interface in org.sonar.api.server.authentication
 
OAuth2IdentityProvider.InitContext - Interface in org.sonar.api.server.authentication
 
OAuth2IdentityProvider.OAuth2Context - Interface in org.sonar.api.server.authentication
 
of(Writer) - Static method in class org.sonar.api.utils.text.CsvWriter
 
of(Writer) - Static method in class org.sonar.api.utils.text.JsonWriter
 
of(Writer) - Static method in class org.sonar.api.utils.text.XmlWriter
 
of(String) - Static method in enum org.sonar.api.test.TestCase.Status
Deprecated.
 
of(String) - Static method in exception org.sonar.api.utils.MessageException
 
of(String, String) - Static method in class org.sonar.api.rule.RuleKey
Create a key.
of(String, Throwable) - Static method in exception org.sonar.api.utils.MessageException
 
of(PostProjectAnalysisTask) - Static method in class org.sonar.api.ce.posttask.PostProjectAnalysisTaskTester
 
of(RuleKey) - Method in class org.sonar.api.batch.rule.Checks
 
offset() - Method in interface org.sonar.api.server.debt.DebtRemediationFunction
Deprecated.
offset() - Method in class org.sonar.api.server.debt.internal.DefaultDebtRemediationFunction
Deprecated.
offset() - Method in class org.sonar.api.utils.Paging
 
offset(int, int) - Static method in class org.sonar.api.utils.Paging
 
ofL10n(String, Object...) - Static method in exception org.sonar.api.utils.MessageException
 
ofType(CoverageType) - Method in interface org.sonar.api.batch.sensor.coverage.NewCoverage
Deprecated.
since 6.2 SonarQube merge all coverage reports and don't keep track of different test category
OK - org.sonar.api.ce.posttask.QualityGate.EvaluationStatus
Condition evaluated as OK, error thresholds has not been reached.
OK - org.sonar.api.ce.posttask.QualityGate.Status
at least one threshold is defined, no threshold is reached
OK - org.sonar.api.measures.Metric.Level
 
OK - org.sonar.api.test.TestCase.Status
Deprecated.
 
on(InputComponent) - Method in interface org.sonar.api.batch.sensor.issue.NewIssueLocation
The InputComponent the issue location belongs to.
on(InputComponent) - Method in interface org.sonar.api.batch.sensor.measure.NewMeasure
The InputComponent the measure belongs to.
onChange(GlobalPropertyChangeHandler.PropertyChange) - Method in class org.sonar.api.config.GlobalPropertyChangeHandler
This method gets called when a property is changed.
ONE_COLUMN - org.sonar.api.web.DashboardLayout
Deprecated.
Only 1 column that take all the page
onFile(InputFile) - Method in interface org.sonar.api.batch.sensor.code.NewSignificantCode
The file for which significant code is being reported.
onFile(InputFile) - Method in interface org.sonar.api.batch.sensor.coverage.NewCoverage
The covered file.
onFile(InputFile) - Method in interface org.sonar.api.batch.sensor.cpd.NewCpdTokens
The tokenized file.
onFile(InputFile) - Method in interface org.sonar.api.batch.sensor.error.NewAnalysisError
The file that was being processed when the error occurred.
onFile(InputFile) - Method in interface org.sonar.api.batch.sensor.highlighting.NewHighlighting
The file the highlighting belongs to.
onFile(InputFile) - Method in interface org.sonar.api.batch.sensor.symbol.NewSymbolTable
The file the symbol table belongs to.
onlyOnFileType(InputFile.Type) - Method in interface org.sonar.api.batch.sensor.SensorDescriptor
InputFile.Type this Sensor work on.
onlyOnLanguage(String) - Method in interface org.sonar.api.batch.sensor.SensorDescriptor
Language this Sensor work on.
onlyOnLanguages(String...) - Method in interface org.sonar.api.batch.sensor.SensorDescriptor
List languages this Sensor work on.
onlyOnQualifiers(String, String...) - Method in class org.sonar.api.config.PropertyDefinition.Builder
The property will be available in the components with the given qualifiers, but NOT in General Settings.
onlyOnQualifiers(List<String>) - Method in class org.sonar.api.config.PropertyDefinition.Builder
The property will be available in the components with the given qualifiers, but NOT in General Settings.
onlyWhenConfiguration(Predicate<Configuration>) - Method in interface org.sonar.api.batch.sensor.SensorDescriptor
Predicate that will be evaluated on current project Configuration by the platform to decide if execution of the Sensor should be skipped.
onQualifiers(String, String...) - Method in class org.sonar.api.config.PropertyDefinition.Builder
The property will be available in General Settings AND in the components with the given qualifiers.
onQualifiers(List<String>) - Method in class org.sonar.api.config.PropertyDefinition.Builder
The property will be available in General Settings AND in the components with the given qualifiers.
onServerStart(Server) - Method in interface org.sonar.api.platform.ServerStartHandler
 
onServerStop(Server) - Method in interface org.sonar.api.platform.ServerStopHandler
 
OPEN_AS_VULNERABILITY - Static variable in interface org.sonar.api.issue.DefaultTransitions
 
OPEN_ISSUES - Static variable in class org.sonar.api.measures.CoreMetrics
 
OPEN_ISSUES_KEY - Static variable in class org.sonar.api.measures.CoreMetrics
 
openStream(URI) - Method in class org.sonar.api.utils.HttpDownloader
 
optional() - Method in annotation type org.sonar.api.web.WidgetProperty
Deprecated.
 
options() - Method in class org.sonar.api.config.PropertyDefinition
Options for *_LIST types
Options for property of type PropertyType.SINGLE_SELECT_LIST.
For example {"property_1", "property_3", "property_3"}).
options() - Method in class org.sonar.api.config.PropertyFieldDefinition
 
options() - Method in annotation type org.sonar.api.Property
Options for *_LIST types
options() - Method in annotation type org.sonar.api.PropertyField
Options for *_LIST types
options() - Method in annotation type org.sonar.api.web.WidgetProperty
Deprecated.
 
options(String...) - Method in class org.sonar.api.config.PropertyFieldDefinition.Builder
 
options(String, String...) - Method in class org.sonar.api.config.PropertyDefinition.Builder
 
options(List<String>) - Method in class org.sonar.api.config.PropertyDefinition.Builder
 
options(List<String>) - Method in class org.sonar.api.config.PropertyFieldDefinition.Builder
 
or(Collection<FilePredicate>) - Method in interface org.sonar.api.batch.fs.FilePredicates
 
or(Supplier<T>) - Method in interface org.sonar.api.server.ws.Request.Param
 
or(FilePredicate...) - Method in interface org.sonar.api.batch.fs.FilePredicates
 
or(FilePredicate, FilePredicate) - Method in interface org.sonar.api.batch.fs.FilePredicates
 
ORDERED_BOTTOM_UP - Static variable in class org.sonar.api.resources.Qualifiers
List of qualifiers, ordered from bottom to up regarding position in tree of components
org.sonar.api - package org.sonar.api
 
org.sonar.api.batch - package org.sonar.api.batch
 
org.sonar.api.batch.bootstrap - package org.sonar.api.batch.bootstrap
 
org.sonar.api.batch.bootstrap.internal - package org.sonar.api.batch.bootstrap.internal
 
org.sonar.api.batch.fs - package org.sonar.api.batch.fs
 
org.sonar.api.batch.measure - package org.sonar.api.batch.measure
 
org.sonar.api.batch.postjob - package org.sonar.api.batch.postjob
 
org.sonar.api.batch.postjob.issue - package org.sonar.api.batch.postjob.issue
 
org.sonar.api.batch.rule - package org.sonar.api.batch.rule
 
org.sonar.api.batch.scm - package org.sonar.api.batch.scm
 
org.sonar.api.batch.sensor - package org.sonar.api.batch.sensor
 
org.sonar.api.batch.sensor.code - package org.sonar.api.batch.sensor.code
 
org.sonar.api.batch.sensor.coverage - package org.sonar.api.batch.sensor.coverage
 
org.sonar.api.batch.sensor.cpd - package org.sonar.api.batch.sensor.cpd
 
org.sonar.api.batch.sensor.cpd.internal - package org.sonar.api.batch.sensor.cpd.internal
 
org.sonar.api.batch.sensor.error - package org.sonar.api.batch.sensor.error
 
org.sonar.api.batch.sensor.highlighting - package org.sonar.api.batch.sensor.highlighting
 
org.sonar.api.batch.sensor.internal - package org.sonar.api.batch.sensor.internal
 
org.sonar.api.batch.sensor.issue - package org.sonar.api.batch.sensor.issue
 
org.sonar.api.batch.sensor.measure - package org.sonar.api.batch.sensor.measure
 
org.sonar.api.batch.sensor.rule - package org.sonar.api.batch.sensor.rule
 
org.sonar.api.batch.sensor.symbol - package org.sonar.api.batch.sensor.symbol
 
org.sonar.api.ce - package org.sonar.api.ce
 
org.sonar.api.ce.measure - package org.sonar.api.ce.measure
 
org.sonar.api.ce.measure.test - package org.sonar.api.ce.measure.test
 
org.sonar.api.ce.posttask - package org.sonar.api.ce.posttask
 
org.sonar.api.component - package org.sonar.api.component
 
org.sonar.api.config - package org.sonar.api.config
 
org.sonar.api.database - package org.sonar.api.database
 
org.sonar.api.database.model - package org.sonar.api.database.model
 
org.sonar.api.i18n - package org.sonar.api.i18n
 
org.sonar.api.issue - package org.sonar.api.issue
 
org.sonar.api.measures - package org.sonar.api.measures
 
org.sonar.api.notifications - package org.sonar.api.notifications
 
org.sonar.api.platform - package org.sonar.api.platform
 
org.sonar.api.profiles - package org.sonar.api.profiles
 
org.sonar.api.resources - package org.sonar.api.resources
 
org.sonar.api.rule - package org.sonar.api.rule
 
org.sonar.api.rules - package org.sonar.api.rules
 
org.sonar.api.scan.filesystem - package org.sonar.api.scan.filesystem
org.sonar.api.scan.issue.filter - package org.sonar.api.scan.issue.filter
 
org.sonar.api.scanner - package org.sonar.api.scanner
 
org.sonar.api.scanner.fs - package org.sonar.api.scanner.fs
 
org.sonar.api.scanner.sensor - package org.sonar.api.scanner.sensor
 
org.sonar.api.security - package org.sonar.api.security
 
org.sonar.api.server - package org.sonar.api.server
 
org.sonar.api.server.authentication - package org.sonar.api.server.authentication
 
org.sonar.api.server.debt - package org.sonar.api.server.debt
 
org.sonar.api.server.debt.internal - package org.sonar.api.server.debt.internal
 
org.sonar.api.server.profile - package org.sonar.api.server.profile
 
org.sonar.api.server.rule - package org.sonar.api.server.rule
 
org.sonar.api.server.rule.internal - package org.sonar.api.server.rule.internal
 
org.sonar.api.server.ws - package org.sonar.api.server.ws
 
org.sonar.api.task - package org.sonar.api.task
 
org.sonar.api.test - package org.sonar.api.test
 
org.sonar.api.test.exception - package org.sonar.api.test.exception
 
org.sonar.api.user - package org.sonar.api.user
 
org.sonar.api.utils - package org.sonar.api.utils
 
org.sonar.api.utils.command - package org.sonar.api.utils.command
 
org.sonar.api.utils.dag - package org.sonar.api.utils.dag
 
org.sonar.api.utils.log - package org.sonar.api.utils.log
 
org.sonar.api.utils.text - package org.sonar.api.utils.text
 
org.sonar.api.web - package org.sonar.api.web
 
org.sonar.api.web.page - package org.sonar.api.web.page
 
org.sonarsource.api.sonarlint - package org.sonarsource.api.sonarlint
 
ORGANISATION - Static variable in interface org.sonar.api.CoreProperties
Deprecated.
Organization - Interface in org.sonar.api.ce.posttask
 
ORGANIZATION - org.sonar.api.web.page.Page.Scope
 
originalKey() - Method in class org.sonar.api.config.Category
 
OS_RELATED_PORTABILITY - Static variable in class org.sonar.api.server.rule.RulesDefinition.SubCharacteristics
Deprecated.
Related to characteristic PORTABILITY
output() - Method in interface org.sonar.api.server.ws.Response.Stream
Response stream.
OVERALL - org.sonar.api.batch.sensor.coverage.CoverageType
Deprecated.
 
overlap(TextRange) - Method in interface org.sonar.api.batch.fs.TextRange
Test if the current range has some common area with another range.
overriddenParam(String) - Method in class org.sonar.api.server.profile.BuiltInQualityProfilesDefinition.BuiltInActiveRule
 
overriddenParams() - Method in class org.sonar.api.server.profile.BuiltInQualityProfilesDefinition.BuiltInActiveRule
 
overriddenSeverity() - Method in interface org.sonar.api.batch.sensor.issue.Issue
Overridden severity.
overriddenSeverity() - Method in class org.sonar.api.server.profile.BuiltInQualityProfilesDefinition.BuiltInActiveRule
 
overriddenValue() - Method in class org.sonar.api.server.profile.BuiltInQualityProfilesDefinition.OverriddenParam
 
overrideParam(String, String) - Method in class org.sonar.api.server.profile.BuiltInQualityProfilesDefinition.NewBuiltInActiveRule
Create a parameter with given unique key.
OVERRIDES - Static variable in class org.sonar.api.rules.ActiveRule
 
overrideSeverity(String) - Method in class org.sonar.api.server.profile.BuiltInQualityProfilesDefinition.NewBuiltInActiveRule
Override default rule severity in this quality profile.
overrideSeverity(Severity) - Method in interface org.sonar.api.batch.sensor.issue.NewIssue
Override severity of the issue.

P

Page - Class in org.sonar.api.web.page
 
Page - Interface in org.sonar.api.web
Deprecated.
since 6.3 see PageDefinition. This class is ignored.
PAGE - Static variable in class org.sonar.api.server.ws.WebService.Param
 
PAGE_SIZE - Static variable in class org.sonar.api.server.ws.WebService.Param
 
Page.Builder - Class in org.sonar.api.web.page
 
Page.Qualifier - Enum in org.sonar.api.web.page
 
Page.Scope - Enum in org.sonar.api.web.page
 
PageDecoration - Class in org.sonar.api.web
Deprecated.
since 6.3 see PageDefinition. This class is ignored.
PageDecoration() - Constructor for class org.sonar.api.web.PageDecoration
Deprecated.
 
PageDefinition - Interface in org.sonar.api.web.page
Defines the Javascript pages added to SonarQube.
pageIndex() - Method in class org.sonar.api.utils.Paging
Page index, starting with 1.
pages() - Method in class org.sonar.api.utils.Paging
Number of pages.
pageSize() - Method in class org.sonar.api.utils.Paging
Maximum number of items per page.
Paging - Class in org.sonar.api.utils
 
Paging.Builder - Class in org.sonar.api.utils
 
PAIR_SEPARATOR - Static variable in class org.sonar.api.utils.KeyValueFormat
 
param(String) - Method in interface org.sonar.api.batch.rule.ActiveRule
Value of given parameter.
param(String) - Method in interface org.sonar.api.batch.rule.Rule
 
param(String) - Method in class org.sonar.api.server.rule.internal.DefaultRule
 
param(String) - Method in class org.sonar.api.server.rule.RulesDefinition.NewRule
 
param(String) - Method in class org.sonar.api.server.rule.RulesDefinition.Rule
 
param(String) - Method in class org.sonar.api.server.ws.Request
 
param(String) - Method in class org.sonar.api.server.ws.WebService.Action
 
param(String, String) - Method in class org.sonar.api.server.ws.Request
Deprecated.
to be dropped in 4.4. Default values are declared in ws metadata
Param(WebService.Action, WebService.NewParam) - Constructor for class org.sonar.api.server.ws.WebService.Param
 
paramAsBoolean(String) - Method in class org.sonar.api.server.ws.Request
 
paramAsBoolean(String, boolean) - Method in class org.sonar.api.server.ws.Request
Deprecated.
to be dropped in 4.4. Default values must be declared in WebService then this method can be replaced by Request.mandatoryParamAsBoolean(String).
paramAsDate(String) - Method in class org.sonar.api.server.ws.Request
 
paramAsDateTime(String) - Method in class org.sonar.api.server.ws.Request
 
paramAsEnum(String, Class<E>) - Method in class org.sonar.api.server.ws.Request
 
paramAsEnums(String, Class<E>) - Method in class org.sonar.api.server.ws.Request
 
paramAsInputStream(String) - Method in class org.sonar.api.server.ws.Request
 
paramAsInt(String) - Method in class org.sonar.api.server.ws.Request
 
paramAsInt(String, int) - Method in class org.sonar.api.server.ws.Request
Deprecated.
to be dropped in 4.4. Default values must be declared in WebService then this method can be replaced by Request.mandatoryParamAsInt(String).
paramAsLong(String) - Method in class org.sonar.api.server.ws.Request
 
paramAsLong(String, long) - Method in class org.sonar.api.server.ws.Request
Deprecated.
to be dropped in 4.4. Default values must be declared in WebService then this method can be replaced by Request.mandatoryParamAsLong(String).
paramAsPart(String) - Method in class org.sonar.api.server.ws.Request
 
paramAsStrings(String) - Method in class org.sonar.api.server.ws.Request
 
params() - Method in interface org.sonar.api.batch.rule.ActiveRule
Immutable parameter values.
params() - Method in interface org.sonar.api.batch.rule.Rule
 
params() - Method in class org.sonar.api.server.rule.internal.DefaultRule
 
params() - Method in class org.sonar.api.server.rule.RulesDefinition.NewRule
 
params() - Method in class org.sonar.api.server.rule.RulesDefinition.Rule
 
params() - Method in class org.sonar.api.server.ws.WebService.Action
 
parse(File) - Method in class org.sonar.api.rules.XMLRuleParser
Deprecated.
 
parse(InputStream) - Method in class org.sonar.api.rules.XMLRuleParser
Deprecated.
Warning : the input stream is closed in this method
parse(Reader) - Method in class org.sonar.api.rules.XMLRuleParser
Deprecated.
 
parse(Reader, ValidationMessages) - Method in class org.sonar.api.profiles.XMLProfileParser
Deprecated.
 
parse(String) - Static method in class org.sonar.api.rule.RuleKey
Create a key from a string representation (see RuleKey.toString().
parse(String) - Static method in class org.sonar.api.server.rule.RuleParamType
 
parse(String) - Static method in class org.sonar.api.utils.KeyValueFormat
 
parse(String) - Static method in class org.sonar.api.utils.Version
Convert a String to a Version.
parse(String, String, String, Collection<Class>, ValidationMessages) - Method in class org.sonar.api.profiles.AnnotationProfileParser
Deprecated.
 
parse(String, Collection<Class>) - Method in class org.sonar.api.rules.AnnotationRuleParser
Deprecated.
 
parse(String, KeyValueFormat.Converter<K>, KeyValueFormat.Converter<V>) - Static method in class org.sonar.api.utils.KeyValueFormat
If input is null, then an empty map is returned.
parseDate(String) - Static method in class org.sonar.api.utils.DateUtils
Return a date at the start of day.
parseDateOrDateTime(String) - Static method in class org.sonar.api.utils.DateUtils
Warning: may rely on default timezone!
parseDateQuietly(String) - Static method in class org.sonar.api.utils.DateUtils
Parse format DateUtils.DATE_FORMAT.
parseDateTime(String) - Static method in class org.sonar.api.utils.DateUtils
 
parseDateTimeQuietly(String) - Static method in class org.sonar.api.utils.DateUtils
parseEndingDateOrDateTime(String) - Static method in class org.sonar.api.utils.DateUtils
Return the datetime if @param stringDate is a datetime, date + 1 day if stringDate is a date.
parseIntDate(String) - Static method in class org.sonar.api.utils.KeyValueFormat
 
parseIntDateTime(String) - Static method in class org.sonar.api.utils.KeyValueFormat
 
parseIntDouble(String) - Static method in class org.sonar.api.utils.KeyValueFormat
 
parseIntInt(String) - Static method in class org.sonar.api.utils.KeyValueFormat
 
parseIntString(String) - Static method in class org.sonar.api.utils.KeyValueFormat
 
parseLocalDate(String) - Static method in class org.sonar.api.utils.DateUtils
 
parseLocalDateQuietly(String) - Static method in class org.sonar.api.utils.DateUtils
Parse format DateUtils.DATE_FORMAT.
parseNumber(String) - Static method in class org.sonar.api.utils.ParsingUtils
Parses a string with the default locale and returns the corresponding number
parseNumber(String, Locale) - Static method in class org.sonar.api.utils.ParsingUtils
Parses a string with a locale and returns the corresponding number
parseOffsetDateTime(String) - Static method in class org.sonar.api.utils.DateUtils
 
parseOffsetDateTimeQuietly(String) - Static method in class org.sonar.api.utils.DateUtils
parseResource(ClassLoader, String, ValidationMessages) - Method in class org.sonar.api.profiles.XMLProfileParser
Deprecated.
 
parseStartingDateOrDateTime(String) - Static method in class org.sonar.api.utils.DateUtils
Warning: may rely on default timezone!
parseStringDouble(String) - Static method in class org.sonar.api.utils.KeyValueFormat
 
parseStringInt(String) - Static method in class org.sonar.api.utils.KeyValueFormat
 
ParsingUtils - Class in org.sonar.api.utils
Utility to parse various inputs
PASSWORD - org.sonar.api.PropertyType
Variation of {#STRING} with masked characters
PASSWORD - org.sonar.api.web.WidgetPropertyType
Deprecated.
Variation of {#STRING} with masked characters
PASSWORD - Static variable in interface org.sonar.api.CoreProperties
 
patch() - Method in class org.sonar.api.utils.Version
 
path() - Method in interface org.sonar.api.batch.fs.IndexedFile
path() - Method in interface org.sonar.api.batch.fs.InputDir
Deprecated.
The underlying absolute Path
path() - Method in interface org.sonar.api.batch.fs.InputFile
Deprecated.
since 6.6 use InputFile.inputStream() for file content, IndexedFile.filename() for file name, IndexedFile.uri() for an unique identifier, and InputFile.toString() for logging
path() - Method in interface org.sonar.api.batch.fs.InputPath
Deprecated.
since 6.5 use InputPath.uri()
path() - Method in class org.sonar.api.scan.filesystem.PathResolver.RelativePath
Deprecated.
 
path() - Method in class org.sonar.api.server.ws.WebService.Action
 
path() - Method in class org.sonar.api.server.ws.WebService.Controller
 
PathResolver - Class in org.sonar.api.scan.filesystem
 
PathResolver() - Constructor for class org.sonar.api.scan.filesystem.PathResolver
 
PathResolver.RelativePath - Class in org.sonar.api.scan.filesystem
Deprecated.
since 6.0 was used when component keys were relative to source dirs
PathUtils - Class in org.sonar.api.utils
 
PER_BATCH - Static variable in annotation type org.sonar.api.batch.InstantiationStrategy
Deprecated.
Shared extension.
PER_PROJECT - Static variable in annotation type org.sonar.api.batch.InstantiationStrategy
Deprecated.
Created and initialized for each project and sub-project (a project is a module in Maven terminology).
PER_TASK - Static variable in annotation type org.sonar.api.batch.InstantiationStrategy
Deprecated.
Shared task extension.
PERCENT - org.sonar.api.measures.Metric.ValueType
 
PERMANENT_SERVER_ID - Static variable in interface org.sonar.api.CoreProperties
Deprecated.
Perspective - Interface in org.sonar.api.component
Deprecated.
since 5.2
Phase - Annotation Type in org.sonar.api.batch
 
Phase.Name - Enum in org.sonar.api.batch
 
Plugin - Interface in org.sonar.api
Entry-point for plugins to inject extensions into SonarQube.
Plugin.Context - Class in org.sonar.api
 
pluginKey() - Method in class org.sonar.api.server.rule.internal.DefaultRule
 
pluginKey() - Method in class org.sonar.api.server.rule.RulesDefinition.Rule
 
PORTABILITY_COMPLIANCE - Static variable in class org.sonar.api.server.rule.RulesDefinition.SubCharacteristics
Deprecated.
Related to characteristic PORTABILITY
possibleValues() - Method in class org.sonar.api.server.ws.WebService.Param
 
possibleValues() - Static method in enum org.sonar.api.server.ws.WebService.SelectionMode
 
POST - org.sonar.api.batch.Phase.Name
 
PostJob - Interface in org.sonar.api.batch.postjob
PostJobs are executed at the very end of scanner analysis.
PostJobContext - Interface in org.sonar.api.batch.postjob
PostJobDescriptor - Interface in org.sonar.api.batch.postjob
Describe what a PostJob is doing.
PostJobIssue - Interface in org.sonar.api.batch.postjob.issue
Represents an issue state at the end of the scanner analysis in preview/issues mode.
PostProjectAnalysisTask - Interface in org.sonar.api.ce.posttask
Extension point of which any plugin can provide an implementation and will allow them to be notified whenever some analysis report processing ends in the Compute Engine.
PostProjectAnalysisTask.Context - Interface in org.sonar.api.ce.posttask
 
PostProjectAnalysisTask.LogStatistics - Interface in org.sonar.api.ce.posttask
Each key-value paar will be added to the log describing the end of the
PostProjectAnalysisTask.ProjectAnalysis - Interface in org.sonar.api.ce.posttask
 
PostProjectAnalysisTaskTester - Class in org.sonar.api.ce.posttask
This class can be used to test PostProjectAnalysisTask implementations, see example below:
PostProjectAnalysisTaskTester.AnalysisBuilder - Class in org.sonar.api.ce.posttask
 
PostProjectAnalysisTaskTester.BranchBuilder - Class in org.sonar.api.ce.posttask
 
PostProjectAnalysisTaskTester.CeTaskBuilder - Class in org.sonar.api.ce.posttask
 
PostProjectAnalysisTaskTester.ConditionBuilder - Class in org.sonar.api.ce.posttask
 
PostProjectAnalysisTaskTester.OrganizationBuilder - Class in org.sonar.api.ce.posttask
 
PostProjectAnalysisTaskTester.ProjectAnalysisBuilder - Class in org.sonar.api.ce.posttask
 
PostProjectAnalysisTaskTester.ProjectBuilder - Class in org.sonar.api.ce.posttask
 
PostProjectAnalysisTaskTester.QualityGateBuilder - Class in org.sonar.api.ce.posttask
 
PostProjectAnalysisTaskTester.ScannerContextBuilder - Class in org.sonar.api.ce.posttask
 
PRE - org.sonar.api.batch.Phase.Name
 
Preconditions - Class in org.sonar.api.utils
 
predicates() - Method in interface org.sonar.api.batch.fs.FileSystem
Factory of FilePredicate
PREFIX - Static variable in class org.sonar.api.config.EmailSettings
 
PREFIX_DEFAULT - Static variable in class org.sonar.api.config.EmailSettings
 
PREPROCESS_DIRECTIVE - org.sonar.api.batch.sensor.highlighting.TypeOfText
 
primaryLocation() - Method in interface org.sonar.api.batch.sensor.issue.IIssue
Primary locations for this issue.
primaryLocation() - Method in interface org.sonar.api.batch.sensor.issue.Issue
Primary locations for this issue.
println(String) - Method in class org.sonar.api.utils.System2
 
profile(String, String) - Method in class org.sonar.api.server.profile.BuiltInQualityProfilesDefinition.Context
 
ProfileDefinition - Class in org.sonar.api.profiles
Deprecated.
ProfileDefinition() - Constructor for class org.sonar.api.profiles.ProfileDefinition
Deprecated.
 
ProfileExporter - Class in org.sonar.api.profiles
Export quality profile rules to a file
ProfileExporter(String, String) - Constructor for class org.sonar.api.profiles.ProfileExporter
 
ProfileImporter - Class in org.sonar.api.profiles
Create a quality profile from an external rules file.
ProfileImporter(String, String) - Constructor for class org.sonar.api.profiles.ProfileImporter
 
Profiler - Class in org.sonar.api.utils.log
 
Profiler() - Constructor for class org.sonar.api.utils.log.Profiler
 
profilesByLanguageAndName() - Method in class org.sonar.api.server.profile.BuiltInQualityProfilesDefinition.Context
 
PROFILING_LOG_PROPERTY - Static variable in interface org.sonar.api.CoreProperties
 
PROGRAM_UNIT - Static variable in class org.sonar.api.resources.Scopes
Deprecated.
since 4.3 resources under FILE level are no more be supported since 4.2.
project() - Method in interface org.sonar.api.batch.sensor.SensorContext
The current project.
project() - Method in annotation type org.sonar.api.Property
Is the property displayed in project settings page ?
Project - Interface in org.sonar.api.ce.posttask
 
PROJECT - org.sonar.api.ce.measure.Component.Type
 
PROJECT - org.sonar.api.web.page.Page.Qualifier
 
PROJECT - org.sonar.api.web.Section
Deprecated.
 
PROJECT - Static variable in class org.sonar.api.resources.Qualifiers
Project Scope is Scopes.PROJECT
PROJECT - Static variable in class org.sonar.api.resources.Scopes
For example view, subview, project, module or library.
PROJECT - Static variable in annotation type org.sonar.api.web.WidgetScope
Deprecated.
 
PROJECT_COVERAGE_EXCLUSIONS_PROPERTY - Static variable in interface org.sonar.api.CoreProperties
 
PROJECT_DATE_PROPERTY - Static variable in interface org.sonar.api.CoreProperties
Value format is yyyy-MM-dd
PROJECT_DESCRIPTION_PROPERTY - Static variable in interface org.sonar.api.CoreProperties
 
PROJECT_EXCLUSIONS_PROPERTY - Static variable in interface org.sonar.api.CoreProperties
 
PROJECT_INCLUSIONS_PROPERTY - Static variable in interface org.sonar.api.CoreProperties
 
PROJECT_KEY_PROPERTY - Static variable in interface org.sonar.api.CoreProperties
 
PROJECT_NAME_PROPERTY - Static variable in interface org.sonar.api.CoreProperties
 
PROJECT_TEST_EXCLUSIONS_PROPERTY - Static variable in interface org.sonar.api.CoreProperties
 
PROJECT_TEST_INCLUSIONS_PROPERTY - Static variable in interface org.sonar.api.CoreProperties
 
PROJECT_VERSION_PROPERTY - Static variable in interface org.sonar.api.CoreProperties
 
ProjectBuilder - Class in org.sonar.api.batch.bootstrap
Deprecated.
since 6.5. It won't be possible to manipulate the project's structure.
ProjectBuilder() - Constructor for class org.sonar.api.batch.bootstrap.ProjectBuilder
Deprecated.
 
ProjectBuilder.Context - Interface in org.sonar.api.batch.bootstrap
Deprecated.
ProjectBuilderContext - Class in org.sonar.api.batch.bootstrap.internal
Deprecated.
since 6.5
ProjectBuilderContext(ProjectReactor) - Constructor for class org.sonar.api.batch.bootstrap.internal.ProjectBuilderContext
Deprecated.
 
ProjectDefinition - Class in org.sonar.api.batch.bootstrap
Deprecated.
since 7.6 use InputProject
projectKey() - Method in interface org.sonar.api.issue.Issue
 
projectKey() - Method in interface org.sonar.api.scan.issue.filter.FilterableIssue
Deprecated.
since 7.6 filtering issue should not depend on the key
projectReactor() - Method in class org.sonar.api.batch.bootstrap.internal.ProjectBuilderContext
Deprecated.
 
projectReactor() - Method in interface org.sonar.api.batch.bootstrap.ProjectBuilder.Context
Deprecated.
 
ProjectReactor - Class in org.sonar.api.batch.bootstrap
Deprecated.
since 6.5 plugins should no longer modify the project's structure
ProjectReactor(ProjectDefinition) - Constructor for class org.sonar.api.batch.bootstrap.ProjectReactor
Deprecated.
 
PROJECTS - Static variable in class org.sonar.api.measures.CoreMetrics
 
PROJECTS_KEY - Static variable in class org.sonar.api.measures.CoreMetrics
 
ProjectSensor - Interface in org.sonar.api.scanner.sensor
A sensor is invoked once for each project analysis.
projectUuid() - Method in interface org.sonar.api.issue.Issue
 
prop(String, boolean) - Method in class org.sonar.api.utils.text.JsonWriter
 
prop(String, boolean) - Method in class org.sonar.api.utils.text.XmlWriter
 
prop(String, double) - Method in class org.sonar.api.utils.text.JsonWriter
 
prop(String, double) - Method in class org.sonar.api.utils.text.XmlWriter
 
prop(String, long) - Method in class org.sonar.api.utils.text.JsonWriter
 
prop(String, long) - Method in class org.sonar.api.utils.text.XmlWriter
 
prop(String, Number) - Method in class org.sonar.api.utils.text.JsonWriter
Encodes the property name and value.
prop(String, Number) - Method in class org.sonar.api.utils.text.XmlWriter
 
prop(String, String) - Method in class org.sonar.api.utils.text.JsonWriter
 
prop(String, String) - Method in class org.sonar.api.utils.text.XmlWriter
 
PROP_DRIVER - Static variable in interface org.sonar.api.database.DatabaseProperties
Deprecated.
 
PROP_EMBEDDED_PORT - Static variable in interface org.sonar.api.database.DatabaseProperties
Deprecated.
 
PROP_EMBEDDED_PORT_DEFAULT_VALUE - Static variable in interface org.sonar.api.database.DatabaseProperties
Deprecated.
 
PROP_PASSWORD - Static variable in interface org.sonar.api.database.DatabaseProperties
Deprecated.
 
PROP_PASSWORD_DEFAULT_VALUE - Static variable in interface org.sonar.api.database.DatabaseProperties
Deprecated.
 
PROP_URL - Static variable in interface org.sonar.api.database.DatabaseProperties
Deprecated.
 
PROP_USER - Static variable in interface org.sonar.api.database.DatabaseProperties
Deprecated.
 
PROP_USER_DEFAULT_VALUE - Static variable in interface org.sonar.api.database.DatabaseProperties
Deprecated.
 
propDate(String, Date) - Method in class org.sonar.api.utils.text.JsonWriter
Encodes the property name and date value (ISO format).
propDateTime(String, Date) - Method in class org.sonar.api.utils.text.JsonWriter
Encodes the property name and datetime value (ISO format).
properties() - Method in class org.sonar.api.batch.bootstrap.ProjectDefinition
Deprecated.
 
properties() - Method in class org.sonar.api.utils.System2
Shortcut for System.getProperties()
Properties - Annotation Type in org.sonar.api
Plugin properties.
propertiesByCategory(String) - Method in class org.sonar.api.config.PropertyDefinitions
 
property(String) - Method in class org.sonar.api.utils.System2
Shortcut for System.getProperty(String)
Property - Annotation Type in org.sonar.api
Property value can be set in different ways : System property Batch command-line (-Dfoo=bar in Maven or sonar-runner) Maven pom.xml (element <properties>) Maven settings.xml SonarQube web administration console
PROPERTY_SET - org.sonar.api.PropertyType
Property set instance
PropertyDefinition - Class in org.sonar.api.config
Declare a plugin property.
PropertyDefinition.Builder - Class in org.sonar.api.config
 
PropertyDefinition.Result - Class in org.sonar.api.config
 
PropertyDefinitions - Class in org.sonar.api.config
Metadata of all the properties declared by plugins
PropertyDefinitions(Object...) - Constructor for class org.sonar.api.config.PropertyDefinitions
 
PropertyDefinitions(Collection<PropertyDefinition>) - Constructor for class org.sonar.api.config.PropertyDefinitions
 
PropertyField - Annotation Type in org.sonar.api
Property field.
PropertyFieldDefinition - Class in org.sonar.api.config
 
PropertyFieldDefinition.Builder - Class in org.sonar.api.config
 
propertySetKey() - Method in class org.sonar.api.config.PropertyDefinition
Deprecated.
since 6.1, as it was not used and too complex to maintain.
propertySetKey() - Method in annotation type org.sonar.api.Property
Deprecated.
since 6.1, as it was not used and too complex to maintain.
propertySetKey(String) - Method in class org.sonar.api.config.PropertyDefinition.Builder
Deprecated.
since 6.1, as it was not used and too complex to maintain.
PropertyType - Enum in org.sonar.api
 
provide() - Method in class org.sonar.api.ExtensionProvider
Deprecated.
 
PUBLIC_API - Static variable in class org.sonar.api.measures.CoreMetrics
 
PUBLIC_API_KEY - Static variable in class org.sonar.api.measures.CoreMetrics
Deprecated.
since 6.2
PUBLIC_DOCUMENTED_API_DENSITY - Static variable in class org.sonar.api.measures.CoreMetrics
 
PUBLIC_DOCUMENTED_API_DENSITY_KEY - Static variable in class org.sonar.api.measures.CoreMetrics
Deprecated.
since 6.2
PUBLIC_PERMISSIONS - Static variable in annotation type org.sonar.api.web.UserRole
Permissions which are implicitly available for any user, any group and to group "AnyOne" on public components.
PUBLIC_UNDOCUMENTED_API - Static variable in class org.sonar.api.measures.CoreMetrics
 
PUBLIC_UNDOCUMENTED_API_KEY - Static variable in class org.sonar.api.measures.CoreMetrics
Deprecated.
since 6.2
PULL_REQUEST - org.sonar.api.ce.posttask.Branch.Type
 

Q

qpKey() - Method in interface org.sonar.api.batch.rule.ActiveRule
Key of the quality profile the rule belongs to.
qualifier() - Method in class org.sonar.api.utils.Version
 
qualifiers() - Method in class org.sonar.api.config.PropertyDefinition
Qualifiers that can display this property
Qualifiers - Class in org.sonar.api.resources
The qualifier determines the exact type of a resource.
QUALITY_GATE_DETAILS - Static variable in class org.sonar.api.measures.CoreMetrics
The project detailed status with regard to its quality gate.
QUALITY_GATE_DETAILS_KEY - Static variable in class org.sonar.api.measures.CoreMetrics
 
QUALITY_PROFILES - Static variable in class org.sonar.api.measures.CoreMetrics
Deprecated.
since 5.5
QUALITY_PROFILES_KEY - Static variable in class org.sonar.api.measures.CoreMetrics
Deprecated.
since 5.5
QualityGate - Interface in org.sonar.api.ce.posttask
 
QualityGate.Condition - Interface in org.sonar.api.ce.posttask
 
QualityGate.EvaluationStatus - Enum in org.sonar.api.ce.posttask
Quality gate condition evaluation status.
QualityGate.Operator - Enum in org.sonar.api.ce.posttask
Quality Gate condition operator.
QualityGate.Status - Enum in org.sonar.api.ce.posttask
 

R

RangeDistributionBuilder - Class in org.sonar.api.ce.measure
Utility to build a distribution based on defined ranges
RangeDistributionBuilder() - Constructor for class org.sonar.api.ce.measure.RangeDistributionBuilder
 
RangeDistributionBuilder(Number[]) - Constructor for class org.sonar.api.ce.measure.RangeDistributionBuilder
RangeDistributionBuilder for a defined range Each entry is initialized at zero
RATING - org.sonar.api.measures.Metric.ValueType
 
RATING_GRID - Static variable in interface org.sonar.api.CoreProperties
 
RATING_GRID_DEF_VALUES - Static variable in interface org.sonar.api.CoreProperties
 
READABILITY - Static variable in class org.sonar.api.server.rule.RulesDefinition.SubCharacteristics
Deprecated.
Related to characteristic MAINTAINABILITY
readBytes(URI) - Method in class org.sonar.api.utils.UriReader
Reads all bytes from uri.
readBytes(URI) - Method in class org.sonar.api.utils.UriReader.SchemeProcessor
 
readString(URI, Charset) - Method in class org.sonar.api.utils.UriReader
Reads all characters from uri, using the given character set.
readString(URI, Charset) - Method in class org.sonar.api.utils.UriReader.SchemeProcessor
 
READY - org.sonar.api.rule.RuleStatus
 
redirectTo(String) - Method in interface org.sonar.api.server.authentication.OAuth2IdentityProvider.InitContext
Redirect the request to the url.
redirectToRequestedPage() - Method in interface org.sonar.api.server.authentication.OAuth2IdentityProvider.CallbackContext
Redirect the request to the requested page.
registerRepository(DefaultNewRepository) - Method in class org.sonar.api.server.rule.RulesDefinition.Context
 
REGULAR_EXPRESSION - org.sonar.api.PropertyType
Regular expression
REGULAR_EXPRESSION - org.sonar.api.web.WidgetPropertyType
Deprecated.
Regular expression
relativeFile(File, String) - Method in class org.sonar.api.scan.filesystem.PathResolver
 
relativeFiles(File, List<String>) - Method in class org.sonar.api.scan.filesystem.PathResolver
 
relativePath() - Method in interface org.sonar.api.batch.fs.IndexedFile
relativePath() - Method in interface org.sonar.api.batch.fs.InputDir
Deprecated.
Path relative to module base directory.
relativePath() - Method in interface org.sonar.api.batch.fs.InputFile
Deprecated.
since 6.6 use InputFile.inputStream() for file content, IndexedFile.filename() for file name, IndexedFile.uri() for an unique identifier, and InputFile.toString() for logging
relativePath() - Method in interface org.sonar.api.batch.fs.InputPath
Deprecated.
since 6.5 use InputPath.uri()
relativePath(File, File) - Method in class org.sonar.api.scan.filesystem.PathResolver
 
relativePath(Path, Path) - Method in class org.sonar.api.scan.filesystem.PathResolver
Similar to Path.relativize(Path) except that: null is returned if file is not a child of dir the resulting path is converted to use Unix separators
relativePath(Collection<File>, File) - Method in class org.sonar.api.scan.filesystem.PathResolver
Deprecated.
since 6.0 was used when component keys were relative to source dirs
RelativePath(File, String) - Constructor for class org.sonar.api.scan.filesystem.PathResolver.RelativePath
Deprecated.
 
relativePathFromScmRoot(Path) - Method in class org.sonar.api.batch.scm.ScmProvider
The relative path from SCM root
relativize(Path, Path) - Static method in class org.sonar.api.scan.filesystem.PathResolver
Similar to Path.relativize(Path) except that: Empty is returned if file is not a child of dir the resulting path is converted to use Unix separators
RELIABILITY_COMPLIANCE - Static variable in class org.sonar.api.server.rule.RulesDefinition.SubCharacteristics
Deprecated.
Related to characteristic RELIABILITY
RELIABILITY_RATING - Static variable in class org.sonar.api.measures.CoreMetrics
 
RELIABILITY_RATING_KEY - Static variable in class org.sonar.api.measures.CoreMetrics
 
RELIABILITY_REMEDIATION_EFFORT - Static variable in class org.sonar.api.measures.CoreMetrics
 
RELIABILITY_REMEDIATION_EFFORT_KEY - Static variable in class org.sonar.api.measures.CoreMetrics
 
remediationEffort() - Method in interface org.sonar.api.batch.sensor.issue.ExternalIssue
Effort to fix the issue, in minutes.
remediationEffortMinutes(Long) - Method in interface org.sonar.api.batch.sensor.issue.NewExternalIssue
Effort to fix the issue, in minutes.
remove() - Method in class org.sonar.api.batch.bootstrap.ProjectDefinition
Deprecated.
 
remove(String) - Method in class org.sonar.api.config.Settings
Deprecated.
 
removeActiveRule(ActiveRule) - Method in class org.sonar.api.profiles.RulesProfile
 
REMOVED - org.sonar.api.rule.RuleStatus
 
removeProperty(String) - Method in class org.sonar.api.config.Settings
Deprecated.
 
REOPEN - Static variable in interface org.sonar.api.issue.DefaultTransitions
 
REOPENED_ISSUES - Static variable in class org.sonar.api.measures.CoreMetrics
 
REOPENED_ISSUES_KEY - Static variable in class org.sonar.api.measures.CoreMetrics
 
repoKey() - Method in class org.sonar.api.server.profile.BuiltInQualityProfilesDefinition.BuiltInActiveRule
 
repoKey() - Method in class org.sonar.api.server.profile.BuiltInQualityProfilesDefinition.NewBuiltInActiveRule
 
repositories() - Method in class org.sonar.api.server.rule.RulesDefinition.AbstractContext
 
repositories() - Method in class org.sonar.api.server.rule.RulesDefinition.Context
 
repository() - Method in class org.sonar.api.rule.RuleKey
Never null
repository() - Method in class org.sonar.api.server.rule.internal.DefaultRule
 
repository() - Method in class org.sonar.api.server.rule.RulesDefinition.Rule
 
repository(String) - Method in class org.sonar.api.server.rule.RulesDefinition.AbstractContext
 
repository(String) - Method in class org.sonar.api.server.rule.RulesDefinition.Context
 
Request - Class in org.sonar.api.server.ws
 
Request() - Constructor for class org.sonar.api.server.ws.Request
 
Request.Param<T> - Interface in org.sonar.api.server.ws
Represents a Request parameter, provides information whether is was specified or not (check Request.Param.isPresent()) and utility method to nicely handles cases where the parameter is not present.
Request.Part - Interface in org.sonar.api.server.ws
 
Request.StringParam - Interface in org.sonar.api.server.ws
Extends Request.Param with convenience methods specific to the type String.
RequestHandler - Interface in org.sonar.api.server.ws
Extension point to execute a HTTP request.
requireProperties(String...) - Method in interface org.sonar.api.batch.postjob.PostJobDescriptor
List properties this PostJob depends on.
requireProperties(String...) - Method in interface org.sonar.api.batch.sensor.SensorDescriptor
requireProperty(String...) - Method in interface org.sonar.api.batch.postjob.PostJobDescriptor
Property this PostJob depends on.
requireProperty(String...) - Method in interface org.sonar.api.batch.sensor.SensorDescriptor
RESERVED_TAGS - Static variable in class org.sonar.api.server.rule.RuleTagsToTypeConverter
 
reset() - Method in class org.sonar.api.utils.dag.Node
 
RESET_AS_TO_REVIEW - Static variable in interface org.sonar.api.issue.DefaultTransitions
 
resetSources() - Method in class org.sonar.api.batch.bootstrap.ProjectDefinition
Deprecated.
 
resetTests() - Method in class org.sonar.api.batch.bootstrap.ProjectDefinition
Deprecated.
 
resolution() - Method in interface org.sonar.api.ce.measure.Issue
Available list of resolutions can be found in Issue.RESOLUTIONS
resolution() - Method in class org.sonar.api.ce.measure.test.TestIssue
 
resolution() - Method in interface org.sonar.api.issue.Issue
The type of resolution, or null if the issue is not resolved.
RESOLUTION_FALSE_POSITIVE - Static variable in interface org.sonar.api.issue.Issue
Resolution when issue is flagged as false positive.
RESOLUTION_FIXED - Static variable in interface org.sonar.api.issue.Issue
 
RESOLUTION_REMOVED - Static variable in interface org.sonar.api.issue.Issue
Resolution when rule has been uninstalled or disabled in the Quality profile.
RESOLUTION_WONT_FIX - Static variable in interface org.sonar.api.issue.Issue
Issue is irrelevant in the context and was muted by user.
RESOLUTIONS - Static variable in interface org.sonar.api.issue.Issue
 
RESOLVE - Static variable in interface org.sonar.api.issue.DefaultTransitions
 
RESOLVE_AS_REVIEWED - Static variable in interface org.sonar.api.issue.DefaultTransitions
 
resolvedIssues() - Method in interface org.sonar.api.batch.postjob.PostJobContext
Deprecated.
since 7.3 the preview/issues mode is deprecated since 6.7
resolveOrder() - Method in class org.sonar.api.utils.dag.Node
 
resolvePath(String) - Method in interface org.sonar.api.batch.fs.FileSystem
Utility method mainly used to resolve location of reports.
RESOURCE - Static variable in annotation type org.sonar.api.web.NavigationSection
Deprecated.
 
RESOURCE_CONFIGURATION - Static variable in annotation type org.sonar.api.web.NavigationSection
Deprecated.
Only Ruby and rails application.
RESOURCE_RELIABILITY - Static variable in class org.sonar.api.server.rule.RulesDefinition.SubCharacteristics
Deprecated.
Related to characteristic RELIABILITY
RESOURCE_TAB - Static variable in annotation type org.sonar.api.web.NavigationSection
Deprecated.
in 4.5, as it costs too much to maintain and update.
ResourceLanguage - Annotation Type in org.sonar.api.web
Deprecated.
since 6.3 see PageDefinition. This class is ignored.
ResourcePerspectives - Interface in org.sonar.api.component
Deprecated.
since 5.6 all features are available on SensorContext
ResourceQualifier - Annotation Type in org.sonar.api.web
Deprecated.
since 6.3 see PageDefinition. This class is ignored.
ResourceScope - Annotation Type in org.sonar.api.web
Deprecated.
since 6.3 see PageDefinition. This class is ignored.
ResourceType - Class in org.sonar.api.resources
Experimental extension to declare types of resources.
ResourceType.Builder - Class in org.sonar.api.resources
Builder used to create ResourceType objects.
ResourceTypes - Class in org.sonar.api.resources
 
ResourceTypes(ResourceTypeTree[]) - Constructor for class org.sonar.api.resources.ResourceTypes
 
ResourceTypeTree - Class in org.sonar.api.resources
 
ResourceTypeTree.Builder - Class in org.sonar.api.resources
 
Response - Interface in org.sonar.api.server.ws
HTTP response
Response.Stream - Interface in org.sonar.api.server.ws
 
responseExample() - Method in class org.sonar.api.server.ws.WebService.Action
 
responseExampleAsString() - Method in class org.sonar.api.server.ws.WebService.Action
 
responseExampleFormat() - Method in class org.sonar.api.server.ws.WebService.Action
 
REUSABILITY_COMPLIANCE - Static variable in class org.sonar.api.server.rule.RulesDefinition.SubCharacteristics
Deprecated.
Related to characteristic REUSABILITY
revision() - Method in class org.sonar.api.batch.scm.BlameLine
 
revision(String) - Method in class org.sonar.api.batch.scm.BlameLine
Mandatory field
revisionId(Path) - Method in class org.sonar.api.batch.scm.ScmProvider
The current revision id of the analyzed code, for example the SHA1 of the current HEAD in a Git branch.
RubyRailsPage - Interface in org.sonar.api.web
Deprecated.
since 6.3 see PageDefinition. This class is ignored.
RubyRailsWidget - Interface in org.sonar.api.web
Deprecated.
since 6.2, this extension is ignored as dashboards have been removed
rule() - Method in class org.sonar.api.rule.RuleKey
Never null
rule(String) - Method in class org.sonar.api.server.rule.internal.DefaultNewRepository
 
rule(String) - Method in class org.sonar.api.server.rule.internal.DefaultRepository
 
rule(String) - Method in interface org.sonar.api.server.rule.RulesDefinition.ExtendedRepository
 
rule(String) - Method in interface org.sonar.api.server.rule.RulesDefinition.NewExtendedRepository
 
rule(RuleKey) - Method in interface org.sonar.api.server.profile.BuiltInQualityProfilesDefinition.BuiltInQualityProfile
 
rule(RuleKey) - Method in class org.sonar.api.server.profile.BuiltInQualityProfilesDefinition.BuiltInQualityProfileImpl
 
Rule - Class in org.sonar.api.rules
 
Rule - Interface in org.sonar.api.batch.rule
 
Rule() - Constructor for class org.sonar.api.rules.Rule
Deprecated.
since 2.3. Use the factory method Rule.create()
Rule() - Constructor for class org.sonar.api.server.rule.RulesDefinition.Rule
 
Rule(String, String) - Constructor for class org.sonar.api.rules.Rule
Deprecated.
since 2.3. Use the factory method Rule.create()
RuleAnnotationUtils - Class in org.sonar.api.rules
 
RuleFinder - Interface in org.sonar.api.rules
Used in ProfileExporter and ProfileImporter Use ActiveRules on scanner side.
RuleI18n - Interface in org.sonar.api.i18n
Deprecated.
in 4.1. Rules are not localized anymore. See http://jira.sonarsource.com/browse/SONAR-4885
ruleId() - Method in interface org.sonar.api.batch.sensor.issue.ExternalIssue
 
ruleId() - Method in interface org.sonar.api.batch.sensor.rule.AdHocRule
Unique rule identifier for a given AdHocRule.engineId()
ruleId(String) - Method in interface org.sonar.api.batch.sensor.issue.NewExternalIssue
Unique rule identifier for a given NewExternalIssue.engineId(String)
ruleId(String) - Method in interface org.sonar.api.batch.sensor.rule.NewAdHocRule
Unique rule identifier for a given NewAdHocRule.engineId(String)
ruleKey() - Method in interface org.sonar.api.batch.postjob.issue.PostJobIssue
The RuleKey of this issue.
ruleKey() - Method in interface org.sonar.api.batch.rule.ActiveRule
 
ruleKey() - Method in interface org.sonar.api.batch.sensor.issue.IIssue
The RuleKey of this issue.
ruleKey() - Method in interface org.sonar.api.ce.measure.Issue
 
ruleKey() - Method in class org.sonar.api.ce.measure.test.TestIssue
 
ruleKey() - Method in interface org.sonar.api.issue.Issue
 
ruleKey() - Method in class org.sonar.api.rules.Rule
 
ruleKey() - Method in interface org.sonar.api.scan.issue.filter.FilterableIssue
Deprecated.
 
ruleKey() - Method in class org.sonar.api.server.profile.BuiltInQualityProfilesDefinition.BuiltInActiveRule
 
ruleKey() - Method in class org.sonar.api.server.profile.BuiltInQualityProfilesDefinition.NewBuiltInActiveRule
 
ruleKey(C) - Method in class org.sonar.api.batch.rule.Checks
 
RuleKey - Class in org.sonar.api.rule
Key of a rule.
RuleKey(String, String) - Constructor for class org.sonar.api.rule.RuleKey
 
RuleParam - Class in org.sonar.api.rules
 
RuleParam - Interface in org.sonar.api.batch.rule
 
RuleParam() - Constructor for class org.sonar.api.rules.RuleParam
Deprecated.
since 2.3 use the factory method Rule.setParameter()
RuleParam(Rule, String, String, String) - Constructor for class org.sonar.api.rules.RuleParam
Deprecated.
since 2.3 use the factory method setParameter()
RuleParamType - Class in org.sonar.api.server.rule
 
RulePriority - Enum in org.sonar.api.rules
Deprecated.
since 4.2
RuleQuery - Class in org.sonar.api.rules
 
RuleRepository - Class in org.sonar.api.rules
Deprecated.
in 4.2. Replaced by org.sonar.api.server.rule.RulesDefinition
RuleRepository(String, String) - Constructor for class org.sonar.api.rules.RuleRepository
Deprecated.
 
rules() - Method in interface org.sonar.api.server.profile.BuiltInQualityProfilesDefinition.BuiltInQualityProfile
 
rules() - Method in class org.sonar.api.server.profile.BuiltInQualityProfilesDefinition.BuiltInQualityProfileImpl
 
rules() - Method in class org.sonar.api.server.rule.internal.DefaultNewRepository
 
rules() - Method in class org.sonar.api.server.rule.internal.DefaultRepository
 
rules() - Method in interface org.sonar.api.server.rule.RulesDefinition.ExtendedRepository
 
rules() - Method in interface org.sonar.api.server.rule.RulesDefinition.NewExtendedRepository
 
Rules - Interface in org.sonar.api.batch.rule
Deprecated.
since 7.4 we plan to stop loading rules on scanner side
RuleScope - Enum in org.sonar.api.rule
 
RulesDefinition - Interface in org.sonar.api.server.rule
Defines some coding rules of the same repository.
RulesDefinition.AbstractContext - Class in org.sonar.api.server.rule
Instantiated by core but not by plugins, except for their tests.
RulesDefinition.Context - Class in org.sonar.api.server.rule
This implementation will be removed as soon as analyzers stop instantiating it.
RulesDefinition.DebtRemediationFunctions - Interface in org.sonar.api.server.rule
RulesDefinition.ExtendedRepository - Interface in org.sonar.api.server.rule
 
RulesDefinition.NewExtendedRepository - Interface in org.sonar.api.server.rule
 
RulesDefinition.NewParam - Class in org.sonar.api.server.rule
 
RulesDefinition.NewRepository - Interface in org.sonar.api.server.rule
 
RulesDefinition.NewRule - Class in org.sonar.api.server.rule
 
RulesDefinition.OwaspTop10 - Enum in org.sonar.api.server.rule
 
RulesDefinition.Param - Interface in org.sonar.api.server.rule
 
RulesDefinition.Repository - Interface in org.sonar.api.server.rule
 
RulesDefinition.Rule - Class in org.sonar.api.server.rule
 
RulesDefinition.SubCharacteristics - Class in org.sonar.api.server.rule
Deprecated.
in 5.5. SQALE Quality Model is replaced by SonarQube Quality Model. See https://jira.sonarsource.com/browse/MMF-184
RulesDefinitionAnnotationLoader - Class in org.sonar.api.server.rule
Read definitions of rules based on the annotations provided by sonar-check-api.
RulesDefinitionAnnotationLoader() - Constructor for class org.sonar.api.server.rule.RulesDefinitionAnnotationLoader
 
RulesDefinitionI18nLoader - Class in org.sonar.api.server.rule
Loads the English bundles of rules (name, description and parameters) that are deprecated since 4.2.
RulesDefinitionI18nLoader(RuleI18n) - Constructor for class org.sonar.api.server.rule.RulesDefinitionI18nLoader
 
RulesDefinitionXmlLoader - Class in org.sonar.api.server.rule
Loads definitions of rules from a XML file.
RulesDefinitionXmlLoader() - Constructor for class org.sonar.api.server.rule.RulesDefinitionXmlLoader
 
RulesProfile - Class in org.sonar.api.profiles
This class is badly named.
RulesProfile() - Constructor for class org.sonar.api.profiles.RulesProfile
Deprecated.
use the factory method create()
RulesProfile(String, String) - Constructor for class org.sonar.api.profiles.RulesProfile
Deprecated.
since 2.3. Use the factory method create()
RulesProfile(String, String, boolean, boolean) - Constructor for class org.sonar.api.profiles.RulesProfile
Deprecated.
since 2.3. Use the factory method create()
RuleStatus - Enum in org.sonar.api.rule
 
RuleTagFormat - Class in org.sonar.api.server.rule
The characters allowed in rule tags are the same as those on StackOverflow, basically lower-case letters, digits, plus (+), sharp (#), dash (-) and dot (.) See http://meta.stackoverflow.com/questions/22624/what-symbols-characters-are-not-allowed-in-tags
RuleTagsToTypeConverter - Class in org.sonar.api.server.rule
 
RuleType - Enum in org.sonar.api.rules
 
runtime() - Method in interface org.sonar.api.batch.sensor.SensorContext
Runtime information, mainly: to be able to have different behaviours between SonarQube and SonarLint to enable new features depending on version of API available at runtime

S

SAME - org.sonar.api.batch.fs.InputFile.Status
Deprecated.
 
sanitize(String) - Static method in class org.sonar.api.utils.PathUtils
Normalize path and replace file separators by forward slash
save() - Method in interface org.sonar.api.batch.sensor.code.NewSignificantCode
Save the reported information for the given file.
save() - Method in interface org.sonar.api.batch.sensor.coverage.NewCoverage
Call this method to save the coverage report for the given file.
save() - Method in interface org.sonar.api.batch.sensor.cpd.NewCpdTokens
Call this method only once when your are done with defining tokens of the file.
save() - Method in interface org.sonar.api.batch.sensor.error.NewAnalysisError
Save this error information.
save() - Method in interface org.sonar.api.batch.sensor.highlighting.NewHighlighting
Call this method only once when your are done with defining highlighting of the file.
save() - Method in interface org.sonar.api.batch.sensor.issue.NewExternalIssue
Save the issue.
save() - Method in interface org.sonar.api.batch.sensor.issue.NewIssue
Save the issue.
save() - Method in interface org.sonar.api.batch.sensor.measure.NewMeasure
Save the measure.
save() - Method in interface org.sonar.api.batch.sensor.rule.NewAdHocRule
Save the rule.
save() - Method in interface org.sonar.api.batch.sensor.symbol.NewSymbolTable
Call this method only once when your are done with defining all symbols of the file.
save() - Method in interface org.sonar.api.measures.FileLinesContext
Saves unsaved values.
scaleValue(double) - Static method in class org.sonar.api.utils.ParsingUtils
Scales a double value, taking into account 2 decimals
scaleValue(double, int) - Static method in class org.sonar.api.utils.ParsingUtils
Scales a double value with decimals
SCAN - Static variable in annotation type org.sonar.api.web.UserRole
 
SCAN_TASK - Static variable in interface org.sonar.api.CoreProperties
Deprecated.
since 7.6
SCANNER - org.sonar.api.SonarQubeSide
 
ScannerContext - Interface in org.sonar.api.ce.posttask
 
ScannerSide - Annotation Type in org.sonar.api.batch
Deprecated.
since 7.6 use ScannerSide that will move the component to the project container
ScannerSide - Annotation Type in org.sonar.api.scanner
Marker annotation for all the components available in the container of the scanner (code analyzer).
SchemeProcessor() - Constructor for class org.sonar.api.utils.UriReader.SchemeProcessor
 
SCM_DISABLED_KEY - Static variable in interface org.sonar.api.CoreProperties
 
SCM_EXCLUSIONS_DISABLED_KEY - Static variable in interface org.sonar.api.CoreProperties
 
SCM_PROVIDER_KEY - Static variable in interface org.sonar.api.CoreProperties
 
ScmProvider - Class in org.sonar.api.batch.scm
 
ScmProvider() - Constructor for class org.sonar.api.batch.scm.ScmProvider
 
scope() - Method in class org.sonar.api.server.rule.internal.DefaultRule
 
scope() - Method in class org.sonar.api.server.rule.RulesDefinition.NewRule
 
scope() - Method in class org.sonar.api.server.rule.RulesDefinition.Rule
 
Scopes - Class in org.sonar.api.resources
Resource scopes are used to group some types of resources.
scramble(String) - Method in class org.sonar.api.config.Encryption
 
searchText() - Method in class org.sonar.api.user.UserQuery
Search for logins or names containing a given string
searchText(String) - Method in class org.sonar.api.user.UserQuery.Builder
 
Section - Enum in org.sonar.api.web
Deprecated.
add annotation org.sonar.api.web.NavigationSection to View extensions
SECURITY_COMPLIANCE - Static variable in class org.sonar.api.server.rule.RulesDefinition.SubCharacteristics
Deprecated.
Related to characteristic SECURITY
SECURITY_FEATURES - Static variable in class org.sonar.api.server.rule.RulesDefinition.SubCharacteristics
Deprecated.
Related to characteristic SECURITY
SECURITY_HOTSPOT - org.sonar.api.rules.RuleType
 
SECURITY_HOTSPOTS - Static variable in class org.sonar.api.measures.CoreMetrics
 
SECURITY_HOTSPOTS_KEY - Static variable in class org.sonar.api.measures.CoreMetrics
 
SECURITY_RATING - Static variable in class org.sonar.api.measures.CoreMetrics
 
SECURITY_RATING_KEY - Static variable in class org.sonar.api.measures.CoreMetrics
 
SECURITY_REMEDIATION_EFFORT - Static variable in class org.sonar.api.measures.CoreMetrics
 
SECURITY_REMEDIATION_EFFORT_KEY - Static variable in class org.sonar.api.measures.CoreMetrics
 
SECURITY_REVIEW_RATING - Static variable in class org.sonar.api.measures.CoreMetrics
 
SECURITY_REVIEW_RATING_KEY - Static variable in class org.sonar.api.measures.CoreMetrics
 
SECURITYHOTSPOT_ADMIN - Static variable in annotation type org.sonar.api.web.UserRole
 
SecurityRealm - Class in org.sonar.api.security
 
SecurityRealm() - Constructor for class org.sonar.api.security.SecurityRealm
 
securityStandards() - Method in class org.sonar.api.server.rule.internal.DefaultRule
 
securityStandards() - Method in class org.sonar.api.server.rule.RulesDefinition.Rule
 
SELECTED - org.sonar.api.server.ws.WebService.SelectionMode
 
SELECTED - Static variable in class org.sonar.api.server.ws.WebService.Param
 
selectLine(int) - Method in interface org.sonar.api.batch.fs.InputFile
Returns a TextRange in the given file that select the full line.
Sensor - Interface in org.sonar.api.batch.sensor
A sensor is invoked once for each module of a project, starting from leaf modules.
SensorContext - Interface in org.sonar.api.batch.sensor
See Sensor.execute(SensorContext) In order to write unit tests you can use SensorContextTester
SensorDescriptor - Interface in org.sonar.api.batch.sensor
Describe what a Sensor is doing.
SensorStorage - Interface in org.sonar.api.batch.sensor.internal
Interface for storing data computed by sensors.
Server - Class in org.sonar.api.platform
Runtime information about server
Server() - Constructor for class org.sonar.api.platform.Server
 
SERVER - org.sonar.api.SonarQubeSide
 
SERVER_BASE_URL - Static variable in interface org.sonar.api.CoreProperties
This property defines the SonarQubeServer base url, such as http://yourhost.yourdomain/sonar.
SERVER_BASE_URL_DEFAULT_VALUE - Static variable in interface org.sonar.api.CoreProperties
Deprecated.
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().
SERVER_ID - Static variable in interface org.sonar.api.CoreProperties
 
SERVER_ID_IP_ADDRESS - Static variable in interface org.sonar.api.CoreProperties
Deprecated.
SERVER_STARTTIME - Static variable in interface org.sonar.api.CoreProperties
 
ServerFileSystem - Interface in org.sonar.api.platform
 
ServerSide - Annotation Type in org.sonar.api.server
Same as ScannerSide but for server-side components.
ServerStartHandler - Interface in org.sonar.api.platform
 
ServerStopHandler - Interface in org.sonar.api.platform
 
ServerUpgradeStatus - Interface in org.sonar.api.platform
 
ServletFilter - Class in org.sonar.api.web
 
ServletFilter() - Constructor for class org.sonar.api.web.ServletFilter
 
ServletFilter.UrlPattern - Class in org.sonar.api.web
 
ServletFilter.UrlPattern.Builder - Class in org.sonar.api.web
 
set(String, String) - Method in class org.sonar.api.config.Settings
Deprecated.
Add the settings with the specified key and value, both are trimmed and neither can be null.
SET_AS_IN_REVIEW - Static variable in interface org.sonar.api.issue.DefaultTransitions
 
setActivated(boolean) - Method in class org.sonar.api.web.Dashboard
Deprecated.
Set whether the dashboard is activated for all anonymous users or users who haven't configured their own dashboards.
setActivatedByDefault(boolean) - Method in class org.sonar.api.server.rule.RulesDefinition.NewRule
Should this rule be enabled by default.
setActiveRule(ActiveRule) - Method in class org.sonar.api.rules.ActiveRuleParam
Deprecated.
visibility should be decreased to protected or package
setActiveRuleParams(List<ActiveRuleParam>) - Method in class org.sonar.api.rules.ActiveRule
Deprecated.
use setParameter()
setActiveRules(List<ActiveRule>) - Method in class org.sonar.api.profiles.RulesProfile
Set the list of active rules
setAdmin(boolean) - Method in class org.sonar.api.web.page.Page.Builder
if set to true, display the page in the administration section, depending on the scope
setAnalysis(Analysis) - Method in class org.sonar.api.ce.posttask.PostProjectAnalysisTaskTester.ProjectAnalysisBuilder
 
setAnalysisUuid(String) - Method in class org.sonar.api.ce.posttask.PostProjectAnalysisTaskTester.AnalysisBuilder
 
setBackgroundColor(String) - Method in class org.sonar.api.server.authentication.Display.Builder
 
setBaseDir(File) - Method in class org.sonar.api.batch.bootstrap.ProjectDefinition
Deprecated.
 
setBestValue(Double) - Method in class org.sonar.api.measures.Metric.Builder
Sets the best value that the metric can get (example: 100.0 for code coverage).
setBestValue(Double) - Method in class org.sonar.api.measures.Metric
 
setBooleanPossibleValues() - Method in class org.sonar.api.server.ws.WebService.NewParam
Shortcut for setPossibleValues("true", "false", "yes", "no")
setBranch(Branch) - Method in class org.sonar.api.ce.posttask.PostProjectAnalysisTaskTester.ProjectAnalysisBuilder
 
setBuildDir(File) - Method in class org.sonar.api.batch.bootstrap.ProjectDefinition
Deprecated.
since 6.1 notion of buildDir is not well defined
setCardinality(Cardinality) - Method in class org.sonar.api.rules.Rule
Deprecated.
setCeTask(CeTask) - Method in class org.sonar.api.ce.posttask.PostProjectAnalysisTaskTester.ProjectAnalysisBuilder
 
setChangelog(Change...) - Method in class org.sonar.api.server.ws.WebService.NewAction
List of changes made to the contract or valuable insight.
setCharacteristicId(Integer) - Method in class org.sonar.api.rules.Rule
Deprecated.
setCharacteristicKey(String) - Method in class org.sonar.api.rules.Rule
Deprecated.
in 5.5. SQALE Quality Model is replaced by SonarQube Quality Model.
setComponentQualifiers(Page.Qualifier...) - Method in class org.sonar.api.web.page.Page.Builder
Define the components where the page is displayed.
setConfigKey(String) - Method in class org.sonar.api.rules.Rule
Sets the configuration key
setCoverageBlock(InputFile, List<Integer>) - Method in interface org.sonar.api.test.MutableTestCase
Deprecated.
 
setCoverageBlock(Testable, List<Integer>) - Method in interface org.sonar.api.test.MutableTestCase
setCreatedAt(long) - Method in class org.sonar.api.batch.rule.LoadedActiveRule
 
setCreatedAt(Date) - Method in class org.sonar.api.rules.Rule
 
setCurrentPluginKey(String) - Method in class org.sonar.api.server.rule.RulesDefinition.AbstractContext
 
setCurrentPluginKey(String) - Method in class org.sonar.api.server.rule.RulesDefinition.Context
 
setDate(Date) - Method in class org.sonar.api.ce.posttask.PostProjectAnalysisTaskTester.AnalysisBuilder
 
setDate(Date) - Method in class org.sonar.api.ce.posttask.PostProjectAnalysisTaskTester.ProjectAnalysisBuilder
 
setDebtRemediationFunction(DebtRemediationFunction) - Method in class org.sonar.api.server.rule.RulesDefinition.NewRule
 
setDebtSubCharacteristic(String) - Method in class org.sonar.api.server.rule.RulesDefinition.NewRule
Deprecated.
in 5.5. SQALE Quality Model is replaced by SonarQube Quality Model. This method does nothing. See https://jira.sonarsource.com/browse/MMF-184
setDecimalScale(int) - Method in class org.sonar.api.measures.Metric.Builder
Scale to be used if the metric has decimal type (Metric.ValueType.FLOAT or Metric.ValueType.PERCENT).
setDefault(boolean) - Method in interface org.sonar.api.server.profile.BuiltInQualityProfilesDefinition.NewBuiltInQualityProfile
Set whether this is the default profile for the language.
setDefault(boolean) - Method in class org.sonar.api.server.profile.BuiltInQualityProfilesDefinition.NewBuiltInQualityProfileImpl
 
setDefaultCharacteristicId(Integer) - Method in class org.sonar.api.rules.Rule
Deprecated.
setDefaultCharacteristicKey(String) - Method in class org.sonar.api.rules.Rule
Deprecated.
in 5.5. SQALE Quality Model is replaced by SonarQube Quality Model.
setDefaultMessage(String) - Method in class org.sonar.api.notifications.Notification
Deprecated.
When creating a new notification, it is strongly advised to give a default message that can be used by channels that don't want to specifically format messages for different notification types.
setDefaultProfile(Boolean) - Method in class org.sonar.api.profiles.RulesProfile
Set whether this is the default profile for the language.
setDefaultSubCharacteristicKey(String) - Method in class org.sonar.api.rules.Rule
Deprecated.
in 5.5. SQALE Quality Model is replaced by SonarQube Quality Model.
setDefaultValue(Object) - Method in class org.sonar.api.server.ws.WebService.NewParam
 
setDefaultValue(String) - Method in class org.sonar.api.rules.RuleParam
 
setDefaultValue(String) - Method in class org.sonar.api.server.rule.internal.DefaultNewParam
 
setDefaultValue(String) - Method in class org.sonar.api.server.rule.RulesDefinition.NewParam
Empty default value will be converted to null.
setDeleteHistoricalData(boolean) - Method in class org.sonar.api.measures.Metric.Builder
Specifies whether measures from the past can be automatically deleted to minimize database volume.
setDeprecatedKey(String) - Method in class org.sonar.api.server.ws.WebService.NewAction
 
setDeprecatedKey(String) - Method in class org.sonar.api.server.ws.WebService.NewParam
Deprecated.
since 6.4
setDeprecatedKey(String, String) - Method in class org.sonar.api.server.ws.WebService.NewParam
 
setDeprecatedSince(String) - Method in class org.sonar.api.server.ws.WebService.NewAction
 
setDeprecatedSince(String) - Method in class org.sonar.api.server.ws.WebService.NewParam
 
setDescription(String) - Method in class org.sonar.api.batch.bootstrap.ProjectDefinition
Deprecated.
 
setDescription(String) - Method in class org.sonar.api.measures.Metric.Builder
Sets the metric description.
setDescription(String) - Method in class org.sonar.api.measures.Metric
Sets the metric description
setDescription(String) - Method in class org.sonar.api.rules.Rule
Sets the rule description
setDescription(String) - Method in class org.sonar.api.rules.RuleParam
 
setDescription(String) - Method in class org.sonar.api.server.rule.internal.DefaultNewParam
 
setDescription(String) - Method in class org.sonar.api.server.rule.RulesDefinition.NewParam
Plain-text description.
setDescription(String) - Method in class org.sonar.api.server.ws.WebService.NewAction
Used in Orchestrator
setDescription(String) - Method in class org.sonar.api.server.ws.WebService.NewController
Optional description (accept HTML)
setDescription(String) - Method in class org.sonar.api.server.ws.WebService.NewParam
 
setDescription(String) - Method in class org.sonar.api.web.Dashboard
Deprecated.
Sets the description of the dashboard.
setDescription(String, Object...) - Method in class org.sonar.api.server.ws.WebService.NewAction
 
setDescription(String, Object...) - Method in class org.sonar.api.server.ws.WebService.NewParam
 
setDirection(Integer) - Method in class org.sonar.api.measures.Metric.Builder
Sets the metric direction (used for numeric values only), which is used in the Web UI to show if the trend of a metric is good or not.
setDirection(Integer) - Method in class org.sonar.api.measures.Metric
Sets the metric direction.
setDirectory(File) - Method in class org.sonar.api.utils.command.Command
Sets working directory.
setDomain(String) - Method in class org.sonar.api.measures.Metric.Builder
Sets the domain for the metric (General, Complexity...).
setDomain(String) - Method in class org.sonar.api.measures.Metric
Sets the domain for the metric (General, Complexity...)
setDurationInMs(Long) - Method in interface org.sonar.api.test.MutableTestCase
Deprecated.
 
setEffort(Duration) - Method in class org.sonar.api.ce.measure.test.TestIssue.Builder
 
setEffortToFixDescription(String) - Method in class org.sonar.api.server.rule.RulesDefinition.NewRule
Deprecated.
setEmail(String) - Method in class org.sonar.api.database.model.User
Deprecated.
 
setEmail(String) - Method in class org.sonar.api.platform.NewUserHandler.Context.Builder
 
setEmail(String) - Method in class org.sonar.api.security.UserDetails
 
setEmail(String) - Method in class org.sonar.api.server.authentication.UserIdentity.Builder
 
setEnabled(Boolean) - Method in class org.sonar.api.measures.Metric
Sets whether the metric is enabled
setEnvironmentVariable(String, String) - Method in class org.sonar.api.utils.command.Command
 
setErrorThreshold(String) - Method in class org.sonar.api.ce.posttask.PostProjectAnalysisTaskTester.ConditionBuilder
 
setExampleValue(Object) - Method in class org.sonar.api.server.ws.WebService.NewParam
 
setFieldValue(String, String) - Method in class org.sonar.api.notifications.Notification
Deprecated.
Adds a field (kind of property) to the notification
setGapDescription(String) - Method in class org.sonar.api.server.rule.RulesDefinition.NewRule
For rules that use LINEAR or LINEAR_OFFSET remediation functions, the meaning of the function parameter (= "gap") must be set.
setGlobal(boolean) - Method in class org.sonar.api.web.Dashboard
Deprecated.
A dashboard is global when it doesn't display information from a project but rather more general information.
setGroups(Set<String>) - Method in class org.sonar.api.server.authentication.UserIdentity.Builder
Set group membership of the user.
setHandler(RequestHandler) - Method in class org.sonar.api.server.ws.WebService.NewAction
 
setHeader(String, String) - Method in interface org.sonar.api.server.ws.Response
 
setHelpMessage(String) - Method in class org.sonar.api.server.authentication.Display.Builder
 
setHidden(boolean) - Method in class org.sonar.api.measures.Metric.Builder
Sets whether the metric should be hidden in Web UI (e.g.
setHidden(Boolean) - Method in class org.sonar.api.measures.Metric
 
setHtmlDescription(String) - Method in class org.sonar.api.server.rule.RulesDefinition.NewRule
The optional description, in HTML format, has no max length.
setHtmlDescription(URL) - Method in class org.sonar.api.server.rule.RulesDefinition.NewRule
Load description from a file available in classpath.
setIconPath(String) - Method in class org.sonar.api.resources.ResourceType.Builder
Relative path of the icon used to represent the resource type.
setIconPath(String) - Method in class org.sonar.api.server.authentication.Display.Builder
 
setId(Integer) - Method in class org.sonar.api.database.BaseIdentifiable
Deprecated.
 
setId(Integer) - Method in class org.sonar.api.measures.Metric
For internal use only
setId(Integer) - Method in class org.sonar.api.rules.ActiveRule
Deprecated.
visibility should be decreased to protected or package
setId(Integer) - Method in class org.sonar.api.rules.Rule
Deprecated.
since 2.3. visibility should be decreased to protected or package
setId(String) - Method in class org.sonar.api.ce.posttask.PostProjectAnalysisTaskTester.CeTaskBuilder
 
setId(String) - Method in class org.sonar.api.ce.posttask.PostProjectAnalysisTaskTester.QualityGateBuilder
 
setInheritance(String) - Method in class org.sonar.api.rules.ActiveRule
For internal use only.
setInputMetrics(String...) - Method in interface org.sonar.api.ce.measure.MeasureComputer.MeasureComputerDefinition.Builder
List of metric keys of the measures that will be loaded by this computer.
setInputMetrics(String...) - Method in class org.sonar.api.ce.measure.test.TestMeasureComputerDefinition.MeasureComputerDefinitionBuilderImpl
 
setInternal(boolean) - Method in class org.sonar.api.server.ws.WebService.NewAction
Internal actions are not displayed by default in the web api documentation.
setInternal(boolean) - Method in class org.sonar.api.server.ws.WebService.NewParam
Internal parameters are not displayed by default in the web api documentation.
setInternalKey(String) - Method in class org.sonar.api.batch.rule.LoadedActiveRule
 
setInternalKey(String) - Method in class org.sonar.api.server.rule.RulesDefinition.NewRule
Optional key that can be used by the rule engine.
setIntValue(String, int, int) - Method in interface org.sonar.api.measures.FileLinesContext
 
setIsMain(boolean) - Method in class org.sonar.api.ce.posttask.PostProjectAnalysisTaskTester.BranchBuilder
 
setIssues(List<Issue>) - Method in class org.sonar.api.ce.measure.test.TestMeasureComputerContext
 
setIsTemplate(boolean) - Method in class org.sonar.api.rules.Rule
 
setKey(String) - Method in class org.sonar.api.batch.bootstrap.ProjectDefinition
Deprecated.
 
setKey(String) - Method in class org.sonar.api.ce.measure.test.TestIssue.Builder
 
setKey(String) - Method in class org.sonar.api.ce.posttask.PostProjectAnalysisTaskTester.OrganizationBuilder
 
setKey(String) - Method in class org.sonar.api.ce.posttask.PostProjectAnalysisTaskTester.ProjectBuilder
 
setKey(String) - Method in class org.sonar.api.measures.Metric
Sets the metric key
setKey(String) - Method in class org.sonar.api.profiles.ProfileExporter
 
setKey(String) - Method in class org.sonar.api.profiles.ProfileImporter
 
setKey(String) - Method in class org.sonar.api.rules.Rule
Sets the rule key
setKey(String) - Method in class org.sonar.api.rules.RuleParam
 
setLanguage(String) - Method in class org.sonar.api.batch.rule.LoadedActiveRule
 
setLanguage(String) - Method in class org.sonar.api.profiles.RulesProfile
Set the profile language
setLanguage(String) - Method in class org.sonar.api.rules.Rule
For internal use only.
setLayout(DashboardLayout) - Method in class org.sonar.api.web.Dashboard
Deprecated.
 
setLevel(LoggerLevel) - Method in interface org.sonar.api.utils.log.Logger
Attempt to change logger level.
setLevel(LoggerLevel) - Method in class org.sonar.api.utils.log.Loggers
 
setLevel(LoggerLevel) - Method in class org.sonar.api.utils.log.LogTester
Ena