Package org.sonar.api.rules

Class Rule

  • public class Rule
extends java.lang.Object

    • Field Detail

      • STATUS_BETA

        public static final java.lang.String STATUS_BETA
        Since:
        3.6
        See Also:
        Constant Field Values

      • STATUS_DEPRECATED

        public static final java.lang.String STATUS_DEPRECATED
        Since:
        3.6
        See Also:
        Constant Field Values

      • STATUS_READY

        public static final java.lang.String STATUS_READY
        Since:
        3.6
        See Also:
        Constant Field Values

      • STATUS_REMOVED

        public static final java.lang.String STATUS_REMOVED
        For internal use only.
        Since:
        3.6
        See Also:
        Constant Field Values

      • DEFAULT_PRIORITY

        public static final RulePriority DEFAULT_PRIORITY
        The default priority given to a rule if not explicitly set

    • Constructor Detail

      • Rule

        @Deprecated
public Rule()
        Deprecated.
        since 2.3. Use the factory method create()

      • Rule

        @Deprecated
public Rule​(java.lang.String pluginName,
            java.lang.String key)
        Deprecated.
        since 2.3. Use the factory method create()
        Creates rule with minimum set of info
        Parameters:
        pluginName - the plugin name indicates which plugin the rule belongs to
        key - the key should be unique within a plugin, but it is even more careful for the time being that it is unique across the application

    • Method Detail

      • getId

        @Deprecated
public java.lang.Integer getId()
        Deprecated.
        since 8.4. Use ruleKey() instead

      • getName

        public java.lang.String getName()

      • setName

        public Rule setName​(java.lang.String name)
        Sets the rule name

      • getKey

        public java.lang.String getKey()

      • setKey

        public Rule setKey​(java.lang.String key)
        Sets the rule key

      • getConfigKey

        public java.lang.String getConfigKey()

      • setConfigKey

        public Rule setConfigKey​(java.lang.String configKey)
        Sets the configuration key

      • getDescription

        public java.lang.String getDescription()

      • setDescription

        public Rule setDescription​(java.lang.String description)
        Sets the rule description

      • isEnabled

        public java.lang.Boolean isEnabled()

      • getParams

        public java.util.List<RuleParam> getParams()

      • getParam

        public RuleParam getParam​(java.lang.String key)

      • setParams

        public Rule setParams​(java.util.List<RuleParam> params)
        Sets the rule parameters

      • createParameter

        public RuleParam createParameter()

      • createParameter

        public RuleParam createParameter​(java.lang.String key)

      • getSeverity

        public RulePriority getSeverity()
        Since:
        2.5

      • setSeverity

        public Rule setSeverity​(@Nullable
                        RulePriority severity)
        Parameters:
        severity - severity to set, if null, uses the default priority.
        Since:
        2.5

      • getRepositoryKey

        public java.lang.String getRepositoryKey()

      • setRepositoryKey

        public Rule setRepositoryKey​(java.lang.String s)

      • setUniqueKey

        public Rule setUniqueKey​(java.lang.String repositoryKey,
                         java.lang.String key)

      • isTemplate

        public boolean isTemplate()
        Since:
        4.4

      • setIsTemplate

        public Rule setIsTemplate​(boolean isTemplate)
        Since:
        4.4

      • getCardinality

        @Deprecated
public org.sonar.check.Cardinality getCardinality()
        Deprecated.
        since 4.4, use isTemplate()

      • setCardinality

        @Deprecated
public Rule setCardinality​(org.sonar.check.Cardinality c)
        Deprecated.
        since 4.4, use setIsTemplate(boolean)

      • getParent

        @Deprecated
public Rule getParent()
        Deprecated.
        since 4.4, use getTemplate()

      • getTemplate

        public Rule getTemplate()
        Since:
        4.4

      • setTemplate

        public Rule setTemplate​(Rule template)
        Since:
        4.4

      • getStatus

        public java.lang.String getStatus()
        Since:
        3.6

      • setStatus

        public Rule setStatus​(java.lang.String status)
        Since:
        3.6

      • getCreatedAt

        public java.util.Date getCreatedAt()
        Since:
        3.6

      • setCreatedAt

        public Rule setCreatedAt​(java.util.Date d)
        Since:
        3.6

      • getUpdatedAt

        public java.util.Date getUpdatedAt()
        Since:
        3.6

      • setUpdatedAt

        public Rule setUpdatedAt​(java.util.Date updatedAt)
        Since:
        3.6

      • getLanguage

        public java.lang.String getLanguage()
        Since:
        3.6

      • setLanguage

        public Rule setLanguage​(java.lang.String language)
        For internal use only.
        Since:
        3.6

      • getTags

        public java.lang.String[] getTags()
        For definition of rule only

      • setTags

        public Rule setTags​(java.lang.String[] tags)
        For definition of rule only

      • getSystemTags

        public java.lang.String[] getSystemTags()
        For internal use

      • setSystemTags

        public Rule setSystemTags​(java.lang.String[] tags)

      • getCharacteristicId

        @CheckForNull
@Deprecated
public java.lang.Integer getCharacteristicId()
        Deprecated.
        since 4.4, use getCharacteristicKey()
        For internal use only.
        Since:
        4.3

      • setCharacteristicId

        @Deprecated
public Rule setCharacteristicId​(@Nullable
                                java.lang.Integer characteristicId)
        Deprecated.
        since 4.4, use setCharacteristicKey(String)
        For internal use only.
        Since:
        4.3

      • getDefaultCharacteristicId

        @CheckForNull
@Deprecated
public java.lang.Integer getDefaultCharacteristicId()
        Deprecated.
        since 4.4, use getDefaultCharacteristicKey()
        For internal use only.
        Since:
        4.3

      • setDefaultCharacteristicId

        @Deprecated
public Rule setDefaultCharacteristicId​(@Nullable
                                       java.lang.Integer defaultCharacteristicId)
        Deprecated.
        since 4.4, use setDefaultCharacteristicKey(String)
        For internal use only.
        Since:
        4.3

      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class java.lang.Object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object

      • create

        public static Rule create()

      • create

        public static Rule create​(java.lang.String repositoryKey,
                          java.lang.String key,
                          java.lang.String name)
        Create with all required fields

      • create

        public static Rule create​(java.lang.String repositoryKey,
                          java.lang.String key)
        Create with all required fields
        Since:
        2.10

      • ruleKey

        public RuleKey ruleKey()
        Since:
        3.6

      • getDefaultCharacteristicKey

        @CheckForNull
@Deprecated
public java.lang.String getDefaultCharacteristicKey()
        Deprecated.
        in 5.5. SQALE Quality Model is replaced by SonarQube Quality Model.
        Since:
        4.4

      • setDefaultCharacteristicKey

        @Deprecated
public Rule setDefaultCharacteristicKey​(@Nullable
                                        java.lang.String defaultCharacteristicKey)
        Deprecated.
        in 5.5. SQALE Quality Model is replaced by SonarQube Quality Model.
        Since:
        4.4

      • getDefaultSubCharacteristicKey

        @CheckForNull
@Deprecated
public java.lang.String getDefaultSubCharacteristicKey()
        Deprecated.
        in 5.5. SQALE Quality Model is replaced by SonarQube Quality Model.
        Since:
        4.4

      • setDefaultSubCharacteristicKey

        @Deprecated
public Rule setDefaultSubCharacteristicKey​(@Nullable
                                           java.lang.String defaultSubCharacteristicKey)
        Deprecated.
        in 5.5. SQALE Quality Model is replaced by SonarQube Quality Model.
        Since:
        4.4

      • getCharacteristicKey

        @CheckForNull
@Deprecated
public java.lang.String getCharacteristicKey()
        Deprecated.
        in 5.5. SQALE Quality Model is replaced by SonarQube Quality Model.
        Since:
        4.4

      • setCharacteristicKey

        @Deprecated
public Rule setCharacteristicKey​(@Nullable
                                 java.lang.String characteristicKey)
        Deprecated.
        in 5.5. SQALE Quality Model is replaced by SonarQube Quality Model.
        Since:
        4.4

      • getSubCharacteristicKey

        @CheckForNull
@Deprecated
public java.lang.String getSubCharacteristicKey()
        Deprecated.
        in 5.5. SQALE Quality Model is replaced by SonarQube Quality Model.
        Since:
        4.4

      • setSubCharacteristicKey

        @Deprecated
public Rule setSubCharacteristicKey​(@Nullable
                                    java.lang.String subCharacteristicKey)
        Deprecated.
        in 5.5. SQALE Quality Model is replaced by SonarQube Quality Model.
        Since:
        4.4