A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
All Classes All Packages
All Classes All Packages
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
-
Deprecated.
- 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, andInputFile.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
- 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.
- 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 eachFilterableIssue
created during analysis, to check if it has to be persisted. - ACCEPT - Static variable in interface org.sonar.api.issue.DefaultTransitions
- ACCEPTED - org.sonar.api.issue.IssueStatus
- ACCEPTED_ISSUES - Static variable in class org.sonar.api.measures.CoreMetrics
- ACCEPTED_ISSUES_KEY - Static variable in class org.sonar.api.measures.CoreMetrics
- action() - Method in class org.sonar.api.server.ws.impl.ValidatingRequest
- 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.
- ADAPTABLE - org.sonar.api.rules.CleanCodeAttributeCategory
- 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(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
- 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
- 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.
- addCookie(Cookie) - Method in interface org.sonar.api.server.http.HttpResponse
-
Adds the specified cookie to the response.
- 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.
- addDefaultImpact(SoftwareQuality, Severity) - Method in interface org.sonar.api.batch.sensor.rule.NewAdHocRule
-
Add new default impact to the rule.
- addDefaultImpact(SoftwareQuality, Severity) - Method in class org.sonar.api.server.rule.RulesDefinition.NewRule
-
Add a default impact to the rule.
- 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). - addDescriptionSection(RuleDescriptionSection) - Method in class org.sonar.api.server.rule.RulesDefinition.NewRule
-
Add a rule description section.
- ADDED - org.sonar.api.batch.fs.InputFile.Status
- addEducationPrincipleKeys(String...) - Method in class org.sonar.api.server.rule.RulesDefinition.NewRule
- addErrorText(String) - Method in class org.sonar.api.utils.ValidationMessages
- addExtension(Object) - Method in class org.sonar.api.Plugin.Context
- 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.
- addFlow(Iterable<NewIssueLocation>, NewIssue.FlowType, String) - Method in interface org.sonar.api.batch.sensor.issue.NewIssue
-
Register a flow for this issue.
- addHeader(String, String) - Method in interface org.sonar.api.server.http.HttpResponse
-
Adds a response header with the given name and value.
- addImpact(SoftwareQuality, Severity) - Method in interface org.sonar.api.batch.sensor.issue.NewExternalIssue
-
Add a new impact or override the severity of an impact already defined by the rule.
- addInfoText(String) - Method in class org.sonar.api.utils.ValidationMessages
- addInputFileEdit(NewInputFileEdit) - Method in interface org.sonar.api.batch.sensor.issue.fix.NewQuickFix
-
Add a new input file edit to this quick fix
- 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, 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, 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, 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, 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
- addOwaspAsvs(RulesDefinition.OwaspAsvsVersion, String...) - Method in class org.sonar.api.server.rule.RulesDefinition.NewRule
- addOwaspTop10(RulesDefinition.OwaspTop10...) - Method in class org.sonar.api.server.rule.RulesDefinition.NewRule
-
Deprecated.since 9.3 Supports only OWASP Top 10 2017 standard, use addOwaspTop10(OwaspTop10Version, OwaspTop10...) for 2017,2021...
- addOwaspTop10(RulesDefinition.OwaspTop10Version, 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.
- addPciDss(RulesDefinition.PciDssVersion, String...) - Method in class org.sonar.api.server.rule.RulesDefinition.NewRule
- addQuickFix(NewQuickFix) - Method in interface org.sonar.api.batch.sensor.issue.NewIssue
-
Add a new quick fix to this issue.
- 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
- addTests(File...) - Method in class org.sonar.api.batch.bootstrap.ProjectDefinition
-
Deprecated.
- addTests(String...) - Method in class org.sonar.api.batch.bootstrap.ProjectDefinition
-
Deprecated.
- addTextEdit(NewTextEdit) - Method in interface org.sonar.api.batch.sensor.issue.fix.NewInputFileEdit
-
Add a text edit to this input file edit
- 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
- 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
- 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
-
Deprecated.All the supported severity values, ordered from
Severity.INFO
toSeverity.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
- ANALYSIS_FROM_SONARQUBE_9_4 - Static variable in class org.sonar.api.measures.CoreMetrics
- ANALYSIS_FROM_SONARQUBE_9_4_KEY - Static variable in class org.sonar.api.measures.CoreMetrics
- AnalysisError - Interface in org.sonar.api.batch.sensor.error
-
Represents an analysis error, such as a parsing error, reported by a
Sensor
. - 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
- AnnotationUtils - Class in org.sonar.api.utils
-
A utility class for annotations
- ANYONE - Static variable in class org.sonar.api.security.DefaultGroups
- APP - org.sonar.api.web.page.Page.Qualifier
- APP - Static variable in class org.sonar.api.resources.Qualifiers
-
Application portfolios.
- apply(InputFile) - Method in interface org.sonar.api.batch.fs.FilePredicate
-
Test if provided file is valid for this predicate
- ASCENDING - Static variable in class org.sonar.api.server.ws.WebService.Param
- ASSESS_THE_PROBLEM_SECTION_KEY - Static variable in class org.sonar.api.server.rule.RuleDescriptionSection.RuleDescriptionSectionKeys
- assignee() - Method in interface org.sonar.api.issue.Issue
-
UUID of the user who is assigned to this issue.
- 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.fix.NewTextEdit
- 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
-
Deprecated.since 9.4, attribute was already not returning any element since 5.2
- attributes() - Method in interface org.sonar.api.issue.Issue
-
Deprecated.since 9.4, attribute was already not returning any element since 5.2
- 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.
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
-
Non-null value on
DebtRemediationFunction.Type.LINEAR_OFFSET
andDebtRemediationFunction.Type.CONSTANT_ISSUE
functions, elsenull
. - baseEffort() - Method in class org.sonar.api.server.debt.internal.DefaultDebtRemediationFunction
- BaseIdentityProvider - Interface in org.sonar.api.server.authentication
- BaseIdentityProvider.Context - Interface in org.sonar.api.server.authentication
- begin(String) - Method in class org.sonar.api.utils.text.XmlWriter
- beginArray() - Method in class org.sonar.api.utils.text.JsonWriter
-
Deprecated.Begins encoding a new array.
- beginObject() - Method in class org.sonar.api.utils.text.JsonWriter
-
Deprecated.Begins encoding a new object.
- Beta - Annotation Type in org.sonar.api
-
This annotations marks API as experimental.
- 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.
- BLOCKER - org.sonar.api.batch.rule.Severity
-
Deprecated.
- BLOCKER - org.sonar.api.rules.RulePriority
-
Deprecated.
- BLOCKER - Static variable in class org.sonar.api.rule.Severity
-
Deprecated.
- BLOCKER_VIOLATIONS - Static variable in class org.sonar.api.measures.CoreMetrics
-
Deprecated.since 10.7 as
Severity
is deprecated. No replacement. - BLOCKER_VIOLATIONS_KEY - Static variable in class org.sonar.api.measures.CoreMetrics
-
Deprecated.since 10.7 as
Severity
is deprecated. No replacement. - BOOL - org.sonar.api.measures.Metric.ValueType
- BOOLEAN - org.sonar.api.PropertyType
-
True/False
- BOOLEAN - Static variable in class org.sonar.api.server.rule.RuleParamType
- Branch - Interface in org.sonar.api.ce.posttask
- BRANCH - org.sonar.api.ce.posttask.Branch.Type
- 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
-
Deprecated.
- BUGS - Static variable in class org.sonar.api.measures.CoreMetrics
-
Deprecated.since 10.7. Use
CoreMetrics.RELIABILITY_ISSUES
instead. - BUGS_KEY - Static variable in class org.sonar.api.measures.CoreMetrics
-
Deprecated.since 10.7. Use
CoreMetrics.RELIABILITY_ISSUES_KEY
instead. - 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.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.server.rule.RuleDescriptionSectionBuilder
- 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
-
Deprecated.
- build() - Method in class org.sonar.api.web.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_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 interface org.sonar.api.server.rule.RuleDescriptionSection
- builder() - Static method in class org.sonar.api.user.UserQuery
- builder() - Static method in class org.sonar.api.web.ServletFilter.UrlPattern
-
Deprecated.
- builder() - Static method in class org.sonar.api.web.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(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. - 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.
- canSkipUnchangedFiles() - Method in interface org.sonar.api.batch.sensor.SensorContext
-
In some situations, there is no need to analyze unchanged files, as reported by
InputFile.status()
asInputFile.Status.SAME
, and analyzers can skip reporting any data for those files. - 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_ALM_INTEGRATION - Static variable in interface org.sonar.api.CoreProperties
- CATEGORY_AUDIT_LOGS - Static variable in interface org.sonar.api.CoreProperties
- 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_HOUSEKEEPING - Static variable in interface org.sonar.api.CoreProperties
- 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
- CHANGED - org.sonar.api.batch.fs.InputFile.Status
- 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)
. - cleanCodeAttribute() - Method in interface org.sonar.api.batch.sensor.issue.ExternalIssue
-
Clean Code Attribute of the issue.
- cleanCodeAttribute() - Method in interface org.sonar.api.batch.sensor.rule.AdHocRule
-
Clean Code Attribute of the rule.
- cleanCodeAttribute() - Method in class org.sonar.api.server.rule.internal.DefaultRule
- cleanCodeAttribute() - Method in class org.sonar.api.server.rule.RulesDefinition.Rule
- cleanCodeAttribute(CleanCodeAttribute) - Method in interface org.sonar.api.batch.sensor.issue.NewExternalIssue
-
Attribute of the issue according to Clean Code Taxonomy.
- cleanCodeAttribute(CleanCodeAttribute) - Method in interface org.sonar.api.batch.sensor.rule.NewAdHocRule
-
Clean Code Attribute of the rule.
- CleanCodeAttribute - Enum in org.sonar.api.rules
- CleanCodeAttributeCategory - Enum in org.sonar.api.rules
- CLEAR - org.sonar.api.rules.CleanCodeAttribute
- 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
-
Deprecated.
- 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 - org.sonar.api.batch.sensor.issue.MessageFormatting.Type
- CODE_SMELL - org.sonar.api.rules.RuleType
-
Deprecated.
- CODE_SMELLS - Static variable in class org.sonar.api.measures.CoreMetrics
-
Deprecated.since 10.7. Use
CoreMetrics.MAINTAINABILITY_ISSUES
instead. - CODE_SMELLS_KEY - Static variable in class org.sonar.api.measures.CoreMetrics
-
Deprecated.since 10.7. Use
CoreMetrics.MAINTAINABILITY_ISSUES_KEY
instead. - codeVariants() - Method in interface org.sonar.api.batch.sensor.issue.Issue
- codeVariants() - Method in interface org.sonar.api.issue.Issue
- CODEVIEWER - Static variable in annotation type org.sonar.api.web.UserRole
- 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
- COMMON_PATTERN_FOR_KEYS - Static variable in class org.sonar.api.server.rule.StringPatternValidator
- COMMUNITY - org.sonar.api.SonarEdition
- compareTo(RuleKey) - Method in class org.sonar.api.rule.RuleKey
- compareTo(Node) - Method in class org.sonar.api.utils.dag.Node
- compareTo(Version) - Method in class org.sonar.api.utils.Version
- COMPLETE - org.sonar.api.rules.CleanCodeAttribute
- 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.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 class org.sonar.api.batch.bootstrap.internal.ProjectBuilderContext
-
Deprecated.
- config() - Method in interface org.sonar.api.batch.bootstrap.ProjectBuilder.Context
-
Deprecated.Global config (command line arguments, global scanner properties).
- 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.
- CONFIRM - Static variable in interface org.sonar.api.issue.DefaultTransitions
-
Deprecated.since 10.4, use
DefaultTransitions.ACCEPT
instead - CONFIRMED - org.sonar.api.issue.IssueStatus
-
Deprecated.
- CONFIRMED_ISSUES - Static variable in class org.sonar.api.measures.CoreMetrics
-
Deprecated.since 10.4 as status
Issue.STATUS_CONFIRMED
is deprecated. No replacement. - CONFIRMED_ISSUES_KEY - Static variable in class org.sonar.api.measures.CoreMetrics
-
Deprecated.since 10.4 as status
Issue.STATUS_CONFIRMED
is deprecated. No replacement. - CONSISTENT - org.sonar.api.rules.CleanCodeAttributeCategory
- 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
- contains(String) - Method in interface org.sonar.api.batch.sensor.cache.ReadCache
-
Checks whether the cache contains a key
- contents() - Method in interface org.sonar.api.batch.fs.InputFile
-
Fetches the entire contents of the file, decoding with the
InputFile.charset()
. - context(Context) - Method in class org.sonar.api.server.rule.RuleDescriptionSectionBuilder
-
For context specific descriptions, the context key, must be unique across a given section of a rule.
- Context - Class in org.sonar.api.server.rule
-
Describes the context in which a
RuleDescriptionSection
is defined. - 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) - Constructor for class org.sonar.api.server.rule.Context
- Context(String, String, HttpRequest, HttpServletRequest) - Constructor for class org.sonar.api.security.Authenticator.Context
-
This class is not meant to be instantiated by plugins, except for tests.
- Context(String, HttpRequest, HttpServletRequest) - Constructor for class org.sonar.api.security.ExternalGroupsProvider.Context
-
This class is not meant to be instantiated by plugins, except for tests.
- Context(String, HttpRequest, HttpServletRequest) - Constructor for class org.sonar.api.security.ExternalUsersProvider.Context
-
This class is not meant to be instantiated by plugins, except for tests.
- 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
- CONVENTIONAL - org.sonar.api.rules.CleanCodeAttribute
- convert(Collection<String>) - Static method in class org.sonar.api.server.rule.RuleTagsToTypeConverter
-
Deprecated.
- Converter() - Constructor for class org.sonar.api.utils.KeyValueFormat.Converter
- convertToDeprecatedSeverity(Severity) - Static method in class org.sonar.api.server.rule.internal.ImpactMapper
-
Deprecated.
- convertToImpactSeverity(String) - Static method in class org.sonar.api.server.rule.internal.ImpactMapper
-
Deprecated.
- convertToRuleType(SoftwareQuality) - Static method in class org.sonar.api.server.rule.internal.ImpactMapper
-
Deprecated.
- convertToSoftwareQuality(RuleType) - Static method in class org.sonar.api.server.rule.internal.ImpactMapper
-
Deprecated.
- Cookie - Interface in org.sonar.api.server.http
-
Framework-agnostic definition of a cookie.
- copyFromPrevious(String) - Method in interface org.sonar.api.batch.sensor.cache.WriteCache
-
Copy a cached entry from the previous cache to the new one.
- CORE_ALLOW_PERMISSION_MANAGEMENT_FOR_PROJECT_ADMINS_DEFAULT_VALUE - Static variable in interface org.sonar.api.CoreProperties
- CORE_ALLOW_PERMISSION_MANAGEMENT_FOR_PROJECT_ADMINS_PROPERTY - Static variable in interface org.sonar.api.CoreProperties
- 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
- CoreMetrics - Class in org.sonar.api.measures
- CoreProperties - Interface in org.sonar.api
-
Non-exhaustive list of constants of core properties.
- COVERAGE - Static variable in class org.sonar.api.measures.CoreMetrics
- COVERAGE_KEY - Static variable in class org.sonar.api.measures.CoreMetrics
- 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
- 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(int, int) - Static method in class org.sonar.api.utils.Version
- create(int, int, int) - Static method in class org.sonar.api.utils.Version
- 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
-
Deprecated.Defines only a single inclusion pattern.
- create(String) - Static method in class org.sonar.api.web.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
-
New builder for
BuiltInQualityProfilesDefinition.BuiltInQualityProfile
. - createController(String) - Method in class org.sonar.api.server.ws.WebService.Context
-
Create a new controller.
- createExternalRepository(String, String) - Method in class org.sonar.api.server.impl.RulesDefinitionContext
- 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. - 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
- createRepository(String, String) - Method in class org.sonar.api.server.impl.RulesDefinitionContext
- 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.
- 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
- CRITICAL - org.sonar.api.batch.rule.Severity
-
Deprecated.
- CRITICAL - org.sonar.api.rules.RulePriority
-
Deprecated.
- CRITICAL - Static variable in class org.sonar.api.rule.Severity
-
Deprecated.
- CRITICAL_VIOLATIONS - Static variable in class org.sonar.api.measures.CoreMetrics
-
Deprecated.since 10.7 as
Severity
is deprecated. No replacement. - CRITICAL_VIOLATIONS_KEY - Static variable in class org.sonar.api.measures.CoreMetrics
-
Deprecated.since 10.7 as
Severity
is deprecated. No replacement. - 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.impl.RulesDefinitionContext
- 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
- DATA - org.sonar.api.batch.sensor.issue.NewIssue.FlowType
- DATA - org.sonar.api.measures.Metric.ValueType
- 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
-
Factory of
DebtRemediationFunction
- debug(String) - Method in interface org.sonar.api.utils.log.Logger
-
Deprecated.Logs a DEBUG message.
- debug(String) - Method in class org.sonar.api.utils.log.Slf4jLogger
- debug(String, Object) - Method in interface org.sonar.api.utils.log.Logger
-
Deprecated.Logs an DEBUG parameterized message according to the specified format and argument.
- debug(String, Object) - Method in class org.sonar.api.utils.log.Slf4jLogger
- debug(String, Object...) - Method in interface org.sonar.api.utils.log.Logger
-
Deprecated.Logs an DEBUG parameterized message according to the specified format and arguments.
- debug(String, Object...) - Method in class org.sonar.api.utils.log.Slf4jLogger
- debug(String, Object, Object) - Method in interface org.sonar.api.utils.log.Logger
-
Deprecated.Logs an DEBUG parameterized message according to the specified format and arguments.
- debug(String, Object, Object) - Method in class org.sonar.api.utils.log.Slf4jLogger
- debug(Supplier<String>) - Method in interface org.sonar.api.utils.log.Logger
-
Deprecated.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
-
Deprecated.
- 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.
- DEFAULT - org.sonar.api.batch.Phase.Name
- 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
- defaultCleanCodeAttribute() - Static method in enum org.sonar.api.rules.CleanCodeAttribute
- 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
- defaultImpacts() - Method in interface org.sonar.api.batch.sensor.rule.AdHocRule
-
Default impacts of the rule
- defaultImpacts() - Method in class org.sonar.api.server.rule.internal.DefaultRule
- defaultImpacts() - Method in class org.sonar.api.server.rule.RulesDefinition.Rule
- 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
-
Deprecated.
- defaultStatus() - Static method in enum org.sonar.api.rule.RuleStatus
- 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(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(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
- 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.issue.Issue.Flow
- 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(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(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
- DESELECTED - org.sonar.api.server.ws.WebService.SelectionMode
- destroy() - Method in class org.sonar.api.web.HttpFilter
-
Called by the SonarQube to indicate to a filter that it is being taken out of service.
- DEVELOPER - org.sonar.api.SonarEdition
- DEVELOPER_AGGREGATED_INFO_DISABLED - Static variable in interface org.sonar.api.CoreProperties
- 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
- 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
- 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
- DISTINCT - org.sonar.api.rules.CleanCodeAttribute
- DISTRIB - org.sonar.api.measures.Metric.ValueType
- doAuthenticate(Authenticator.Context) - Method in class org.sonar.api.security.Authenticator
- 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
- doFilter(HttpRequest, HttpResponse) - Method in interface org.sonar.api.web.FilterChain
-
Causes the next filter in the chain to be invoked, or if the calling filter is the last filter in the chain, causes the resource at the end of the chain to be invoked.
- doFilter(HttpRequest, HttpResponse, FilterChain) - Method in class org.sonar.api.web.HttpFilter
-
The
doFilter
method of the Filter is called by the SonarQube each time a request/response pair is passed through the chain due to a client request for a resource at the end of the chain. - doGetAuthenticator() - Method in class org.sonar.api.security.SecurityRealm
- 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.HttpFilter
-
Override to change URL.
- doGetPattern() - Method in class org.sonar.api.web.ServletFilter
-
Deprecated.Override to change URL.
- 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_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_SECURITY_REVIEW - Static variable in class org.sonar.api.measures.CoreMetrics
- 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
- Durations - Class in org.sonar.api.utils
- Durations() - Constructor for class org.sonar.api.utils.Durations
E
- educationPrincipleKeys() - Method in class org.sonar.api.server.rule.internal.DefaultRule
- educationPrincipleKeys() - Method in class org.sonar.api.server.rule.RulesDefinition.Rule
- EFFICIENT - org.sonar.api.rules.CleanCodeAttribute
- effort() - Method in interface org.sonar.api.ce.measure.Issue
- 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
- email() - Method in interface org.sonar.api.user.User
- EMAIL - org.sonar.api.PropertyType
-
Email address
- 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 methodsRequest.Param.getValue()
andRequest.Param.or(Supplier)
will returnnull
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()
. - 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 interface org.sonar.api.batch.sensor.issue.MessageFormatting
-
The index of the last character in the string that will be formatted
- end() - Method in class org.sonar.api.utils.text.XmlWriter
- end(int) - Method in interface org.sonar.api.batch.sensor.issue.NewMessageFormatting
- end(String) - Method in class org.sonar.api.utils.text.XmlWriter
-
Same as
XmlWriter.end()
. - endArray() - Method in class org.sonar.api.utils.text.JsonWriter
-
Deprecated.Ends encoding the current array.
- endObject() - Method in class org.sonar.api.utils.text.JsonWriter
-
Deprecated.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.config.Category
- equals(Object) - Method in class org.sonar.api.measures.Metric
- equals(Object) - Method in class org.sonar.api.profiles.ProfileExporter
-
Deprecated.
- equals(Object) - Method in class org.sonar.api.profiles.ProfileImporter
-
Deprecated.
- 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.utils.dag.Node
- equals(Object) - Method in class org.sonar.api.utils.Duration
- equals(Object) - Method in class org.sonar.api.utils.Version
- error(String) - Method in interface org.sonar.api.utils.log.Logger
-
Deprecated.Logs an ERROR level message.
- error(String) - Method in class org.sonar.api.utils.log.Slf4jLogger
- error(String, Object) - Method in interface org.sonar.api.utils.log.Logger
-
Deprecated.Logs an ERROR parameterized message according to the specified format and argument.
- error(String, Object) - Method in class org.sonar.api.utils.log.Slf4jLogger
- error(String, Object...) - Method in interface org.sonar.api.utils.log.Logger
-
Deprecated.Logs a ERROR parameterized message according to the specified format and arguments.
- error(String, Object...) - Method in class org.sonar.api.utils.log.Slf4jLogger
- error(String, Object, Object) - Method in interface org.sonar.api.utils.log.Logger
-
Deprecated.Logs a ERROR parameterized message according to the specified format and arguments.
- error(String, Object, Object) - Method in class org.sonar.api.utils.log.Slf4jLogger
- error(String, Throwable) - Method in interface org.sonar.api.utils.log.Logger
-
Deprecated.Logs an exception at the ERROR level with an accompanying message.
- error(String, Throwable) - Method in class org.sonar.api.utils.log.Slf4jLogger
- 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.utils.log.LoggerLevel
-
Deprecated.
- exampleValue() - Method in class org.sonar.api.server.ws.WebService.Param
- 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(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
- EXECUTION - org.sonar.api.batch.sensor.issue.NewIssue.FlowType
- exportProfile(RulesProfile, Writer) - Method in class org.sonar.api.profiles.ProfileExporter
-
Deprecated.Export activated rule from a quality profile to a writer Note that the quality profile can contain some rules from other plugins.
- 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).
- 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
- FALSE_POSITIVE - org.sonar.api.issue.IssueStatus
- 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
- 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
-
Deprecated.
- 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, andInputFile.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
- 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).
- filenamePatterns() - Method in interface org.sonar.api.resources.Language
-
Provide a list of patterns following the
WildcardPattern
syntax. - 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 withInputFile
- 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
- FilterableIssue - Interface in org.sonar.api.scan.issue.filter
-
Deprecated.since 7.6
- FilterChain - Interface in org.sonar.api.web
-
Filters use the FilterChain to invoke the next filter in the chain, or if the calling filter is the last filter in the chain, to invoke the resource at the end of the chain.
- find(RuleKey) - Method in interface org.sonar.api.batch.rule.ActiveRules
-
Find a
ActiveRule
by the associated rule 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(List<String>) - Method in interface org.sonar.api.batch.measure.MetricFinder
- findAll(RuleQuery) - Method in interface org.sonar.api.rules.RuleFinder
- findByInternalKey(String, String) - Method in interface org.sonar.api.batch.rule.ActiveRules
-
Find a
ActiveRule
by the associated internal key. - findByKey(String) - Method in interface org.sonar.api.batch.measure.MetricFinder
- 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
- 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.in 8.0. Implement
PostProjectAnalysisTask.finished(Context)
instead - FIXED - org.sonar.api.issue.IssueStatus
- FLOAT - org.sonar.api.measures.Metric.ValueType
- FLOAT - org.sonar.api.PropertyType
-
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.
- FOCUSED - org.sonar.api.rules.CleanCodeAttribute
- forCssClass(String) - Static method in enum org.sonar.api.batch.sensor.highlighting.TypeOfText
- forkDate(String, Path) - Method in class org.sonar.api.batch.scm.ScmProvider
-
Deprecated.Not used anymore since 9.3
- format(String, Object...) - Method in class org.sonar.api.utils.LocalizedMessages
- 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!
- 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!
- formatDateTimeNullSafe(Date) - Static method in class org.sonar.api.utils.DateUtils
-
Warning: relies on default timezone!
- 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
- 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
- FORMATTED - org.sonar.api.rules.CleanCodeAttribute
- FORMATTED_TEXT - org.sonar.api.PropertyType
-
Custom formatted text type
- 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)
andNewExternalIssue.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
-
Non-null value on
DebtRemediationFunction.Type.LINEAR
andDebtRemediationFunction.Type.LINEAR_OFFSET
functions, elsenull
. - 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
- get() - Method in class org.sonar.api.batch.bootstrap.ProjectReactor
-
Deprecated.
- get(Class<?>) - Static method in class org.sonar.api.utils.log.Loggers
-
Deprecated.
- 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.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
-
Deprecated.
- 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
- getAllPropertiesSetInEnv() - Method in class org.sonar.api.config.PropertyDefinitions
- getAnalysis() - Method in interface org.sonar.api.ce.posttask.PostProjectAnalysisTask.ProjectAnalysis
-
Analysis containing the UUID of the analysis and the date
- 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.
- getArguments() - Method in class org.sonar.api.utils.command.Command
- getAttributeCategory() - Method in enum org.sonar.api.rules.CleanCodeAttribute
- 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.
- getBestImpactForBackmapping(Map<SoftwareQuality, Severity>) - Static method in class org.sonar.api.server.rule.internal.ImpactMapper
-
Deprecated.This method is needed for picking the best impact on which we are going to base backmapping (getting type and severity from impact).
- 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.
- 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.
- 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.
- 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.
- getColorName() - Method in enum org.sonar.api.measures.Metric.Level
- 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.
- 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
- getContext() - Method in interface org.sonar.api.server.rule.RuleDescriptionSection
- getContextPath() - Method in class org.sonar.api.platform.Server
-
Context path of web server.
- getContextPath() - Method in interface org.sonar.api.server.http.HttpRequest
-
Returns the portion of the request URI that indicates the context of the request.
- getCookies() - Method in interface org.sonar.api.server.http.HttpRequest
-
Returns an array containing all of the
Cookie
objects the client sent with this request. - 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(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
-
Deprecated.
- getDecimalScale() - Method in class org.sonar.api.measures.Metric
-
Return the number scale if metric type is
Metric.ValueType.FLOAT
, elsenull
- getDefaultProfile() - Method in class org.sonar.api.profiles.RulesProfile
- 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
- getDefaultValueAsBoolean() - Method in class org.sonar.api.rules.RuleParam
- getDefaultValueAsInteger() - Method in class org.sonar.api.rules.RuleParam
- 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
- getDeprecatedKeys() - Method in class org.sonar.api.batch.rule.LoadedActiveRule
- 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
- 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
- getDisplayName() - Method in class org.sonar.api.server.rule.Context
- 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.
- getEdition() - Method in interface org.sonar.api.SonarRuntime
-
The SonarQube/SonarCloud edition being executed at runtime.
- 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
- getEndLine() - Method in class org.sonar.api.batch.sensor.cpd.internal.TokensLine
-
Same as
TokensLine.getStartLine()
- 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. - getExecutable() - Method in class org.sonar.api.utils.command.Command
- getExtensions() - Method in class org.sonar.api.Plugin.Context
- getFields(Class, boolean) - Static method in class org.sonar.api.utils.FieldUtils2
-
Get accessible
Field
breaking scope if requested. - getFileAttributes() - Method in interface org.sonar.api.ce.measure.Component
-
The attributes of the Component if it's type is File.
- getFileName() - Method in class org.sonar.api.server.ws.impl.PartImpl
- 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
-
Filename extensions, without the dot.
- 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
. - 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.http.HttpRequest
-
Returns the value of the specified request header as a String.
- getHeader(String) - Method in interface org.sonar.api.server.http.HttpResponse
-
Gets the value of the response header with the given name.
- 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.http.HttpRequest
- 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
- getHeaders(String) - Method in interface org.sonar.api.server.http.HttpRequest
-
Returns all the values of the specified request header as an Enumeration of String objects.
- getHeaders(String) - Method in interface org.sonar.api.server.http.HttpResponse
-
Gets the values of the response header with the given name.
- 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
- getHtmlContent() - Method in interface org.sonar.api.server.rule.RuleDescriptionSection
- getHttpRequest() - Method in class org.sonar.api.security.Authenticator.Context
- getHttpRequest() - Method in class org.sonar.api.security.ExternalGroupsProvider.Context
- getHttpRequest() - Method in class org.sonar.api.security.ExternalUsersProvider.Context
- getHttpRequest() - Method in interface org.sonar.api.server.authentication.BaseIdentityProvider.Context
-
Get the received HTTP request.
- getHttpRequest() - Method in interface org.sonar.api.server.authentication.OAuth2IdentityProvider.OAuth2Context
-
Get the received HTTP request.
- getHttpResponse() - Method in interface org.sonar.api.server.authentication.BaseIdentityProvider.Context
-
Get the HTTP response to send.
- getHttpResponse() - Method in interface org.sonar.api.server.authentication.OAuth2IdentityProvider.OAuth2Context
-
Get the HTTP response to send.
- 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.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
-
Deprecated.since 8.4. Use
Rule.ruleKey()
instead - getId() - Method in class org.sonar.api.rules.RuleParam
- 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
. - getInputStream() - Method in class org.sonar.api.server.ws.impl.PartImpl
- 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.
- getIssues() - Method in interface org.sonar.api.ce.measure.MeasureComputer.MeasureComputerContext
-
Return list of all issues (open, closed, etc.) of current component.
- getKey() - Method in class org.sonar.api.batch.bootstrap.ProjectDefinition
-
Deprecated.
- getKey() - Method in interface org.sonar.api.ce.measure.Component
- 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.profiles.ProfileExporter
-
Deprecated.
- getKey() - Method in class org.sonar.api.profiles.ProfileImporter
-
Deprecated.
- 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 interface org.sonar.api.server.authentication.IdentityProvider
-
Unique key of provider, for example "github".
- getKey() - Method in class org.sonar.api.server.rule.Context
- getKey() - Method in interface org.sonar.api.server.rule.RuleDescriptionSection
- 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
- getLanguageKey() - Method in interface org.sonar.api.ce.measure.Component.FileAttributes
- 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
-
Deprecated.
- getLevel() - Method in class org.sonar.api.utils.log.Slf4jLogger
- getLocale() - Method in class org.sonar.api.utils.LocalizedMessages
- getLogin() - Method in class org.sonar.api.platform.NewUserHandler.Context
- getLogin() - Method in class org.sonar.api.server.authentication.UserIdentity
-
Deprecated.since 8.0, should not be used as it is internal managed field
- getLogStatistics() - Method in interface org.sonar.api.ce.posttask.PostProjectAnalysisTask.Context
- 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.
- getMaxAge() - Method in interface org.sonar.api.server.http.Cookie
-
Gets the maximum age in seconds of this Cookie.
- getMeasure(String) - Method in interface org.sonar.api.ce.measure.MeasureComputer.MeasureComputerContext
-
Returns the measure from a given metric on the current component.
- 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.http.HttpRequest
-
Returns the name of the HTTP method with which this request was made, for example, GET, POST, or PUT.
- 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
-
Deprecated.
- 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.measures.Metric
- getName() - Method in class org.sonar.api.platform.NewUserHandler.Context
- getName() - Method in class org.sonar.api.profiles.ProfileExporter
-
Deprecated.
- getName() - Method in class org.sonar.api.profiles.ProfileImporter
-
Deprecated.
- 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.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 interface org.sonar.api.server.http.Cookie
-
Returns the name of the cookie.
- getName() - Method in class org.sonar.api.web.page.Page
- getNewKey(String) - Method in class org.sonar.api.config.PropertyDefinitions
- getNewValue() - Method in class org.sonar.api.config.GlobalPropertyChangeHandler.PropertyChange
- 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.since 7.7, use
ProjectDefinition.getOriginalProjectVersion()
instead - 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
. - getOutputStream() - Method in interface org.sonar.api.server.http.HttpResponse
-
Returns a
OutputStream
suitable for writing binary data in the response. - getOverriddenParams() - Method in class org.sonar.api.server.profile.BuiltInQualityProfilesDefinition.NewBuiltInActiveRule
- getOverriddenSeverity() - Method in class org.sonar.api.rules.ActiveRule
-
Deprecated.since 6.6, internal usage only
- 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
- getParameter(String) - Method in class org.sonar.api.rules.ActiveRule
- getParameter(String) - Method in interface org.sonar.api.server.http.HttpRequest
-
Returns the value of a request parameter as a String, or null if the parameter does not exist.
- getParameterMap() - Method in interface org.sonar.api.server.ws.LocalConnector.LocalRequest
- getParameterValues(String) - Method in interface org.sonar.api.server.http.HttpRequest
-
Returns an array containing all the values the given request parameter has, or null if the parameter does not exist.
- 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()
- 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.http.Cookie
-
Returns the path on the server to which the browser returns this cookie.
- 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
- 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
- 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 interface org.sonar.api.ce.posttask.ScannerContext
- 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).
- getQueryString() - Method in interface org.sonar.api.server.http.HttpRequest
-
Returns the query string that is contained in the request URL after the path.
- getReader() - Method in interface org.sonar.api.server.http.HttpRequest
-
Retrieves the body of the request as character data using a
BufferedReader
. - getReader() - Method in class org.sonar.api.server.ws.Request
- getRemoteAddr() - Method in interface org.sonar.api.server.http.HttpRequest
-
Returns the Internet Protocol (IP) address of the client or last proxy that sent the 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
-
Deprecated, for removal: This API element is subject to removal in a future version.since 9.16. Use
Authenticator.Context.getHttpRequest()
instead. - getRequest() - Method in class org.sonar.api.security.ExternalGroupsProvider.Context
-
Deprecated, for removal: This API element is subject to removal in a future version.since 9.16. Use
ExternalGroupsProvider.Context.getHttpRequest()
instead. - getRequest() - Method in class org.sonar.api.security.ExternalUsersProvider.Context
-
Deprecated, for removal: This API element is subject to removal in a future version.since 9.16. Use
ExternalUsersProvider.Context.getHttpRequest()
instead. - getRequest() - Method in interface org.sonar.api.server.authentication.BaseIdentityProvider.Context
-
Deprecated, for removal: This API element is subject to removal in a future version.since 9.16. Use
BaseIdentityProvider.Context.getHttpRequest()
instead. - getRequest() - Method in interface org.sonar.api.server.authentication.OAuth2IdentityProvider.OAuth2Context
-
Deprecated, for removal: This API element is subject to removal in a future version.since 9.16. Use
OAuth2IdentityProvider.OAuth2Context.getHttpRequest()
instead. - getRequestURI() - Method in interface org.sonar.api.server.http.HttpRequest
-
Returns the part of this request's URL from the protocol name up to the query string in the first line of the HTTP request.
- getRequestURL() - Method in interface org.sonar.api.server.http.HttpRequest
-
Returns the URL the client used to make the request.
- getResource(String) - Method in class org.sonar.api.utils.System2
- getResponse() - Method in interface org.sonar.api.server.authentication.BaseIdentityProvider.Context
-
Deprecated, for removal: This API element is subject to removal in a future version.since 9.16. Use
BaseIdentityProvider.Context.getHttpResponse()
instead. - getResponse() - Method in interface org.sonar.api.server.authentication.OAuth2IdentityProvider.OAuth2Context
-
Deprecated, for removal: This API element is subject to removal in a future version.since 9.16. Use
OAuth2IdentityProvider.OAuth2Context.getHttpResponse()
instead. - 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.
- 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)
. - getScheme() - Method in interface org.sonar.api.server.http.HttpRequest
-
Returns the name of the scheme used to make this request, for example, http, https, or ftp.
- 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
- getServerName() - Method in interface org.sonar.api.server.http.HttpRequest
-
Returns the host name of the server to which the request was sent.
- getServerPort() - Method in interface org.sonar.api.server.http.HttpRequest
-
Returns the port number to which the request was sent.
- getServletPath() - Method in interface org.sonar.api.server.http.HttpRequest
-
Returns the part of this request's URL that calls the servlet.
- getSettings() - Method in interface org.sonar.api.ce.measure.MeasureComputer.MeasureComputerContext
-
Returns settings of the current component.
- 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
-
Deprecated.since 10.0. The name is confusing: the API version is different from the SonarQube version since the extraction. Use the advised replacement
- getSonarQubeVersion() - Method in class org.sonar.api.Plugin.Context
-
Deprecated.since 10.0. The name is confusing: the API version is different from the SonarQube version since the extraction. Use the advised replacement
- 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.http.HttpResponse
-
Gets the current status code of this response.
- 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.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 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.
- getSubCategory(String) - Method in class org.sonar.api.config.PropertyDefinitions
- 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
-
Deprecated.
- getSupportedLanguages() - Method in class org.sonar.api.profiles.ProfileImporter
-
Deprecated.
- 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
- getTemplateRuleKey() - Method in class org.sonar.api.batch.rule.LoadedActiveRule
- getType() - Method in interface org.sonar.api.ce.measure.Component
- 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.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
- 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
-
Deprecated.since 9.1. There is no replacement
- 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.
- getUuid() - Method in class org.sonar.api.measures.Metric
-
For internal use only
- 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.http.Cookie
-
Gets the current value of this Cookie.
- getValue() - Method in interface org.sonar.api.server.ws.Request.Param
- getValueFromEnv(String) - Method in class org.sonar.api.config.PropertyDefinitions
- getVersion() - Method in class org.sonar.api.batch.bootstrap.ProjectDefinition
-
Deprecated.since 7.7, use
ProjectDefinition.getProjectVersion()
instead - 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
- getWorkDir() - Method in class org.sonar.api.batch.bootstrap.ProjectDefinition
-
Deprecated.
- getWorstValue() - Method in class org.sonar.api.measures.Metric
- getWriter() - Method in interface org.sonar.api.server.http.HttpResponse
-
Returns a
PrintWriter
object that can send character text to the client. - global() - Method in interface org.sonar.api.batch.sensor.SensorDescriptor
-
Deprecated.since 7.6 change your
Sensor
to aProjectSensor
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_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
- 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()
- 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.config.Category
- hashCode() - Method in class org.sonar.api.measures.Metric
- hashCode() - Method in class org.sonar.api.profiles.ProfileExporter
-
Deprecated.
- hashCode() - Method in class org.sonar.api.profiles.ProfileImporter
-
Deprecated.
- 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.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)
, elseFilePredicates.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.
- 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.
- HIGH - org.sonar.api.issue.impact.Severity
- HIGH_IMPACT_ACCEPTED_ISSUES - Static variable in class org.sonar.api.measures.CoreMetrics
-
Deprecated.since 10.6
- HIGH_IMPACT_ACCEPTED_ISSUES_KEY - Static variable in class org.sonar.api.measures.CoreMetrics
-
Deprecated.since 10.6
- 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(TextRange, TypeOfText) - Method in interface org.sonar.api.batch.sensor.highlighting.NewHighlighting
-
Call this method to indicate the type of text in a range.
- HOUR - Static variable in class org.sonar.api.utils.Duration
- HOW_TO_FIX_SECTION_KEY - Static variable in class org.sonar.api.server.rule.RuleDescriptionSection.RuleDescriptionSectionKeys
- htmlClasspathResourceUrl(URL) - Method in class org.sonar.api.server.rule.RuleDescriptionSectionBuilder
-
The classpath URL of the resource containing the rule section content in HTML format.
- htmlContent(String) - Method in class org.sonar.api.server.rule.RuleDescriptionSectionBuilder
-
The content, in HTML format
- 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
- HttpFilter - Class in org.sonar.api.web
-
A filter is an object that performs filtering tasks on either the request to a resource (a servlet or static content), or on the response from a resource, or both.
- HttpFilter() - Constructor for class org.sonar.api.web.HttpFilter
- HttpRequest - Interface in org.sonar.api.server.http
-
Framework-agnostic definition of an HTTP request.
- HttpResponse - Interface in org.sonar.api.server.http
-
Framework-agnostic definition of an HTTP response.
I
- IDENTIFIABLE - org.sonar.api.rules.CleanCodeAttribute
- 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
- ImpactMapper - Class in org.sonar.api.server.rule.internal
-
Deprecated.since 10.1 This is only used for mapping deprecated types and severities until they are removed
- impacts() - Method in interface org.sonar.api.batch.sensor.issue.ExternalIssue
-
Impacts of the issue.
- impacts() - Method in interface org.sonar.api.ce.measure.Issue
- importProfile(Reader, ValidationMessages) - Method in class org.sonar.api.profiles.ProfileImporter
-
Deprecated.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
- 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
. - info(String) - Method in interface org.sonar.api.utils.log.Logger
-
Deprecated.Logs an INFO level message.
- info(String) - Method in class org.sonar.api.utils.log.Slf4jLogger
- info(String, Object) - Method in interface org.sonar.api.utils.log.Logger
-
Deprecated.Logs an INFO parameterized message according to the specified format and argument.
- info(String, Object) - Method in class org.sonar.api.utils.log.Slf4jLogger
- info(String, Object...) - Method in interface org.sonar.api.utils.log.Logger
-
Deprecated.Logs an INFO parameterized message according to the specified format and arguments.
- info(String, Object...) - Method in class org.sonar.api.utils.log.Slf4jLogger
- info(String, Object, Object) - Method in interface org.sonar.api.utils.log.Logger
-
Deprecated.Logs an INFO parameterized message according to the specified format and arguments.
- info(String, Object, Object) - Method in class org.sonar.api.utils.log.Slf4jLogger
- INFO - org.sonar.api.batch.rule.Severity
-
Deprecated.
- 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
-
Deprecated.
- INFO - Static variable in class org.sonar.api.rule.Severity
-
Deprecated.
- INFO_VIOLATIONS - Static variable in class org.sonar.api.measures.CoreMetrics
-
Deprecated.since 10.7 as
Severity
is deprecated. No replacement. - INFO_VIOLATIONS_KEY - Static variable in class org.sonar.api.measures.CoreMetrics
-
Deprecated.since 10.7 as
Severity
is deprecated. No replacement. - INHERITED - Static variable in class org.sonar.api.rules.ActiveRule
- init() - Method in class org.sonar.api.security.SecurityRealm
-
Invoked during server startup and can be used to initialize internal state.
- init() - Method in class org.sonar.api.web.HttpFilter
-
This method is called exactly once after instantiating the filter.
- 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.
- 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
-
Status regarding previous analysis
- InputFile.Type - Enum in org.sonar.api.batch.fs
- InputFileEdit - Interface in org.sonar.api.batch.sensor.issue.fix
- inputFileEdits() - Method in interface org.sonar.api.batch.sensor.issue.fix.QuickFix
-
Create a new input file edit
- 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
- INSTANCE - Static variable in annotation type org.sonarsource.api.sonarlint.SonarLintSide
-
The component will be instantiated once and reused by all analyses, as long as SonarLint is active in the IDE.
- 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
- INT - org.sonar.api.measures.Metric.ValueType
- INTEGER - org.sonar.api.PropertyType
-
Integer value, positive or negative
- INTEGER - Static variable in class org.sonar.api.server.rule.RuleParamType
- INTENTIONAL - org.sonar.api.rules.CleanCodeAttributeCategory
- 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
- INTRODUCTION_SECTION_KEY - Static variable in class org.sonar.api.server.rule.RuleDescriptionSection.RuleDescriptionSectionKeys
- is(File) - Method in interface org.sonar.api.batch.fs.FilePredicates
-
Warning - may not be supported in SonarLint
- isAdmin() - Method in class org.sonar.api.web.page.Page
- isAnyone(String) - Static method in class org.sonar.api.security.DefaultGroups
- isCacheEnabled() - Method in interface org.sonar.api.batch.sensor.SensorContext
-
Returns true if caching is enabled.
- 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
-
Deprecated.
- isDebugEnabled() - Method in class org.sonar.api.utils.log.Profiler
- isDebugEnabled() - Method in class org.sonar.api.utils.log.Slf4jLogger
- 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
- 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. - 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 ?
- 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.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
- isHttpOnly() - Method in interface org.sonar.api.server.http.Cookie
-
Checks whether this Cookie has been marked as HttpOnly.
- 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 ?
- isMain() - Method in interface org.sonar.api.ce.posttask.Branch
- 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
- 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
- isQualifierPresent(String) - Method in class org.sonar.api.resources.ResourceTypes
- isQuickFixAvailable() - Method in interface org.sonar.api.batch.sensor.issue.Issue
-
Is there a QuickFix available in SonarLint for this issue
- isRequired() - Method in class org.sonar.api.server.ws.WebService.Param
-
Is the parameter required or optional ?
- isSecure() - Method in interface org.sonar.api.server.http.Cookie
-
Returns
true
if the browser is sending cookies only over a secure protocol, orfalse
if the browser can send cookies using any protocol. - isSecure() - Method in interface org.sonar.api.server.http.HttpRequest
-
Returns a boolean indicating whether this request was made using a secure channel, such as 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.Flow - Interface in org.sonar.api.batch.sensor.issue
- 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.
- IssueLocation - Interface in org.sonar.api.batch.sensor.issue
-
Represents an issue location.
- issueStatus() - Method in interface org.sonar.api.ce.measure.Issue
- IssueStatus - Enum in org.sonar.api.issue
- isTemplate() - Method in class org.sonar.api.rules.Rule
- isTraceEnabled() - Method in interface org.sonar.api.utils.log.Logger
-
Deprecated.
- isTraceEnabled() - Method in class org.sonar.api.utils.log.Profiler
- isTraceEnabled() - Method in class org.sonar.api.utils.log.Slf4jLogger
- isUnitTest() - Method in interface org.sonar.api.ce.measure.Component.FileAttributes
- 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
- isValid(String) - Method in class org.sonar.api.server.rule.StringPatternValidator
J
- JSON - org.sonar.api.PropertyType
-
JSON property type
- JsonWriter - Class in org.sonar.api.utils.text
-
Deprecated.since 8.3 this utility class will be moved out of the API. Use your own JSON dependency if you need to write JSON from your plugin
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.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.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 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
- 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 enum org.sonar.api.server.rule.RulesDefinition.CweVersion
-
Deprecated.
- label() - Method in enum org.sonar.api.server.rule.RulesDefinition.OwaspAsvsVersion
- label() - Method in enum org.sonar.api.server.rule.RulesDefinition.OwaspTop10Version
- label() - Method in enum org.sonar.api.server.rule.RulesDefinition.PciDssVersion
- 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_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
- LAWFUL - org.sonar.api.rules.CleanCodeAttribute
- LESS_THAN - org.sonar.api.ce.posttask.QualityGate.Operator
- LEVEL - org.sonar.api.measures.Metric.ValueType
- 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.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 - 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
- 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, InputStream, String) - Method in class org.sonar.api.server.rule.RulesDefinitionXmlLoader
-
Deprecated.Loads rules by reading the XML input stream.
- load(RulesDefinition.NewRepository, InputStream, Charset) - Method in class org.sonar.api.server.rule.RulesDefinitionXmlLoader
-
Deprecated.
- load(RulesDefinition.NewRepository, Reader) - Method in class org.sonar.api.server.rule.RulesDefinitionXmlLoader
-
Deprecated.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
- localConnector() - Method in class org.sonar.api.server.ws.impl.ValidatingRequest
- 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 interface org.sonar.api.utils.log.Logger
-
Deprecated.
- Logger - Interface in org.sonar.api.utils.log
-
Deprecated.since 9.15 in favor of
Logger
- LoggerLevel - Enum in org.sonar.api.utils.log
-
Deprecated.since 9.15 in favor of
Level
- Loggers - Class in org.sonar.api.utils.log
-
Deprecated.since 9.15 in favor of
LoggerFactory
- Loggers() - Constructor for class org.sonar.api.utils.log.Loggers
-
Deprecated.
- LOGICAL - org.sonar.api.rules.CleanCodeAttribute
- login() - Method in interface org.sonar.api.user.User
- LOGIN - Static variable in interface org.sonar.api.CoreProperties
- 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
- longToDate(Long) - Static method in class org.sonar.api.utils.DateUtils
- LOW - org.sonar.api.issue.impact.Severity
M
- MAIN - org.sonar.api.batch.fs.InputFile.Type
- MAIN - org.sonar.api.rule.RuleScope
- MAINTAINABILITY - org.sonar.api.issue.impact.SoftwareQuality
- MAINTAINABILITY_ISSUES - Static variable in class org.sonar.api.measures.CoreMetrics
-
This metric relates to issues with the software quality set as 'Maintainability'.
- MAINTAINABILITY_ISSUES_KEY - Static variable in class org.sonar.api.measures.CoreMetrics
- major() - Method in class org.sonar.api.utils.Version
- MAJOR - org.sonar.api.batch.rule.Severity
-
Deprecated.
- MAJOR - org.sonar.api.rules.RulePriority
-
Deprecated.
- MAJOR - Static variable in class org.sonar.api.rule.Severity
-
Deprecated.
- MAJOR_VIOLATIONS - Static variable in class org.sonar.api.measures.CoreMetrics
-
Deprecated.since 10.7 as
Severity
is deprecated. No replacement. - MAJOR_VIOLATIONS_KEY - Static variable in class org.sonar.api.measures.CoreMetrics
-
Deprecated.since 10.7 as
Severity
is deprecated. No replacement. - 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
- markAsUnchanged(InputFile) - Method in interface org.sonar.api.batch.sensor.SensorContext
-
Marks a file as not having any data changed since the last analysis, including issues.
- markdownDescription() - Method in class org.sonar.api.server.rule.internal.DefaultRule
-
Deprecated, for removal: This API element is subject to removal in a future version.since 9.6 markdown support fur rule descriptions will be dropped
- markdownDescription() - Method in class org.sonar.api.server.rule.RulesDefinition.Rule
-
Deprecated, for removal: This API element is subject to removal in a future version.since 9.6. Use html format instead
- 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.
- 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)
- md5Hash() - Method in interface org.sonar.api.batch.fs.InputFile
-
Hexadecimal MD5 digest of the file's content as it is returned by
InputFile.contents()
andInputFile.inputStream()
, without BOM (byte order mark) if there is one. - 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
- MEDIUM - org.sonar.api.issue.impact.Severity
- merge(Metric) - Method in class org.sonar.api.measures.Metric
-
Merge with fields from other metric.
- 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.fix.QuickFix
- 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(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.fix.NewQuickFix
-
Define the message for this quick fix, which will be shown to the user as an action item.
- message(String) - Method in interface org.sonar.api.batch.sensor.issue.NewIssueLocation
-
Optional, but recommended, plain-text message for this location.
- message(String, List<NewMessageFormatting>) - Method in interface org.sonar.api.batch.sensor.issue.NewIssueLocation
-
Optional, message that can be formatted on the frontend.
Formats like Markdown or HTML are not supported. - 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
- MessageFormatting - Interface in org.sonar.api.batch.sensor.issue
-
Represents the data of the formatted part of the text in the issue message
- MessageFormatting.Type - Enum in org.sonar.api.batch.sensor.issue
- messageFormattings() - Method in interface org.sonar.api.batch.sensor.issue.IssueLocation
- 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.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
- 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
-
Deprecated.
- MINOR - org.sonar.api.rules.RulePriority
-
Deprecated.
- MINOR - Static variable in class org.sonar.api.rule.Severity
-
Deprecated.
- MINOR_VIOLATIONS - Static variable in class org.sonar.api.measures.CoreMetrics
-
Deprecated.since 10.7 as
Severity
is deprecated. No replacement. - MINOR_VIOLATIONS_KEY - Static variable in class org.sonar.api.measures.CoreMetrics
-
Deprecated.since 10.7 as
Severity
is deprecated. No replacement. - MINUTE - Static variable in class org.sonar.api.utils.Duration
- MODULAR - org.sonar.api.rules.CleanCodeAttribute
- 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 - Static variable in annotation type org.sonarsource.api.sonarlint.SonarLintSide
-
The component will be instantiated when a module is opened and kept alive until the module is closed.
- 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.impl.ValidatingRequest
- 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
-
Deprecated.since 9.0 use
SonarLintSide.INSTANCE
as a direct replacement - 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
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.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
-
Deprecated.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
-
Deprecated.
- 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
- NEW_ACCEPTED_ISSUES - Static variable in class org.sonar.api.measures.CoreMetrics
- NEW_ACCEPTED_ISSUES_KEY - Static variable in class org.sonar.api.measures.CoreMetrics
- NEW_BLOCKER_VIOLATIONS - Static variable in class org.sonar.api.measures.CoreMetrics
-
Deprecated.since 10.7 as
Severity
is deprecated. No replacement. - NEW_BLOCKER_VIOLATIONS_KEY - Static variable in class org.sonar.api.measures.CoreMetrics
-
Deprecated.since 10.7 as
Severity
is deprecated. No replacement. - 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
-
Deprecated.since 10.7. Use
CoreMetrics.NEW_RELIABILITY_ISSUES
instead. - NEW_BUGS_KEY - Static variable in class org.sonar.api.measures.CoreMetrics
-
Deprecated.since 10.7. Use
CoreMetrics.NEW_RELIABILITY_ISSUES_KEY
instead. - NEW_CODE_SMELLS - Static variable in class org.sonar.api.measures.CoreMetrics
-
Deprecated.since 10.7. Use
CoreMetrics.NEW_MAINTAINABILITY_ISSUES
instead. - NEW_CODE_SMELLS_KEY - Static variable in class org.sonar.api.measures.CoreMetrics
-
Deprecated.since 10.7. Use
CoreMetrics.NEW_MAINTAINABILITY_ISSUES_KEY
instead. - 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
-
Deprecated.since 10.7 as
Severity
is deprecated. No replacement. - NEW_CRITICAL_VIOLATIONS_KEY - Static variable in class org.sonar.api.measures.CoreMetrics
-
Deprecated.since 10.7 as
Severity
is deprecated. No replacement. - 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
-
Deprecated.since 10.7 as
Severity
is deprecated. No replacement. - NEW_INFO_VIOLATIONS_KEY - Static variable in class org.sonar.api.measures.CoreMetrics
-
Deprecated.since 10.7 as
Severity
is deprecated. No replacement. - 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_ISSUES - Static variable in class org.sonar.api.measures.CoreMetrics
-
This metric relates to new issues with the software quality set as 'Maintainability'.
- NEW_MAINTAINABILITY_ISSUES_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
-
Deprecated.since 10.7 as
Severity
is deprecated. No replacement. - NEW_MAJOR_VIOLATIONS_KEY - Static variable in class org.sonar.api.measures.CoreMetrics
-
Deprecated.since 10.7 as
Severity
is deprecated. No replacement. - NEW_MINOR_VIOLATIONS - Static variable in class org.sonar.api.measures.CoreMetrics
-
Deprecated.since 10.7 as
Severity
is deprecated. No replacement. - NEW_MINOR_VIOLATIONS_KEY - Static variable in class org.sonar.api.measures.CoreMetrics
-
Deprecated.since 10.7 as
Severity
is deprecated. No replacement. - NEW_RELIABILITY_ISSUES - Static variable in class org.sonar.api.measures.CoreMetrics
-
This metric relates to new issues with the software quality set as 'Reliability'.
- NEW_RELIABILITY_ISSUES_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_HOTSPOTS_REVIEWED - Static variable in class org.sonar.api.measures.CoreMetrics
- NEW_SECURITY_HOTSPOTS_REVIEWED_KEY - Static variable in class org.sonar.api.measures.CoreMetrics
- NEW_SECURITY_HOTSPOTS_REVIEWED_STATUS - Static variable in class org.sonar.api.measures.CoreMetrics
- NEW_SECURITY_HOTSPOTS_REVIEWED_STATUS_KEY - Static variable in class org.sonar.api.measures.CoreMetrics
- NEW_SECURITY_HOTSPOTS_TO_REVIEW_STATUS - Static variable in class org.sonar.api.measures.CoreMetrics
- NEW_SECURITY_HOTSPOTS_TO_REVIEW_STATUS_KEY - Static variable in class org.sonar.api.measures.CoreMetrics
- NEW_SECURITY_ISSUES - Static variable in class org.sonar.api.measures.CoreMetrics
-
This metric relates to new issues with the software quality set as 'Security'.
- NEW_SECURITY_ISSUES_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_SECURITY_REVIEW_RATING - Static variable in class org.sonar.api.measures.CoreMetrics
- NEW_SECURITY_REVIEW_RATING_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
-
Deprecated.since 10.7. Use
CoreMetrics.NEW_SECURITY_ISSUES
instead. - NEW_VULNERABILITIES_KEY - Static variable in class org.sonar.api.measures.CoreMetrics
-
Deprecated.since 10.7. Use
CoreMetrics.NEW_SECURITY_ISSUES_KEY
instead. - 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
. - 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
- 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.
- newInputFileEdit() - Method in interface org.sonar.api.batch.sensor.issue.fix.NewQuickFix
-
Create a new input file edit
- NewInputFileEdit - Interface in org.sonar.api.batch.sensor.issue.fix
- 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
. - NewIssue.FlowType - Enum in org.sonar.api.batch.sensor.issue
-
The type of the flow reported for a given issue.
- 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.
- newMessageFormatting() - Method in interface org.sonar.api.batch.sensor.issue.NewIssueLocation
-
Creates new instance of NewMessageFormatting
- NewMessageFormatting - Interface in org.sonar.api.batch.sensor.issue
-
Builder to create new MessageFormatting.
- 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
- newQuickFix() - Method in interface org.sonar.api.batch.sensor.issue.NewIssue
-
Create a new quick fix.
- NewQuickFix - Interface in org.sonar.api.batch.sensor.issue.fix
-
Describe a quick fix for a
NewIssue
, with a description and a collection ofNewInputFileEdit
. - 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, 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
- 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, 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.
- newText() - Method in interface org.sonar.api.batch.sensor.issue.fix.TextEdit
- newTextEdit() - Method in interface org.sonar.api.batch.sensor.issue.fix.NewInputFileEdit
-
Create a new text edit
- NewTextEdit - Interface in org.sonar.api.batch.sensor.issue.fix
-
Describe a text edit for a
NewInputFileEdit
as a replacement text for a givenTextRange
- 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
- nextCache() - Method in interface org.sonar.api.batch.sensor.SensorContext
-
Access object to write cache that will be stored and made available in a future analysis.
- 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
- 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
- now() - Method in class org.sonar.api.utils.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
-
Deprecated.
- of(Writer) - Static method in class org.sonar.api.utils.text.XmlWriter
- of(String) - Static method in exception org.sonar.api.utils.MessageException
- of(String, String) - Static method in enum org.sonar.api.issue.IssueStatus
- 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(RuleKey) - Method in class org.sonar.api.batch.rule.Checks
- 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
- 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
- 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. - on(InputFile) - Method in interface org.sonar.api.batch.sensor.issue.fix.NewInputFileEdit
- onChange(GlobalPropertyChangeHandler.PropertyChange) - Method in class org.sonar.api.config.GlobalPropertyChangeHandler
-
This method gets called when a property is changed.
- 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
thisSensor
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 theSensor
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 - org.sonar.api.issue.IssueStatus
- OPEN_AS_VULNERABILITY - Static variable in interface org.sonar.api.issue.DefaultTransitions
-
Deprecated.since 8.1, security hotspots can no longer be converted to vulnerabilities
- OPEN_ISSUES - Static variable in class org.sonar.api.measures.CoreMetrics
-
Deprecated.since 10.4. Use
CoreMetrics.VIOLATIONS
instead. - OPEN_ISSUES_KEY - Static variable in class org.sonar.api.measures.CoreMetrics
-
Deprecated.since 10.4. Use
CoreMetrics.VIOLATIONS_KEY
instead. - openStream(URI) - Method in class org.sonar.api.utils.HttpDownloader
- options() - Method in class org.sonar.api.config.PropertyDefinition
-
Options for *_LIST types
Options for property of typePropertyType.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(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.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.cache - package org.sonar.api.batch.sensor.cache
- 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.issue.fix - package org.sonar.api.batch.sensor.issue.fix
- 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.posttask - package org.sonar.api.ce.posttask
- org.sonar.api.config - package org.sonar.api.config
- org.sonar.api.issue - package org.sonar.api.issue
- org.sonar.api.issue.impact - package org.sonar.api.issue.impact
- 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
-
Replaced by
org.sonar.api.batch.fs
- 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.http - package org.sonar.api.server.http
- org.sonar.api.server.impl - package org.sonar.api.server.impl
- 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.server.ws.impl - package org.sonar.api.server.ws.impl
- 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
- 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
- output() - Method in interface org.sonar.api.server.ws.Response.Stream
-
Response stream.
- 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
-
Deprecated.since 10.1, use
Issue.overridenImpacts()
instead - overriddenSeverity() - Method in class org.sonar.api.server.profile.BuiltInQualityProfilesDefinition.BuiltInActiveRule
- overriddenValue() - Method in class org.sonar.api.server.profile.BuiltInQualityProfilesDefinition.OverriddenParam
- overrideImpact(SoftwareQuality, Severity) - Method in interface org.sonar.api.batch.sensor.issue.NewIssue
-
Override severity of an impact defined by the rule.
- overridenImpacts() - Method in interface org.sonar.api.batch.sensor.issue.Issue
-
Retrieve the overriden impacts for this issue.
- 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
-
Deprecated.since 10.1, use
NewIssue.overrideImpact(SoftwareQuality, org.sonar.api.issue.impact.Severity)
instead
P
- Page - Class in org.sonar.api.web.page
- 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
- 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.impl.ValidatingRequest
- param(String) - Method in class org.sonar.api.server.ws.Request
- param(String) - Method in class org.sonar.api.server.ws.WebService.Action
- 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
- 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.impl.ValidatingRequest
- paramAsEnums(String, Class<E>) - Method in class org.sonar.api.server.ws.Request
- paramAsInputStream(String) - Method in class org.sonar.api.server.ws.impl.ValidatingRequest
- paramAsInputStream(String) - Method in class org.sonar.api.server.ws.Request
- paramAsInt(String) - Method in class org.sonar.api.server.ws.Request
- paramAsLong(String) - Method in class org.sonar.api.server.ws.Request
- paramAsPart(String) - Method in class org.sonar.api.server.ws.impl.ValidatingRequest
- paramAsPart(String) - Method in class org.sonar.api.server.ws.Request
- paramAsStrings(String) - Method in class org.sonar.api.server.ws.impl.ValidatingRequest
- 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(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, 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: rely on default timezone!
- parseDateOrDateTime(String, ZoneId) - Static method in class org.sonar.api.utils.DateUtils
-
Parse either a full date time (using RFC-822 TZ format), or a local date.
- 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
-
Parse format
DateUtils.DATETIME_FORMAT
. - parseEndingDateOrDateTime(String) - Static method in class org.sonar.api.utils.DateUtils
-
Warning: rely on default timezone for local dates!
- parseEndingDateOrDateTime(String, ZoneId) - Static method in class org.sonar.api.utils.DateUtils
-
Return the datetime if @param stringDate is a datetime, local date + 1 day if stringDate is a local 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
-
Parse format
DateUtils.DATETIME_FORMAT
. - parseStartingDateOrDateTime(String) - Static method in class org.sonar.api.utils.DateUtils
-
Warning: rely on default timezone for local dates!
- parseStartingDateOrDateTime(String, ZoneId) - Static method in class org.sonar.api.utils.DateUtils
- 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
- PartImpl - Class in org.sonar.api.server.ws.impl
- PartImpl(InputStream, String) - Constructor for class org.sonar.api.server.ws.impl.PartImpl
- PASSWORD - org.sonar.api.PropertyType
-
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
-
Deprecated.
- 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, andInputFile.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.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
- 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
- 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
- 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. - 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
- 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() - Method in enum org.sonar.api.server.rule.RulesDefinition.OwaspAsvsVersion
- prefix() - Method in enum org.sonar.api.server.rule.RulesDefinition.OwaspTop10Version
- prefix() - Method in enum org.sonar.api.server.rule.RulesDefinition.PciDssVersion
- 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
- previousCache() - Method in interface org.sonar.api.batch.sensor.SensorContext
-
Access object to read cached data.
- 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
- processesFilesIndependently() - Method in interface org.sonar.api.batch.sensor.SensorDescriptor
-
Advertise that this sensor process each file independently.
- profile(String, String) - Method in class org.sonar.api.server.profile.BuiltInQualityProfilesDefinition.Context
- ProfileExporter - Class in org.sonar.api.profiles
-
Deprecated.since 9.1. Web services should be used instead.
- ProfileExporter(String, String) - Constructor for class org.sonar.api.profiles.ProfileExporter
-
Deprecated.
- ProfileImporter - Class in org.sonar.api.profiles
-
Deprecated.since 9.1. Web services should be used instead.
- ProfileImporter(String, String) - Constructor for class org.sonar.api.profiles.ProfileImporter
-
Deprecated.
- 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
- 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 - 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_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_TESTS_EXCLUSIONS_PROPERTY - Static variable in interface org.sonar.api.CoreProperties
- PROJECT_TESTS_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, Configuration) - 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
-
Deprecated.
- prop(String, boolean) - Method in class org.sonar.api.utils.text.XmlWriter
- prop(String, double) - Method in class org.sonar.api.utils.text.JsonWriter
-
Deprecated.
- prop(String, double) - Method in class org.sonar.api.utils.text.XmlWriter
- prop(String, long) - Method in class org.sonar.api.utils.text.JsonWriter
-
Deprecated.
- prop(String, long) - Method in class org.sonar.api.utils.text.XmlWriter
- prop(String, Number) - Method in class org.sonar.api.utils.text.JsonWriter
-
Deprecated.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
-
Deprecated.
- prop(String, String) - Method in class org.sonar.api.utils.text.XmlWriter
- propDate(String, Date) - Method in class org.sonar.api.utils.text.JsonWriter
-
Deprecated.Encodes the property name and date value (ISO format).
- propDateTime(String, Date) - Method in class org.sonar.api.utils.text.JsonWriter
-
Deprecated.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(System2, Object...) - Constructor for class org.sonar.api.config.PropertyDefinitions
- PropertyDefinitions(System2, 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
- PropertyType - Enum in org.sonar.api
- 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
- publishAllFiles() - Method in interface org.sonar.api.resources.Language
-
Whether all files identified with this language should be sent to SonarQube, even if no data is reported for them
- PULL_REQUEST - org.sonar.api.ce.posttask.Branch.Type
- PULL_REQUEST_FIXED_ISSUES - Static variable in class org.sonar.api.measures.CoreMetrics
- PULL_REQUEST_FIXED_ISSUES_KEY - Static variable in class org.sonar.api.measures.CoreMetrics
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_GATE_IGNORE_SMALL_CHANGES - Static variable in interface org.sonar.api.CoreProperties
-
since 8.9
- 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
- QuickFix - Interface in org.sonar.api.batch.sensor.issue.fix
-
Represents a quick fix for an
Issue
, with a description and a collection ofInputFileEdit
. - quickFixes() - Method in interface org.sonar.api.batch.sensor.issue.Issue
-
The list of quick fixes contributed for this issue.
R
- range() - Method in interface org.sonar.api.batch.sensor.issue.fix.TextEdit
- 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
- read(String) - Method in interface org.sonar.api.batch.sensor.cache.ReadCache
-
Returns an input stream for the data cached with the key.
- 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
- ReadCache - Interface in org.sonar.api.batch.sensor.cache
- readInputStreamParam(String) - Method in class org.sonar.api.server.ws.impl.ValidatingRequest
- readMultiParam(String) - Method in class org.sonar.api.server.ws.impl.ValidatingRequest
- readParam(String) - Method in class org.sonar.api.server.ws.impl.ValidatingRequest
- readPart(String) - Method in class org.sonar.api.server.ws.impl.ValidatingRequest
- 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.impl.RulesDefinitionContext
- registerRepository(DefaultNewRepository) - Method in class org.sonar.api.server.rule.RulesDefinition.Context
- REGULAR_EXPRESSION - org.sonar.api.PropertyType
-
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
-
Deprecated.
- 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, andInputFile.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 - 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 - org.sonar.api.issue.impact.SoftwareQuality
- RELIABILITY_ISSUES - Static variable in class org.sonar.api.measures.CoreMetrics
-
This metric relates to issues with the software quality set as 'Reliability'.
- RELIABILITY_ISSUES_KEY - Static variable in class org.sonar.api.measures.CoreMetrics
- 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.
- removeActiveRule(ActiveRule) - Method in class org.sonar.api.profiles.RulesProfile
- REMOVED - org.sonar.api.rule.RuleStatus
- REOPEN - Static variable in interface org.sonar.api.issue.DefaultTransitions
- REOPENED_ISSUES - Static variable in class org.sonar.api.measures.CoreMetrics
-
Deprecated.since 10.4. Use
CoreMetrics.VIOLATIONS
instead. - REOPENED_ISSUES_KEY - Static variable in class org.sonar.api.measures.CoreMetrics
-
Deprecated.since 10.4. Use
CoreMetrics.VIOLATIONS_KEY
instead. - 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.impl.RulesDefinitionContext
- 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.impl.RulesDefinitionContext
- 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 typeString
. - 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. - requireProperty(String...) - Method in interface org.sonar.api.batch.postjob.PostJobDescriptor
-
Property this
PostJob
depends on. - RESERVED_TAGS - Static variable in class org.sonar.api.server.rule.RuleTagsToTypeConverter
-
Deprecated.
- 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
-
Deprecated.since 10.4 in favor of
Issue.issueStatus()
- resolution() - Method in interface org.sonar.api.issue.Issue
-
Deprecated.since 10.4 in favor of
IssueStatus
- RESOLUTION_ACKNOWLEDGED - Static variable in interface org.sonar.api.issue.Issue
-
Deprecated.since 10.4 as Security Hotspot are deprecated.
- RESOLUTION_FALSE_POSITIVE - Static variable in interface org.sonar.api.issue.Issue
-
Deprecated.since 10.4 in favor of
IssueStatus
- RESOLUTION_FIXED - Static variable in interface org.sonar.api.issue.Issue
-
Deprecated.since 10.4 in favor of
IssueStatus
- RESOLUTION_REMOVED - Static variable in interface org.sonar.api.issue.Issue
-
Deprecated.since 10.4 in favor of
IssueStatus
- RESOLUTION_SAFE - Static variable in interface org.sonar.api.issue.Issue
-
Deprecated.since 10.4 as Security Hotspot are deprecated.
- RESOLUTION_WONT_FIX - Static variable in interface org.sonar.api.issue.Issue
-
Deprecated.since 10.4 in favor of
IssueStatus
- RESOLUTIONS - Static variable in interface org.sonar.api.issue.Issue
-
Deprecated.since 10.4 in favor of
IssueStatus
- RESOLVE - Static variable in interface org.sonar.api.issue.DefaultTransitions
- RESOLVE_AS_ACKNOWLEDGED - Static variable in interface org.sonar.api.issue.DefaultTransitions
- RESOLVE_AS_REVIEWED - Static variable in interface org.sonar.api.issue.DefaultTransitions
- RESOLVE_AS_SAFE - Static variable in interface org.sonar.api.issue.DefaultTransitions
- 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.
- RESOURCES_SECTION_KEY - Static variable in class org.sonar.api.server.rule.RuleDescriptionSection.RuleDescriptionSectionKeys
- 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
- RESPECTFUL - org.sonar.api.rules.CleanCodeAttribute
- 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
- RESPONSIBLE - org.sonar.api.rules.CleanCodeAttributeCategory
- 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.
- ROOT_CAUSE_SECTION_KEY - Static variable in class org.sonar.api.server.rule.RuleDescriptionSection.RuleDescriptionSectionKeys
- 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.server.rule.RulesDefinition.Rule
- RuleAnnotationUtils - Class in org.sonar.api.rules
- ruleDescriptionContextKey() - Method in interface org.sonar.api.batch.sensor.issue.Issue
-
The optional rule description section context key, in case the analyzer detects a context for the issue.
- RuleDescriptionSection - Interface in org.sonar.api.server.rule
-
Represents a sub-section of a rule description (What's the risk, Assess the risk, etc.)
- RuleDescriptionSection.RuleDescriptionSectionKeys - Class in org.sonar.api.server.rule
-
This class is a placeholder for the supported rule description section key constants.
- RuleDescriptionSectionBuilder - Class in org.sonar.api.server.rule
-
This builder allows to build the right implementation of
RuleDescriptionSection
, depending on the provided arguments - RuleDescriptionSectionBuilder() - Constructor for class org.sonar.api.server.rule.RuleDescriptionSectionBuilder
- ruleDescriptionSections() - Method in class org.sonar.api.server.rule.internal.DefaultRule
- ruleDescriptionSections() - Method in class org.sonar.api.server.rule.RulesDefinition.Rule
-
See
RulesDefinition.NewRule.addDescriptionSection(RuleDescriptionSection)
to understand what are the requirements for a section. - RuleFinder - Interface in org.sonar.api.rules
- 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.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 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
- 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
- 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
- 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.CweVersion - Enum in org.sonar.api.server.rule
-
Deprecated.in 9.15
- RulesDefinition.DebtRemediationFunctions - Interface in org.sonar.api.server.rule
-
Factory of
DebtRemediationFunction
. - 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.OwaspAsvsVersion - Enum in org.sonar.api.server.rule
- RulesDefinition.OwaspTop10 - Enum in org.sonar.api.server.rule
- RulesDefinition.OwaspTop10Version - Enum in org.sonar.api.server.rule
- RulesDefinition.Param - Interface in org.sonar.api.server.rule
- RulesDefinition.PciDssVersion - Enum in org.sonar.api.server.rule
- RulesDefinition.Repository - Interface in org.sonar.api.server.rule
- RulesDefinition.Rule - Class in org.sonar.api.server.rule
- 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
- RulesDefinitionContext - Class in org.sonar.api.server.impl
- RulesDefinitionContext() - Constructor for class org.sonar.api.server.impl.RulesDefinitionContext
- RulesDefinitionXmlLoader - Class in org.sonar.api.server.rule
-
Deprecated.since 9.0. Use the sonar-check-api to annotate rule classes instead of loading the metadata from XML files. See
Rule
. - RulesDefinitionXmlLoader() - Constructor for class org.sonar.api.server.rule.RulesDefinitionXmlLoader
-
Deprecated.
- 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
-
Deprecated.since 10.1.
- RuleType - Enum in org.sonar.api.rules
-
Deprecated.since 10.1, use impacts with
SoftwareQuality
instead - 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
- 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.
- 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
- sectionKey(String) - Method in class org.sonar.api.server.rule.RuleDescriptionSectionBuilder
-
Identifier of the section, must be unique across sections of a given rule Section keys must follow the format defined in
StringPatternValidator.COMMON_PATTERN_FOR_KEYS
- SECURITY - org.sonar.api.issue.impact.SoftwareQuality
- SECURITY_HOTSPOT - org.sonar.api.rules.RuleType
-
Deprecated.
- SECURITY_HOTSPOT_RESOLUTIONS - Static variable in interface org.sonar.api.issue.Issue
-
Deprecated.since 10.4 as Security Hotspot are deprecated
- SECURITY_HOTSPOTS - Static variable in class org.sonar.api.measures.CoreMetrics
- SECURITY_HOTSPOTS_KEY - Static variable in class org.sonar.api.measures.CoreMetrics
- SECURITY_HOTSPOTS_REVIEWED - Static variable in class org.sonar.api.measures.CoreMetrics
- SECURITY_HOTSPOTS_REVIEWED_KEY - Static variable in class org.sonar.api.measures.CoreMetrics
- SECURITY_HOTSPOTS_REVIEWED_STATUS - Static variable in class org.sonar.api.measures.CoreMetrics
- SECURITY_HOTSPOTS_REVIEWED_STATUS_KEY - Static variable in class org.sonar.api.measures.CoreMetrics
- SECURITY_HOTSPOTS_TO_REVIEW_STATUS - Static variable in class org.sonar.api.measures.CoreMetrics
- SECURITY_HOTSPOTS_TO_REVIEW_STATUS_KEY - Static variable in class org.sonar.api.measures.CoreMetrics
- SECURITY_ISSUES - Static variable in class org.sonar.api.measures.CoreMetrics
-
This metric relates to issues with the software quality set as 'Security'.
- SECURITY_ISSUES_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. - sendRedirect(String) - Method in interface org.sonar.api.server.http.HttpResponse
-
Sends a temporary redirect response to the client using the specified redirect location URL and clears the buffer.
- 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, available in sonar-plugin-api-impl - 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_ID - Static variable in interface org.sonar.api.CoreProperties
- 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
-
Deprecated, for removal: This API element is subject to removal in a future version.since 9.16. Use
HttpFilter
instead. - ServletFilter() - Constructor for class org.sonar.api.web.ServletFilter
-
Deprecated.
- ServletFilter.UrlPattern - Class in org.sonar.api.web
-
Deprecated.
- ServletFilter.UrlPattern.Builder - Class in org.sonar.api.web
-
Deprecated.
- SET_AS_IN_REVIEW - Static variable in interface org.sonar.api.issue.DefaultTransitions
-
Deprecated.since 8.1, transition has no effect
- setAction(WebService.Action) - Method in class org.sonar.api.server.ws.impl.ValidatingRequest
- 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
- setAttribute(String, Object) - Method in interface org.sonar.api.server.http.HttpRequest
-
Stores an attribute in this request.
- 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")
- setCardinality(Cardinality) - Method in class org.sonar.api.rules.Rule
-
Deprecated.since 4.4, use
Rule.setIsTemplate(boolean)
- setChangelog(Change...) - Method in class org.sonar.api.server.ws.WebService.NewAction
-
List of changes made to the contract or valuable insight.
- setCharacterEncoding(String) - Method in interface org.sonar.api.server.http.HttpResponse
-
Sets the character encoding (MIME charset) of the response being sent to the client, for example, to UTF-8.
- setCleanCodeAttribute(CleanCodeAttribute) - Method in class org.sonar.api.server.rule.RulesDefinition.NewRule
-
The Clean Code Attribute of the rule.
- setCodeVariants(Iterable<String>) - Method in interface org.sonar.api.batch.sensor.issue.NewIssue
-
Registers a list of code variants for this issue.
- 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
- setContentType(String) - Method in interface org.sonar.api.server.http.HttpResponse
-
Sets the content type of the response being sent to the client, if the response has not been committed yet.
- 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.impl.RulesDefinitionContext
- setCurrentPluginKey(String) - Method in class org.sonar.api.server.rule.RulesDefinition.AbstractContext
- setCurrentPluginKey(String) - Method in class org.sonar.api.server.rule.RulesDefinition.Context
- setDebtRemediationFunction(DebtRemediationFunction) - Method in class org.sonar.api.server.rule.RulesDefinition.NewRule
- setDecimalScale(int) - Method in class org.sonar.api.measures.Metric.Builder
-
Scale to be used if the metric has decimal type (
Metric.ValueType.FLOAT
orMetric.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
- setDefaultProfile(Boolean) - Method in class org.sonar.api.profiles.RulesProfile
-
Set whether this is the default profile for the language.
- 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, String) - Method in class org.sonar.api.server.ws.WebService.NewParam
- setDeprecatedKeys(Set<RuleKey>) - Method in class org.sonar.api.batch.rule.LoadedActiveRule
- 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, 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...)
- 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
- setExampleValue(Object) - Method in class org.sonar.api.server.ws.WebService.NewParam
- 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.
- 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.http.HttpResponse
-
Sets a response header with the given name and value.
- 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.
- 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.rules.ActiveRule
-
Deprecated.visibility should be decreased to protected or package
- 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.
- 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
- 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.measures.Metric
-
Sets the metric key
- setKey(String) - Method in class org.sonar.api.profiles.ProfileExporter
-
Deprecated.
- setKey(String) - Method in class org.sonar.api.profiles.ProfileImporter
-
Deprecated.
- 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.
- setLevel(LoggerLevel) - Method in interface org.sonar.api.utils.log.Logger
-
Deprecated.since 9.15 will always return false
- setLevel(LoggerLevel) - Method in class org.sonar.api.utils.log.Slf4jLogger
- setLocalConnector(LocalConnector) - Method in class org.sonar.api.server.ws.impl.ValidatingRequest
- setLogin(String) - Method in class org.sonar.api.platform.NewUserHandler.Context.Builder
- setLogin(String) - Method in class org.sonar.api.server.authentication.UserIdentity.Builder
-
Deprecated.since 8.0, has no effect as it is internal managed field
- setMarkdownDescription(String) - Method in class org.sonar.api.server.rule.RulesDefinition.NewRule
-
Deprecated, for removal: This API element is subject to removal in a future version.since 9.6. Use
RulesDefinition.NewRule.addDescriptionSection(RuleDescriptionSection)
instead - setMarkdownDescription(URL) - Method in class org.sonar.api.server.rule.RulesDefinition.NewRule
-
Deprecated, for removal: This API element is subject to removal in a future version.since 9.6. Use
RulesDefinition.NewRule.addDescriptionSection(RuleDescriptionSection)
instead - setMaximumLength(Integer) - Method in class org.sonar.api.server.ws.WebService.NewParam
- setMaximumValue(Integer) - Method in class org.sonar.api.server.ws.WebService.NewParam
- setMaxValuesAllowed(Integer) - Method in class org.sonar.api.server.ws.WebService.NewParam
- setMediaType(String) - Method in interface org.sonar.api.server.ws.Response.Stream
- setMimeType(String) - Method in class org.sonar.api.profiles.ProfileExporter
-
Deprecated.Set the mime type of the exported file
- setMinimumLength(Integer) - Method in class org.sonar.api.server.ws.WebService.NewParam
- setName(String) - Method in class org.sonar.api.batch.bootstrap.ProjectDefinition
-
Deprecated.
- setName(String) - Method in class org.sonar.api.batch.rule.LoadedActiveRule
- setName(String) - Method in class org.sonar.api.measures.Metric
-
Sets the metric name
- setName(String) - Method in class org.sonar.api.platform.NewUserHandler.Context.Builder
- setName(String) - Method in class org.sonar.api.profiles.ProfileExporter
-
Deprecated.
- setName(String) - Method in class org.sonar.api.profiles.ProfileImporter
-
Deprecated.
- setName(String) - Method in class org.sonar.api.profiles.RulesProfile
-
Set the profile name.
- setName(String) - Method in class org.sonar.api.resources.AbstractLanguage
-
Sets the language name
- setName(String) - Method in class org.sonar.api.rules.Rule
-
Sets the rule name
- setName(String) - Method in class org.sonar.api.security.UserDetails
- setName(String) - Method in class org.sonar.api.server.authentication.UserIdentity.Builder
- setName(String) - Method in class org.sonar.api.server.rule.internal.DefaultNewParam
- setName(String) - Method in class org.sonar.api.server.rule.internal.DefaultNewRepository
- setName(String) - Method in class org.sonar.api.server.rule.RulesDefinition.NewParam
- setName(String) - Method in interface org.sonar.api.server.rule.RulesDefinition.NewRepository
- setName(String) - Method in class org.sonar.api.server.rule.RulesDefinition.NewRule
-
Required rule name
- setName(String) - Method in class org.sonar.api.web.page.Page.Builder
-
Page name displayed in the UI.
- setNewShell(boolean) - Method in class org.sonar.api.utils.command.Command
-
Set to
true
if a new shell should be used to execute the command. - setOptimizedBestValue(boolean) - Method in class org.sonar.api.measures.Metric.Builder
-
Specifies whether file-level measures that equal to the defined best value are stored or not.
- setOptimizedBestValue(Boolean) - Method in class org.sonar.api.measures.Metric
- setOutputMetrics(String...) - Method in interface org.sonar.api.ce.measure.MeasureComputer.MeasureComputerDefinition.Builder
-
List of metric keys of the measures that can be added by this computer.
- setOverriddenValue(String) - Method in class org.sonar.api.server.profile.BuiltInQualityProfilesDefinition.NewOverriddenParam
-
Empty default value will be converted to null.
- setParameter(String, String) - Method in class org.sonar.api.rules.ActiveRule
- setParamKey(String) - Method in class org.sonar.api.rules.ActiveRuleParam
- setParams(List<RuleParam>) - Method in class org.sonar.api.rules.Rule
-
Sets the rule parameters
- setParams(Map<String, String>) - Method in class org.sonar.api.batch.rule.LoadedActiveRule
- setParent(Rule) - Method in class org.sonar.api.rules.Rule
-
Deprecated.since 4.4, use
Rule.setTemplate(Rule)
} - setPossibleValues(Collection<T>) - Method in class org.sonar.api.server.ws.WebService.NewParam
-
Exhaustive list of possible values when it makes sense, for example list of severities.
- setPossibleValues(T...) - Method in class org.sonar.api.server.ws.WebService.NewParam
-
Exhaustive list of possible values when it makes sense, for example list of severities.
- setPost(boolean) - Method in class org.sonar.api.server.ws.WebService.NewAction
- setProjectVersion(String) - Method in class org.sonar.api.batch.bootstrap.ProjectDefinition
-
Deprecated.
- setProperties(Map<String, String>) - Method in class org.sonar.api.batch.bootstrap.ProjectDefinition
-
Deprecated.
- setProperty(String, boolean) - Method in class org.sonar.api.resources.ResourceType.Builder
- setProperty(String, String) - Method in class org.sonar.api.batch.bootstrap.ProjectDefinition
-
Deprecated.
- setProperty(String, String) - Method in class org.sonar.api.resources.ResourceType.Builder
-
Sets a property on the resource type.
- setProperty(String, String) - Method in class org.sonar.api.utils.System2
-
Shortcut for
System{@link #setProperty(String, String)}
- setProviderId(String) - Method in class org.sonar.api.server.authentication.UserIdentity.Builder
- setProviderLogin(String) - Method in class org.sonar.api.server.authentication.UserIdentity.Builder
- setQualitative(Boolean) - Method in class org.sonar.api.measures.Metric.Builder
-
Sets whether the metric is qualitative or not.
- setQualitative(Boolean) - Method in class org.sonar.api.measures.Metric
-
Sets whether the metric is qualitative
- setQuickFixAvailable(boolean) - Method in interface org.sonar.api.batch.sensor.issue.NewIssue
-
Register if a QuickFix would be available on SonarLint for this issue.
- setRepositoryKey(String) - Method in class org.sonar.api.rules.Rule
- setRequired(boolean) - Method in class org.sonar.api.server.ws.WebService.NewParam
-
Is the parameter required or optional ? Default value is false (optional).
- setResponseExample(URL) - Method in class org.sonar.api.server.ws.WebService.NewAction
-
Link to the document containing an example of response.
- setRule(Rule) - Method in class org.sonar.api.rules.ActiveRule
-
Deprecated.visibility should be reduced to protected or package
- setRuleDescriptionContextKey(String) - Method in interface org.sonar.api.batch.sensor.issue.NewIssue
-
Set the optional rule description section context key.
- setRuleKey(RuleKey) - Method in class org.sonar.api.batch.rule.LoadedActiveRule
- setRuleParam(RuleParam) - Method in class org.sonar.api.rules.ActiveRuleParam
-
Deprecated.visibility should be decreased to protected or package
- setRulesProfile(RulesProfile) - Method in class org.sonar.api.rules.ActiveRule
-
Deprecated.visibility should be reduced to protected or package
- setScope(RuleScope) - Method in class org.sonar.api.server.rule.RulesDefinition.NewRule
- setScope(Page.Scope) - Method in class org.sonar.api.web.page.Page.Builder
-
Define where the page is displayed, either in the global menu or in a component page
- setSerializeEmptys(boolean) - Method in class org.sonar.api.utils.text.JsonWriter
-
Deprecated.Enable/disable serialization of properties which value is an empty String.
- setSerializeNulls(boolean) - Method in class org.sonar.api.utils.text.JsonWriter
-
Deprecated.
- setSeverity(String) - Method in class org.sonar.api.batch.rule.LoadedActiveRule
- setSeverity(String) - Method in class org.sonar.api.server.rule.RulesDefinition.NewRule
-
Deprecated.since 10.1. Use
RulesDefinition.NewRule.addDefaultImpact(SoftwareQuality, Severity)
instead - setSeverity(RulePriority) - Method in class org.sonar.api.rules.ActiveRule
- setSeverity(RulePriority) - Method in class org.sonar.api.rules.Rule
- setSince(String) - Method in class org.sonar.api.server.ws.WebService.NewAction
- setSince(String) - Method in class org.sonar.api.server.ws.WebService.NewController
-
Optional version when the controller was created
- setSince(String) - Method in class org.sonar.api.server.ws.WebService.NewParam
- setSources(File...) - Method in class org.sonar.api.batch.bootstrap.ProjectDefinition
-
Deprecated.
- setSources(String...) - Method in class org.sonar.api.batch.bootstrap.ProjectDefinition
-
Deprecated.
- setStatus(int) - Method in interface org.sonar.api.server.http.HttpResponse
-
Sets the status code for this response.
- setStatus(int) - Method in interface org.sonar.api.server.ws.Response.Stream
-
HTTP status code.
- setStatus(String) - Method in class org.sonar.api.rules.Rule
- setStatus(RuleStatus) - Method in class org.sonar.api.server.rule.RulesDefinition.NewRule
-
Default value is
RuleStatus.READY
. - setStringValue(String, int, String) - Method in interface org.sonar.api.measures.FileLinesContext
- setSupportedLanguages(String...) - Method in class org.sonar.api.profiles.ProfileExporter
-
Deprecated.Set the list of languages supported An empty value means that it will be available for every languages.
- setSupportedLanguages(String...) - Method in class org.sonar.api.profiles.ProfileImporter
-
Deprecated.Set the list of languages supported An empty value means that it will be available for every languages.
- setSystemTags(String[]) - Method in class org.sonar.api.rules.Rule
- setTags(String[]) - Method in class org.sonar.api.rules.Rule
-
For definition of rule only
- setTags(String...) - Method in class org.sonar.api.server.rule.RulesDefinition.NewRule
- setTemplate(boolean) - Method in class org.sonar.api.server.rule.RulesDefinition.NewRule
- setTemplate(Rule) - Method in class org.sonar.api.rules.Rule
- setTemplateRuleKey(String) - Method in class org.sonar.api.batch.rule.LoadedActiveRule
- setTests(File...) - Method in class org.sonar.api.batch.bootstrap.ProjectDefinition
-
Deprecated.
- setTests(String...) - Method in class org.sonar.api.batch.bootstrap.ProjectDefinition
-
Deprecated.
- settings() - Method in interface org.sonar.api.batch.sensor.SensorContext
-
Deprecated.since 6.5 use
SensorContext.config()
- Settings - Class in org.sonar.api.config
-
Deprecated.since 6.5 use
Configuration
. Implementation moved out of the API in 8.3. Only remains minimal interface to make some outdated plugins happy. - Settings - Interface in org.sonar.api.ce.measure
-
Settings of the current component used in
MeasureComputer
- Settings() - Constructor for class org.sonar.api.config.Settings
-
Deprecated.
- setType(String) - Method in class org.sonar.api.rules.RuleParam
- setType(Metric.ValueType) - Method in class org.sonar.api.measures.Metric
-
Sets the metric type
- setType(RuleType) - Method in class org.sonar.api.server.rule.RulesDefinition.NewRule
-
Deprecated.since 10.1. Use
RulesDefinition.NewRule.addDefaultImpact(SoftwareQuality, Severity)
instead - setType(RuleParamType) - Method in class org.sonar.api.server.rule.internal.DefaultNewParam
- setType(RuleParamType) - Method in class org.sonar.api.server.rule.RulesDefinition.NewParam
- setUniqueKey(String, String) - Method in class org.sonar.api.rules.Rule
- setUpdatedAt(long) - Method in class org.sonar.api.batch.rule.LoadedActiveRule
- setUpdatedAt(Date) - Method in class org.sonar.api.rules.Rule
- setUsed(Boolean) - Method in class org.sonar.api.profiles.RulesProfile
-
Deprecated.profile versioning is dropped in 4.4. Always returns -1.
- setUserId(String) - Method in class org.sonar.api.security.UserDetails
- setUserManaged(boolean) - Method in class org.sonar.api.measures.Metric.Builder
-
Deprecated.since 9.1. There is no replacement
- setUserManaged(Boolean) - Method in class org.sonar.api.measures.Metric
-
Deprecated.since 9.1. There is no replacement
- setUuid(String) - Method in class org.sonar.api.measures.Metric
-
For internal use only
- setValue(String) - Method in class org.sonar.api.rules.ActiveRuleParam
- setVersion(int) - Method in class org.sonar.api.profiles.RulesProfile
-
Deprecated.profile versioning is dropped in 4.4. Always returns -1.
- setWorkDir(File) - Method in class org.sonar.api.batch.bootstrap.ProjectDefinition
-
Deprecated.
- setWorstValue(Double) - Method in class org.sonar.api.measures.Metric.Builder
-
Sets the worst value that the metric can get (example: 0.0 for code coverage).
- setWorstValue(Double) - Method in class org.sonar.api.measures.Metric
- severity() - Method in interface org.sonar.api.batch.rule.ActiveRule
-
Non-null severity.
- severity() - Method in interface org.sonar.api.batch.rule.Rule
- severity() - Method in interface org.sonar.api.batch.sensor.issue.ExternalIssue
-
Deprecated.since 10.1, use
ExternalIssue.impacts()
instead - severity() - Method in interface org.sonar.api.batch.sensor.rule.AdHocRule
-
Deprecated.since 10.1, use
AdHocRule.defaultImpacts()
instead - severity() - Method in interface org.sonar.api.ce.measure.Issue
-
Deprecated.since 10.1, use
Issue.impacts()
instead - severity() - Method in interface org.sonar.api.issue.Issue
-
Deprecated.since 10.1
- severity() - Method in interface org.sonar.api.scan.issue.filter.FilterableIssue
-
Deprecated.
- severity() - Method in class org.sonar.api.server.rule.internal.DefaultRule
- severity() - Method in class org.sonar.api.server.rule.RulesDefinition.Rule
-
Deprecated.since 10.1, use
RulesDefinition.Rule.defaultImpacts()
instead - severity(Severity) - Method in interface org.sonar.api.batch.sensor.issue.NewExternalIssue
-
Deprecated.since 10.1, use {@link #addImpact(SoftwareQuality softwareQuality, org.sonar.api.issue.impact.Severity severity)()} instead
- severity(Severity) - Method in interface org.sonar.api.batch.sensor.rule.NewAdHocRule
-
Deprecated.since 10.1, use impacts with
NewAdHocRule.addDefaultImpact(SoftwareQuality, org.sonar.api.issue.impact.Severity)
instead - Severity - Class in org.sonar.api.rule
-
Deprecated.since 10.1, use impacts with
Severity
instead - Severity - Enum in org.sonar.api.batch.rule
-
Deprecated.since 10.1, use impacts with
Severity
instead - Severity - Enum in org.sonar.api.issue.impact
- shouldSyncGroups() - Method in class org.sonar.api.server.authentication.UserIdentity
-
Return true if groups should be synchronized for this user.
- since() - Method in class org.sonar.api.server.ws.WebService.Action
-
Set if different than controller.
- since() - Method in class org.sonar.api.server.ws.WebService.Controller
- since() - Method in class org.sonar.api.server.ws.WebService.Param
- SINGLE_ANALYSIS - Static variable in annotation type org.sonarsource.api.sonarlint.SonarLintSide
-
The component will be instantiated for each analysis (could be single or multiple files analysis).
- SINGLE_SELECT_LIST - org.sonar.api.PropertyType
-
Single select list with a list of options
- singleListOfValues(String...) - Static method in class org.sonar.api.server.rule.RuleParamType
- SKIPPED_TESTS - Static variable in class org.sonar.api.measures.CoreMetrics
- SKIPPED_TESTS_KEY - Static variable in class org.sonar.api.measures.CoreMetrics
- Slf4jLogger - Class in org.sonar.api.utils.log
-
Implements Sonar logging facade on top of slf4j
- Slf4jLogger(Logger) - Constructor for class org.sonar.api.utils.log.Slf4jLogger
- SMTP_HOST - Static variable in class org.sonar.api.config.EmailSettings
- SMTP_HOST_DEFAULT - Static variable in class org.sonar.api.config.EmailSettings
- SMTP_PASSWORD - Static variable in class org.sonar.api.config.EmailSettings
- SMTP_PASSWORD_DEFAULT - Static variable in class org.sonar.api.config.EmailSettings
- SMTP_PORT - Static variable in class org.sonar.api.config.EmailSettings
- SMTP_PORT_DEFAULT - Static variable in class org.sonar.api.config.EmailSettings
- SMTP_SECURE_CONNECTION - Static variable in class org.sonar.api.config.EmailSettings
- SMTP_SECURE_CONNECTION_DEFAULT - Static variable in class org.sonar.api.config.EmailSettings
- SMTP_USERNAME - Static variable in class org.sonar.api.config.EmailSettings
- SMTP_USERNAME_DEFAULT - Static variable in class org.sonar.api.config.EmailSettings
- SoftwareQuality - Enum in org.sonar.api.issue.impact
- SONAR_HOME - Static variable in interface org.sonar.api.CoreProperties
- SONAR_VALIDATE_WEBHOOKS_DEFAULT_VALUE - Static variable in interface org.sonar.api.CoreProperties
- SONAR_VALIDATE_WEBHOOKS_PROPERTY - Static variable in interface org.sonar.api.CoreProperties
- SONARCLOUD - org.sonar.api.SonarEdition
- SonarEdition - Enum in org.sonar.api
- SonarException - Exception in org.sonar.api.utils
-
Deprecated.in 4.4. Use standard exceptions like
IllegalArgumentException
orIllegalStateException
. UseMessageException
for raising errors to end-users without displaying stackstrace. - SonarException() - Constructor for exception org.sonar.api.utils.SonarException
-
Deprecated.
- SonarException(String) - Constructor for exception org.sonar.api.utils.SonarException
-
Deprecated.
- SonarException(String, Throwable) - Constructor for exception org.sonar.api.utils.SonarException
-
Deprecated.
- SonarException(Throwable) - Constructor for exception org.sonar.api.utils.SonarException
-
Deprecated.
- SONARLINT - org.sonar.api.SonarProduct
- SonarLintSide - Annotation Type in org.sonarsource.api.sonarlint
-
Marker annotation for all the components available in container of sonarlint.
- SonarProduct - Enum in org.sonar.api
-
List of different products/runtimes.
- SONARQUBE - org.sonar.api.SonarProduct
- SonarQubeSide - Enum in org.sonar.api
-
Runtime stack in SonarQube product.
- SonarRuntime - Interface in org.sonar.api
-
Information about runtime environment.
- sort() - Method in class org.sonar.api.utils.dag.DirectAcyclicGraph
- SORT - Static variable in class org.sonar.api.server.ws.WebService.Param
- SORTED_SCOPES - Static variable in class org.sonar.api.resources.Scopes
- sourceExclusions() - Method in class org.sonar.api.scan.filesystem.FileExclusions
-
Deprecated.
- sourceInclusions() - Method in class org.sonar.api.scan.filesystem.FileExclusions
-
Deprecated.
- sources() - Method in class org.sonar.api.batch.bootstrap.ProjectDefinition
-
Deprecated.
- SOURCES_PROPERTY - Static variable in class org.sonar.api.batch.bootstrap.ProjectDefinition
-
Deprecated.
- SQALE_DEBT_RATIO - Static variable in class org.sonar.api.measures.CoreMetrics
- SQALE_DEBT_RATIO_KEY - Static variable in class org.sonar.api.measures.CoreMetrics
- SQALE_RATING - Static variable in class org.sonar.api.measures.CoreMetrics
- SQALE_RATING_KEY - Static variable in class org.sonar.api.measures.CoreMetrics
- start() - Method in interface org.sonar.api.batch.fs.TextRange
-
Start position of the range
- start() - Method in interface org.sonar.api.batch.sensor.issue.MessageFormatting
-
The index of the first character in the string that will be formatted
- start() - Method in interface org.sonar.api.Startable
-
Start this component.
- start() - Method in class org.sonar.api.utils.log.Profiler
- start(int) - Method in interface org.sonar.api.batch.sensor.issue.NewMessageFormatting
- Startable - Interface in org.sonar.api
-
An interface which is implemented by classes annotated with
ScannerSide
,ServerSide
and/orComputeEngineSide
(referred to below as "component") that can be started and stopped. - startDebug(String) - Method in class org.sonar.api.utils.log.Profiler
- startInfo(String) - Method in class org.sonar.api.utils.log.Profiler
- startTrace(String) - Method in class org.sonar.api.utils.log.Profiler
- STATEMENTS - Static variable in class org.sonar.api.measures.CoreMetrics
- STATEMENTS_KEY - Static variable in class org.sonar.api.measures.CoreMetrics
- status() - Method in interface org.sonar.api.batch.fs.InputFile
- status() - Method in interface org.sonar.api.batch.rule.Rule
- status() - Method in interface org.sonar.api.ce.measure.Issue
-
Deprecated.since 10.4 in favor of
Issue.issueStatus()
- status() - Method in interface org.sonar.api.issue.Issue
-
Deprecated.since 10.4 in favor of
IssueStatus
- status() - Method in class org.sonar.api.server.rule.internal.DefaultRule
- status() - Method in class org.sonar.api.server.rule.RulesDefinition.Rule
- STATUS_BETA - Static variable in class org.sonar.api.rules.Rule
- STATUS_CLOSED - Static variable in interface org.sonar.api.issue.Issue
-
Deprecated.since 10.4 in favor of
IssueStatus
- STATUS_CONFIRMED - Static variable in interface org.sonar.api.issue.Issue
-
Deprecated.since 10.4 in favor of
IssueStatus
- STATUS_DEPRECATED - Static variable in class org.sonar.api.rules.Rule
- STATUS_IN_REVIEW - Static variable in interface org.sonar.api.issue.Issue
-
Deprecated.since 8.1, status has been mapped as `TO_REVIEW`
- STATUS_OPEN - Static variable in interface org.sonar.api.issue.Issue
-
Deprecated.since 10.4 in favor of
IssueStatus
- STATUS_READY - Static variable in class org.sonar.api.rules.Rule
- STATUS_REMOVED - Static variable in class org.sonar.api.rules.Rule
-
For internal use only.
- STATUS_REOPENED - Static variable in interface org.sonar.api.issue.Issue
-
Deprecated.since 10.4 in favor of
IssueStatus
- STATUS_RESOLVED - Static variable in interface org.sonar.api.issue.Issue
-
Deprecated.since 10.4 in favor of
IssueStatus
- STATUS_REVIEWED - Static variable in interface org.sonar.api.issue.Issue
-
Deprecated.since 10.4 as Security Hotspot are deprecated
- STATUS_TO_REVIEW - Static variable in interface org.sonar.api.issue.Issue
-
Deprecated.since 10.4 as Security Hotspot are deprecated
- STATUSES - Static variable in interface org.sonar.api.issue.Issue
-
Deprecated.since 10.4 in favor of
IssueStatus
- stop() - Method in interface org.sonar.api.Startable
-
Stop this component.
- stopDebug() - Method in class org.sonar.api.utils.log.Profiler
- stopDebug(String) - Method in class org.sonar.api.utils.log.Profiler
- stopInfo() - Method in class org.sonar.api.utils.log.Profiler
- stopInfo(boolean) - Method in class org.sonar.api.utils.log.Profiler
- stopInfo(String) - Method in class org.sonar.api.utils.log.Profiler
- stopTrace() - Method in class org.sonar.api.utils.log.Profiler
-
Works only if a message have been set in startXXX() methods.
- stopTrace(String) - Method in class org.sonar.api.utils.log.Profiler
- store(NewSignificantCode) - Method in interface org.sonar.api.batch.sensor.internal.SensorStorage
- store(NewCoverage) - Method in interface org.sonar.api.batch.sensor.internal.SensorStorage
- store(NewCpdTokens) - Method in interface org.sonar.api.batch.sensor.internal.SensorStorage
- store(AnalysisError) - Method in interface org.sonar.api.batch.sensor.internal.SensorStorage
- store(NewHighlighting) - Method in interface org.sonar.api.batch.sensor.internal.SensorStorage
- store(ExternalIssue) - Method in interface org.sonar.api.batch.sensor.internal.SensorStorage
- store(Issue) - Method in interface org.sonar.api.batch.sensor.internal.SensorStorage
- store(Measure) - Method in interface org.sonar.api.batch.sensor.internal.SensorStorage
- store(AdHocRule) - Method in interface org.sonar.api.batch.sensor.internal.SensorStorage
- store(NewSymbolTable) - Method in interface org.sonar.api.batch.sensor.internal.SensorStorage
- storeProperty(String, String) - Method in interface org.sonar.api.batch.sensor.internal.SensorStorage
-
Value is overridden if the key was already stored.
- stream() - Method in interface org.sonar.api.server.ws.Response
- StreamConsumer - Interface in org.sonar.api.utils.command
- STRING - org.sonar.api.batch.sensor.highlighting.TypeOfText
- STRING - org.sonar.api.measures.Metric.ValueType
- STRING - org.sonar.api.PropertyType
-
Basic single line input field
- STRING - Static variable in class org.sonar.api.server.rule.RuleParamType
- StringPatternValidator - Class in org.sonar.api.server.rule
-
Validates strings based on the defined regex.
- StringPatternValidator(String, String) - Constructor for class org.sonar.api.server.rule.StringPatternValidator
- StringStreamConsumer - Class in org.sonar.api.utils.command
- StringStreamConsumer() - Constructor for class org.sonar.api.utils.command.StringStreamConsumer
- STRUCTURED_COMMENT - org.sonar.api.batch.sensor.highlighting.TypeOfText
-
For example Javadoc
- SUB_VIEW - org.sonar.api.web.page.Page.Qualifier
- subCategory() - Method in class org.sonar.api.config.PropertyDefinition
-
Sub-category where property appears in settings pages.
- subCategory(String) - Method in class org.sonar.api.config.PropertyDefinition.Builder
- SubCategory - Class in org.sonar.api.config
- SUBCATEGORY_BRANCHES_AND_PULL_REQUESTS - Static variable in interface org.sonar.api.CoreProperties
- SUBCATEGORY_COVERAGE_EXCLUSIONS - Static variable in interface org.sonar.api.CoreProperties
- SUBCATEGORY_DATABASE_CLEANER - Static variable in interface org.sonar.api.CoreProperties
-
Deprecated.since 8.1. Database cleaning now has a dedicated category
CoreProperties.CATEGORY_HOUSEKEEPING
. - SUBCATEGORY_DIFFERENTIAL_VIEWS - Static variable in interface org.sonar.api.CoreProperties
- SUBCATEGORY_DUPLICATIONS - Static variable in interface org.sonar.api.CoreProperties
- SUBCATEGORY_DUPLICATIONS_EXCLUSIONS - Static variable in interface org.sonar.api.CoreProperties
- SUBCATEGORY_EMAIL - Static variable in interface org.sonar.api.CoreProperties
- SUBCATEGORY_FILES_EXCLUSIONS - Static variable in interface org.sonar.api.CoreProperties
- SUBCATEGORY_GENERAL - Static variable in interface org.sonar.api.CoreProperties
- SUBCATEGORY_ISSUES - Static variable in interface org.sonar.api.CoreProperties
- SUBCATEGORY_L10N - Static variable in interface org.sonar.api.CoreProperties
- SUBCATEGORY_LOOKNFEEL - Static variable in interface org.sonar.api.CoreProperties
- SUBCATEGORY_MODULES - Static variable in interface org.sonar.api.CoreProperties
- SUBCATEGORY_QUALITY_GATE - Static variable in interface org.sonar.api.CoreProperties
- subtract(Duration) - Method in class org.sonar.api.utils.Duration
-
Subtract the given duration to the current one.
- SUBVIEW - org.sonar.api.ce.measure.Component.Type
- SUBVIEW - Static variable in class org.sonar.api.resources.Qualifiers
-
Sub-portfolios, defined in root portfolios.
- SUCCESS - org.sonar.api.ce.posttask.CeTask.Status
- supports(File) - Method in class org.sonar.api.batch.scm.ScmProvider
-
Whether this provider is able to manage files located in this directory.
- System2 - Class in org.sonar.api.utils
-
Proxy over
System
. - System2() - Constructor for class org.sonar.api.utils.System2
T
- TAG_BUG - Static variable in class org.sonar.api.server.rule.RuleTagsToTypeConverter
-
Deprecated.
- TAG_SECURITY - Static variable in class org.sonar.api.server.rule.RuleTagsToTypeConverter
-
Deprecated.
- tags() - Method in interface org.sonar.api.issue.Issue
- tags() - Method in class org.sonar.api.server.rule.internal.DefaultRule
- tags() - Method in class org.sonar.api.server.rule.RulesDefinition.Rule
- target() - Method in interface org.sonar.api.batch.sensor.issue.fix.InputFileEdit
- TASK - Static variable in interface org.sonar.api.CoreProperties
-
Deprecated.since 7.6
- TECHNICAL_DEBT - Static variable in class org.sonar.api.measures.CoreMetrics
- TECHNICAL_DEBT_KEY - Static variable in class org.sonar.api.measures.CoreMetrics
- TempFolder - Interface in org.sonar.api.utils
-
Use this component to deal with temp files/folders.
- template() - Method in class org.sonar.api.server.rule.internal.DefaultRule
- template() - Method in class org.sonar.api.server.rule.RulesDefinition.Rule
- templateRuleKey() - Method in interface org.sonar.api.batch.rule.ActiveRule
-
Optional rule key of the template rule.
- TEST - org.sonar.api.batch.fs.InputFile.Type
- TEST - org.sonar.api.rule.RuleScope
- TEST_ERRORS - Static variable in class org.sonar.api.measures.CoreMetrics
- TEST_ERRORS_KEY - Static variable in class org.sonar.api.measures.CoreMetrics
- TEST_EXECUTION_TIME - Static variable in class org.sonar.api.measures.CoreMetrics
- TEST_EXECUTION_TIME_KEY - Static variable in class org.sonar.api.measures.CoreMetrics
- TEST_FAILURES - Static variable in class org.sonar.api.measures.CoreMetrics
- TEST_FAILURES_KEY - Static variable in class org.sonar.api.measures.CoreMetrics
- TEST_SUCCESS_DENSITY - Static variable in class org.sonar.api.measures.CoreMetrics
- TEST_SUCCESS_DENSITY_KEY - Static variable in class org.sonar.api.measures.CoreMetrics
- TESTED - org.sonar.api.rules.CleanCodeAttribute
- testExclusions() - Method in class org.sonar.api.scan.filesystem.FileExclusions
-
Deprecated.
- testInclusions() - Method in class org.sonar.api.scan.filesystem.FileExclusions
-
Deprecated.
- tests() - Method in class org.sonar.api.batch.bootstrap.ProjectDefinition
-
Deprecated.
- TESTS - Static variable in class org.sonar.api.measures.CoreMetrics
-
Value of measure for this metric can be saved from Sensor, taking into account following rules: Non-zero value should be saved for resources representing tests.
- TESTS_KEY - Static variable in class org.sonar.api.measures.CoreMetrics
- TESTS_PROPERTY - Static variable in class org.sonar.api.batch.bootstrap.ProjectDefinition
-
Deprecated.
- TEXT - org.sonar.api.PropertyType
-
Multiple line text-area
- TEXT - Static variable in class org.sonar.api.server.rule.RuleParamType
- TEXT_QUERY - Static variable in class org.sonar.api.server.ws.WebService.Param
- TextEdit - Interface in org.sonar.api.batch.sensor.issue.fix
-
Represents a text edit, composed of a replacement text and the text range to replace
- textEdits() - Method in interface org.sonar.api.batch.sensor.issue.fix.InputFileEdit
- TextPointer - Interface in org.sonar.api.batch.fs
-
Represents a position in a text file
InputFile
- textRange() - Method in interface org.sonar.api.batch.sensor.issue.IssueLocation
-
Range of the issue.
- textRange() - Method in interface org.sonar.api.scan.issue.filter.FilterableIssue
-
Deprecated.
- TextRange - Interface in org.sonar.api.batch.fs
-
Represents a text range in an
InputFile
. - TimeoutException - Exception in org.sonar.api.utils.command
-
Unchecked version of
TimeoutException
- TimeoutException(Command, String, Throwable) - Constructor for exception org.sonar.api.utils.command.TimeoutException
- TimeUtils - Class in org.sonar.api.utils
- toCommandLine() - Method in class org.sonar.api.utils.command.Command
- TokensLine - Class in org.sonar.api.batch.sensor.cpd.internal
-
Immutable code fragment, which formed from tokens of one line.
- TokensLine(int, int, int, String) - Constructor for class org.sonar.api.batch.sensor.cpd.internal.TokensLine
- toMinutes() - Method in class org.sonar.api.utils.Duration
-
Return the duration in minutes.
- toString() - Method in interface org.sonar.api.batch.fs.InputFile
-
Return a string to identify this file (suitable for logs).
- toString() - Method in class org.sonar.api.batch.scm.BlameLine
- toString() - Method in class org.sonar.api.config.Category
- toString() - Method in class org.sonar.api.config.GlobalPropertyChangeHandler.PropertyChange
- toString() - Method in class org.sonar.api.config.PropertyDefinition
- toString() - Method in class org.sonar.api.measures.Metric
- toString() - Method in class org.sonar.api.profiles.ProfileExporter
-
Deprecated.
- toString() - Method in class org.sonar.api.profiles.ProfileImporter
-
Deprecated.
- toString() - Method in class org.sonar.api.profiles.RulesProfile
- toString() - Method in class org.sonar.api.resources.AbstractLanguage
- toString() - Method in class org.sonar.api.resources.ResourceType
- toString() - Method in class org.sonar.api.resources.ResourceTypeTree
- toString() - Method in class org.sonar.api.rule.RuleKey
-
Format is "repository:rule", for example "squid:AvoidCycle"
- toString() - Method in class org.sonar.api.rules.ActiveRule
- toString() - Method in class org.sonar.api.rules.Rule
- toString() - Method in class org.sonar.api.rules.RuleParam
- toString() - Method in class org.sonar.api.security.UserDetails
- toString() - Method in class org.sonar.api.server.debt.internal.DefaultDebtRemediationFunction
- toString() - Method in class org.sonar.api.server.profile.BuiltInQualityProfilesDefinition.BuiltInActiveRule
- toString() - Method in class org.sonar.api.server.profile.BuiltInQualityProfilesDefinition.BuiltInQualityProfileImpl
- toString() - Method in class org.sonar.api.server.profile.BuiltInQualityProfilesDefinition.NewBuiltInActiveRule
- toString() - Method in class org.sonar.api.server.profile.BuiltInQualityProfilesDefinition.NewBuiltInQualityProfileImpl
- toString() - Method in class org.sonar.api.server.rule.internal.DefaultNewRepository
- toString() - Method in class org.sonar.api.server.rule.internal.DefaultRepository
- toString() - Method in class org.sonar.api.server.rule.internal.DefaultRule
- toString() - Method in class org.sonar.api.server.rule.RuleParamType
- toString() - Method in class org.sonar.api.server.ws.WebService.Action
- toString() - Method in class org.sonar.api.server.ws.WebService.NewParam
- toString() - Method in class org.sonar.api.server.ws.WebService.Param
- toString() - Method in class org.sonar.api.utils.command.Command
- toString() - Method in class org.sonar.api.utils.dag.Node
- toString() - Method in class org.sonar.api.utils.Duration
- toString() - Method in exception org.sonar.api.utils.MessageException
- toString() - Method in class org.sonar.api.utils.ValidationMessages
- toString() - Method in class org.sonar.api.utils.Version
- toString() - Method in class org.sonar.api.utils.WildcardPattern
-
Returns string representation of this pattern.
- total() - Method in class org.sonar.api.utils.Paging
-
Total number of items.
- trace(String) - Method in interface org.sonar.api.utils.log.Logger
-
Deprecated.Logs a TRACE message.
- trace(String) - Method in class org.sonar.api.utils.log.Slf4jLogger
- trace(String, Object) - Method in interface org.sonar.api.utils.log.Logger
-
Deprecated.Logs an TRACE parameterized message according to the specified format and argument.
- trace(String, Object) - Method in class org.sonar.api.utils.log.Slf4jLogger
- trace(String, Object...) - Method in interface org.sonar.api.utils.log.Logger
-
Deprecated.Logs an TRACE parameterized message according to the specified format and arguments.
- trace(String, Object...) - Method in class org.sonar.api.utils.log.Slf4jLogger
- trace(String, Object, Object) - Method in interface org.sonar.api.utils.log.Logger
-
Deprecated.Logs an TRACE parameterized message according to the specified format and arguments.
- trace(String, Object, Object) - Method in class org.sonar.api.utils.log.Slf4jLogger
- trace(Supplier<String>) - Method in interface org.sonar.api.utils.log.Logger
-
Deprecated.Logs a TRACE message, which is only to be constructed if the logging level is such that the message will actually be logged.
- TRACE - org.sonar.api.utils.log.LoggerLevel
-
Deprecated.
- truncateToSeconds(long) - Static method in class org.sonar.api.utils.DateUtils
- truncateToSeconds(Date) - Static method in class org.sonar.api.utils.DateUtils
- TRUSTWORTHY - org.sonar.api.rules.CleanCodeAttribute
- type() - Method in interface org.sonar.api.batch.fs.IndexedFile
-
Does it contain main or test code ?
- type() - Method in interface org.sonar.api.batch.fs.InputFile
-
Does it contain main or test code ?
- type() - Method in interface org.sonar.api.batch.sensor.issue.ExternalIssue
-
Deprecated.since 10.1, use
ExternalIssue.impacts()
instead - type() - Method in interface org.sonar.api.batch.sensor.issue.Issue.Flow
- type() - Method in interface org.sonar.api.batch.sensor.issue.MessageFormatting
-
Type of the text that will be formatted
- type() - Method in interface org.sonar.api.batch.sensor.rule.AdHocRule
-
Deprecated.since 10.1, use
AdHocRule.defaultImpacts()
instead - type() - Method in interface org.sonar.api.ce.measure.Issue
-
Deprecated.since 10.1, use
Issue.impacts()
instead - type() - Method in class org.sonar.api.config.PropertyDefinition
- type() - Method in class org.sonar.api.config.PropertyFieldDefinition
- type() - Method in annotation type org.sonar.api.Property
- type() - Method in annotation type org.sonar.api.PropertyField
- type() - Method in interface org.sonar.api.server.debt.DebtRemediationFunction
- type() - Method in class org.sonar.api.server.debt.internal.DefaultDebtRemediationFunction
- type() - Method in class org.sonar.api.server.rule.internal.DefaultNewParam
- type() - Method in class org.sonar.api.server.rule.internal.DefaultParam
- type() - Method in class org.sonar.api.server.rule.internal.DefaultRule
- type() - Method in class org.sonar.api.server.rule.RuleParamType
- type() - Method in interface org.sonar.api.server.rule.RulesDefinition.Param
- type() - Method in class org.sonar.api.server.rule.RulesDefinition.Rule
-
Deprecated.since 10.1, use
RulesDefinition.Rule.defaultImpacts()
instead - type(MessageFormatting.Type) - Method in interface org.sonar.api.batch.sensor.issue.NewMessageFormatting
- type(PropertyType) - Method in class org.sonar.api.config.PropertyDefinition.Builder
- type(PropertyType) - Method in class org.sonar.api.config.PropertyFieldDefinition.Builder
- type(RuleType) - Method in interface org.sonar.api.batch.sensor.issue.NewExternalIssue
-
Deprecated.since 10.1, use {@link #addImpact(SoftwareQuality softwareQuality, org.sonar.api.issue.impact.Severity severity)()} instead
- type(RuleType) - Method in interface org.sonar.api.batch.sensor.rule.NewAdHocRule
-
Deprecated.since 10.1, use impacts with
NewAdHocRule.addDefaultImpact(SoftwareQuality, org.sonar.api.issue.impact.Severity)
instead - TypeOfText - Enum in org.sonar.api.batch.sensor.highlighting
-
Possible types for highlighting code.
U
- UnauthorizedException - Exception in org.sonar.api.server.authentication
-
This exception should be used when a functional error is generated by an Identity Provider plugin.
- UnauthorizedException(String) - Constructor for exception org.sonar.api.server.authentication.UnauthorizedException
- UnauthorizedException(String, Throwable) - Constructor for exception org.sonar.api.server.authentication.UnauthorizedException
- UNCONFIRM - Static variable in interface org.sonar.api.issue.DefaultTransitions
-
Deprecated.since 10.4. There is no replacement as `org.sonar.api.issue.DefaultTransitions.CONFIRM` is subject to removal in the future.
- UNCOVERED_CONDITIONS - Static variable in class org.sonar.api.measures.CoreMetrics
- UNCOVERED_CONDITIONS_KEY - Static variable in class org.sonar.api.measures.CoreMetrics
- UNCOVERED_LINES - Static variable in class org.sonar.api.measures.CoreMetrics
- UNCOVERED_LINES_KEY - Static variable in class org.sonar.api.measures.CoreMetrics
- UNDEFINED - org.sonar.api.batch.sensor.issue.NewIssue.FlowType
- UNIT_TEST_FILE - Static variable in class org.sonar.api.resources.Qualifiers
- unzip(File, File) - Static method in class org.sonar.api.utils.ZipUtils
-
Unzip a file into a directory.
- unzip(File, File, Predicate<ZipEntry>) - Static method in class org.sonar.api.utils.ZipUtils
-
Unzip a file to a directory.
- unzip(InputStream, File) - Static method in class org.sonar.api.utils.ZipUtils
-
Unzip a file input stream to a directory.
- unzip(InputStream, File, long) - Static method in class org.sonar.api.utils.ZipUtils
-
Unzip a file input stream to a directory.
- unzip(InputStream, File, Long, Predicate<ZipEntry>) - Static method in class org.sonar.api.utils.ZipUtils
-
Unzip a file to a directory.
- unzip(InputStream, File, Predicate<ZipEntry>) - Static method in class org.sonar.api.utils.ZipUtils
-
Unzip a file to a directory.
- updateDate() - Method in interface org.sonar.api.issue.Issue
- uri() - Method in interface org.sonar.api.batch.fs.IndexedFile
-
Identifier of the file.
- uri() - Method in interface org.sonar.api.batch.fs.InputPath
-
Identifier of the component.
- UriReader - Class in org.sonar.api.utils
-
Reads different types of URI.
- UriReader(UriReader.SchemeProcessor[]) - Constructor for class org.sonar.api.utils.UriReader
- UriReader.SchemeProcessor - Class in org.sonar.api.utils
- UrlPattern - Class in org.sonar.api.web
- UrlPattern.Builder - Class in org.sonar.api.web
- User - Interface in org.sonar.api.user
- USER - Static variable in annotation type org.sonar.api.web.UserRole
- USER_LOGIN - org.sonar.api.PropertyType
-
User login
- UserDetails - Class in org.sonar.api.security
-
This class is not intended to be subclassed by clients.
- UserDetails() - Constructor for class org.sonar.api.security.UserDetails
- UserGroupValidation - Class in org.sonar.api.user
- UserIdentity - Class in org.sonar.api.server.authentication
-
User information provided by the Identity Provider to be register into the platform.
- UserIdentity.Builder - Class in org.sonar.api.server.authentication
- UserQuery - Class in org.sonar.api.user
- UserQuery.Builder - Class in org.sonar.api.user
- UserRole - Annotation Type in org.sonar.api.web
- USERS - Static variable in class org.sonar.api.security.DefaultGroups
- usesBaseEffort() - Method in enum org.sonar.api.server.debt.DebtRemediationFunction.Type
- usesGapMultiplier() - Method in enum org.sonar.api.server.debt.DebtRemediationFunction.Type
V
- V3_2 - org.sonar.api.server.rule.RulesDefinition.PciDssVersion
- V4_0 - org.sonar.api.server.rule.RulesDefinition.OwaspAsvsVersion
- V4_0 - org.sonar.api.server.rule.RulesDefinition.PciDssVersion
- validate(String) - Method in class org.sonar.api.config.PropertyDefinition
- validate(String) - Method in class org.sonar.api.config.PropertyFieldDefinition
- validate(String) - Static method in class org.sonar.api.server.rule.RuleTagFormat
- validate(String) - Method in class org.sonar.api.server.rule.StringPatternValidator
- validate(Collection<String>) - Static method in class org.sonar.api.server.rule.RuleTagFormat
- validate(Collection<String>) - Method in class org.sonar.api.server.rule.StringPatternValidator
- validate(PropertyType, String, List<String>) - Static method in class org.sonar.api.config.PropertyDefinition
- validateGroupName(String) - Static method in class org.sonar.api.user.UserGroupValidation
- ValidatingRequest - Class in org.sonar.api.server.ws.impl
- ValidatingRequest() - Constructor for class org.sonar.api.server.ws.impl.ValidatingRequest
- ValidationMessages - Class in org.sonar.api.utils
- validatorWithCommonPatternForKeys(String) - Static method in class org.sonar.api.server.rule.StringPatternValidator
- validKey(String) - Method in class org.sonar.api.config.PropertyDefinitions
- value() - Method in annotation type org.sonar.api.batch.DependedUpon
-
Used only on classes.
- value() - Method in annotation type org.sonar.api.batch.DependsUpon
-
Used only on classes.
- value() - Method in annotation type org.sonar.api.batch.InstantiationStrategy
-
Deprecated.
- value() - Method in interface org.sonar.api.batch.sensor.measure.Measure
-
Value of the measure.
- value() - Method in annotation type org.sonar.api.Properties
- value() - Method in enum org.sonar.api.server.ws.WebService.SelectionMode
- value() - Method in annotation type org.sonar.api.web.UserRole
- value(boolean) - Method in class org.sonar.api.utils.text.JsonWriter
-
Deprecated.Encodes
value
. - value(double) - Method in class org.sonar.api.utils.text.JsonWriter
-
Deprecated.
- value(long) - Method in class org.sonar.api.utils.text.JsonWriter
-
Deprecated.
- value(Number) - Method in class org.sonar.api.utils.text.JsonWriter
-
Deprecated.
- value(String) - Method in class org.sonar.api.utils.text.JsonWriter
-
Deprecated.
- valueDate(Date) - Method in class org.sonar.api.utils.text.JsonWriter
-
Deprecated.
- valueDateTime(Date) - Method in class org.sonar.api.utils.text.JsonWriter
-
Deprecated.
- valueObject(Object) - Method in class org.sonar.api.utils.text.JsonWriter
-
Deprecated.Encodes an object that can be a : primitive types: String, Number, Boolean java.util.Date: encoded as datetime (see
JsonWriter.valueDateTime(java.util.Date)
Map<Object, Object>
. - valueOf(int) - Static method in enum org.sonar.api.rules.RuleType
-
Deprecated.Returns the enum constant of the specified DB column value.
- valueOf(String) - Static method in enum org.sonar.api.batch.fs.InputFile.Status
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.sonar.api.batch.fs.InputFile.Type
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.sonar.api.batch.Phase.Name
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.sonar.api.batch.rule.Severity
-
Deprecated.Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.sonar.api.batch.sensor.highlighting.TypeOfText
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.sonar.api.batch.sensor.issue.MessageFormatting.Type
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.sonar.api.batch.sensor.issue.NewIssue.FlowType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.sonar.api.ce.measure.Component.Type
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.sonar.api.ce.posttask.Branch.Type
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.sonar.api.ce.posttask.CeTask.Status
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.sonar.api.ce.posttask.QualityGate.EvaluationStatus
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.sonar.api.ce.posttask.QualityGate.Operator
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.sonar.api.ce.posttask.QualityGate.Status
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.sonar.api.issue.impact.Severity
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.sonar.api.issue.impact.SoftwareQuality
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.sonar.api.issue.IssueStatus
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.sonar.api.measures.Metric.Level
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.sonar.api.measures.Metric.ValueType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.sonar.api.PropertyType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.sonar.api.rule.RuleScope
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.sonar.api.rule.RuleStatus
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.sonar.api.rules.CleanCodeAttribute
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.sonar.api.rules.CleanCodeAttributeCategory
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.sonar.api.rules.RulePriority
-
Deprecated.Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.sonar.api.rules.RuleType
-
Deprecated.Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.sonar.api.server.debt.DebtRemediationFunction.Type
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.sonar.api.server.rule.RulesDefinition.CweVersion
-
Deprecated.Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.sonar.api.server.rule.RulesDefinition.OwaspAsvsVersion
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.sonar.api.server.rule.RulesDefinition.OwaspTop10
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.sonar.api.server.rule.RulesDefinition.OwaspTop10Version
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.sonar.api.server.rule.RulesDefinition.PciDssVersion
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.sonar.api.server.ws.WebService.SelectionMode
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.sonar.api.SonarEdition
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.sonar.api.SonarProduct
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.sonar.api.SonarQubeSide
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.sonar.api.utils.log.LoggerLevel
-
Deprecated.Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.sonar.api.web.page.Page.Qualifier
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.sonar.api.web.page.Page.Scope
-
Returns the enum constant of this type with the specified name.
- valueOfInt(int) - Static method in enum org.sonar.api.rules.RulePriority
-
Deprecated.
- valueOfNullable(int) - Static method in enum org.sonar.api.rules.RuleType
-
Deprecated.
- values() - Static method in enum org.sonar.api.batch.fs.InputFile.Status
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum org.sonar.api.batch.fs.InputFile.Type
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum org.sonar.api.batch.Phase.Name
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum org.sonar.api.batch.rule.Severity
-
Deprecated.Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum org.sonar.api.batch.sensor.highlighting.TypeOfText
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum org.sonar.api.batch.sensor.issue.MessageFormatting.Type
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum org.sonar.api.batch.sensor.issue.NewIssue.FlowType
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum org.sonar.api.ce.measure.Component.Type
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum org.sonar.api.ce.posttask.Branch.Type
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum org.sonar.api.ce.posttask.CeTask.Status
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum org.sonar.api.ce.posttask.QualityGate.EvaluationStatus
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum org.sonar.api.ce.posttask.QualityGate.Operator
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum org.sonar.api.ce.posttask.QualityGate.Status
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum org.sonar.api.issue.impact.Severity
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum org.sonar.api.issue.impact.SoftwareQuality
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum org.sonar.api.issue.IssueStatus
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum org.sonar.api.measures.Metric.Level
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum org.sonar.api.measures.Metric.ValueType
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum org.sonar.api.PropertyType
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum org.sonar.api.rule.RuleScope
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum org.sonar.api.rule.RuleStatus
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum org.sonar.api.rules.CleanCodeAttribute
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum org.sonar.api.rules.CleanCodeAttributeCategory
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum org.sonar.api.rules.RulePriority
-
Deprecated.Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum org.sonar.api.rules.RuleType
-
Deprecated.Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum org.sonar.api.server.debt.DebtRemediationFunction.Type
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Method in class org.sonar.api.server.rule.RuleParamType
- values() - Static method in enum org.sonar.api.server.rule.RulesDefinition.CweVersion
-
Deprecated.Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum org.sonar.api.server.rule.RulesDefinition.OwaspAsvsVersion
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum org.sonar.api.server.rule.RulesDefinition.OwaspTop10
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum org.sonar.api.server.rule.RulesDefinition.OwaspTop10Version
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum org.sonar.api.server.rule.RulesDefinition.PciDssVersion
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum org.sonar.api.server.ws.WebService.SelectionMode
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum org.sonar.api.SonarEdition
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum org.sonar.api.SonarProduct
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum org.sonar.api.SonarQubeSide
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum org.sonar.api.utils.log.LoggerLevel
-
Deprecated.Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum org.sonar.api.web.page.Page.Qualifier
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum org.sonar.api.web.page.Page.Scope
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values(Iterable<String>) - Method in class org.sonar.api.utils.text.JsonWriter
-
Deprecated.Write a list of values in an array, for example:
- values(String...) - Method in class org.sonar.api.utils.text.CsvWriter
- valueType() - Method in interface org.sonar.api.batch.measure.Metric
- valueType() - Method in class org.sonar.api.measures.Metric
- verifyCsrfState() - Method in interface org.sonar.api.server.authentication.OAuth2IdentityProvider.CallbackContext
-
Check that the state is valid.
- verifyCsrfState(String) - Method in interface org.sonar.api.server.authentication.OAuth2IdentityProvider.CallbackContext
-
Check that the state is valid The state will be read from the given parameter name of the HTTP request It should only be called If
OAuth2IdentityProvider.InitContext.generateCsrfState()
was used in the init - Version - Class in org.sonar.api.utils
-
Version composed of maximum four fields (major, minor, patch and build ID numbers) and optionally a qualifier.
- VIEW - org.sonar.api.ce.measure.Component.Type
- VIEW - org.sonar.api.web.page.Page.Qualifier
- VIEW - Static variable in class org.sonar.api.resources.Qualifiers
-
Root portfolios.
- VIOLATIONS - Static variable in class org.sonar.api.measures.CoreMetrics
- VIOLATIONS_KEY - Static variable in class org.sonar.api.measures.CoreMetrics
- VULNERABILITIES - Static variable in class org.sonar.api.measures.CoreMetrics
-
Deprecated.since 10.7. Use
CoreMetrics.SECURITY_ISSUES
instead. - VULNERABILITIES_KEY - Static variable in class org.sonar.api.measures.CoreMetrics
-
Deprecated.since 10.7. Use
CoreMetrics.SECURITY_ISSUES_KEY
instead. - VULNERABILITY - org.sonar.api.rules.RuleType
-
Deprecated.
W
- warn(String) - Method in interface org.sonar.api.utils.log.Logger
-
Deprecated.Logs a WARN level message.
- warn(String) - Method in class org.sonar.api.utils.log.Slf4jLogger
- warn(String, Object) - Method in interface org.sonar.api.utils.log.Logger
-
Deprecated.Logs a WARN parameterized message according to the specified format and argument.
- warn(String, Object) - Method in class org.sonar.api.utils.log.Slf4jLogger
- warn(String, Object...) - Method in interface org.sonar.api.utils.log.Logger
-
Deprecated.Logs a WARN parameterized message according to the specified format and arguments.
- warn(String, Object...) - Method in class org.sonar.api.utils.log.Slf4jLogger
- warn(String, Object, Object) - Method in interface org.sonar.api.utils.log.Logger
-
Deprecated.Logs a WARN parameterized message according to the specified format and arguments.
- warn(String, Object, Object) - Method in class org.sonar.api.utils.log.Slf4jLogger
- warn(String, Throwable) - Method in interface org.sonar.api.utils.log.Logger
-
Deprecated.Logs an exception at the WARN level with an accompanying message.
- warn(String, Throwable) - Method in class org.sonar.api.utils.log.Slf4jLogger
- WARN - org.sonar.api.utils.log.LoggerLevel
-
Deprecated.
- WebAnalytics - Interface in org.sonar.api.web
-
Extension point to support a web analytics tool like Matomo or Google Analytics in the webapp.
- WebService - Interface in org.sonar.api.server.ws
-
Defines a web service.
- WebService.Action - Class in org.sonar.api.server.ws
- WebService.Context - Class in org.sonar.api.server.ws
- WebService.Controller - Class in org.sonar.api.server.ws
- WebService.NewAction - Class in org.sonar.api.server.ws
- WebService.NewController - Class in org.sonar.api.server.ws
- WebService.NewParam - Class in org.sonar.api.server.ws
- WebService.Param - Class in org.sonar.api.server.ws
- WebService.SelectionMode - Enum in org.sonar.api.server.ws
- WildcardPattern - Class in org.sonar.api.utils
-
Implementation of Ant-style matching patterns.
- WildcardPattern(String, String) - Constructor for class org.sonar.api.utils.WildcardPattern
- withConfigKey(String) - Method in class org.sonar.api.rules.RuleQuery
- withKey(String) - Method in class org.sonar.api.rules.RuleQuery
- withNewText(String) - Method in interface org.sonar.api.batch.sensor.issue.fix.NewTextEdit
-
Prior to 6.4, line returns had to be represented with the '\n' character.
- withPageSize(int) - Method in class org.sonar.api.utils.Paging.Builder
- withRepositoryKey(String) - Method in class org.sonar.api.rules.RuleQuery
- withValue(G) - Method in interface org.sonar.api.batch.sensor.measure.NewMeasure
-
Value of the measure.
- WONT_FIX - Static variable in interface org.sonar.api.issue.DefaultTransitions
-
Deprecated.since 10.3, use
DefaultTransitions.ACCEPT
instead - WONT_FIX_ISSUES - Static variable in class org.sonar.api.measures.CoreMetrics
-
Deprecated.since 10.3. Use
CoreMetrics.ACCEPTED_ISSUES
instead. - WONT_FIX_ISSUES_KEY - Static variable in class org.sonar.api.measures.CoreMetrics
-
Deprecated.since 10.3. Use
CoreMetrics.ACCEPTED_ISSUES_KEY
instead. - WORK_DUR - org.sonar.api.measures.Metric.ValueType
- workDir() - Method in interface org.sonar.api.batch.fs.FileSystem
-
Absolute work directory.
- WORKING_DIRECTORY - Static variable in interface org.sonar.api.CoreProperties
- WORKING_DIRECTORY_DEFAULT_VALUE - Static variable in interface org.sonar.api.CoreProperties
- write(String, byte[]) - Method in interface org.sonar.api.batch.sensor.cache.WriteCache
-
Save a new entry in the cache.
- write(String, InputStream) - Method in interface org.sonar.api.batch.sensor.cache.WriteCache
-
Save a new entry in the cache.
- WriteCache - Interface in org.sonar.api.batch.sensor.cache
- WriterException - Exception in org.sonar.api.utils.text
- WriterException(String) - Constructor for exception org.sonar.api.utils.text.WriterException
- WriterException(String, Throwable) - Constructor for exception org.sonar.api.utils.text.WriterException
X
- XmlWriter - Class in org.sonar.api.utils.text
-
TODO document that output is UTF-8
Y
- Y2017 - org.sonar.api.server.rule.RulesDefinition.OwaspTop10Version
- Y2020 - org.sonar.api.server.rule.RulesDefinition.CweVersion
-
Deprecated.
- Y2021 - org.sonar.api.server.rule.RulesDefinition.CweVersion
-
Deprecated.
- Y2021 - org.sonar.api.server.rule.RulesDefinition.OwaspTop10Version
Z
- zipDir(File, File) - Static method in class org.sonar.api.utils.ZipUtils
- ZipUtils - Class in org.sonar.api.utils
-
Utility to zip directories and unzip files.
All Classes All Packages