Package org.sonar.api.batch.rule.internal

Class DefaultActiveRule

  • All Implemented Interfaces:
    ActiveRule
    @Immutable
public class DefaultActiveRule
extends java.lang.Object
implements ActiveRule

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      long createdAt()  
      java.lang.String internalKey()
      Optional key declared and used by the underlying rule engine.
      java.lang.String language()
      Language of rule, for example java
      java.lang.String param​(java.lang.String key)
      Value of given parameter.
      java.util.Map<java.lang.String,​java.lang.String> params()
      Immutable parameter values.
      java.lang.String qpKey()
      Key of the quality profile the rule belongs to.
      RuleKey ruleKey()  
      java.lang.String severity()
      Non-null severity.
      java.lang.String templateRuleKey()
      Optional rule key of the template rule.
      long updatedAt()  

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Method Detail

      • severity

        public java.lang.String severity()
        Description copied from interface: ActiveRule
        Non-null severity.
        Specified by:
        severity in interface ActiveRule
        See Also:
        Severity

      • language

        public java.lang.String language()
        Description copied from interface: ActiveRule
        Language of rule, for example java
        Specified by:
        language in interface ActiveRule

      • param

        public java.lang.String param​(java.lang.String key)
        Description copied from interface: ActiveRule
        Value of given parameter. Returns null if the parameter key does not exist on the rule or if the parameter has no value nor default value.
        Specified by:
        param in interface ActiveRule

      • params

        public java.util.Map<java.lang.String,​java.lang.String> params()
        Description copied from interface: ActiveRule
        Immutable parameter values. Returns an empty map if no parameters are defined.
        Specified by:
        params in interface ActiveRule

      • internalKey

        public java.lang.String internalKey()
        Description copied from interface: ActiveRule
        Optional key declared and used by the underlying rule engine. As an example the key of a Checkstyle rule looks like com.puppycrawl.tools.checkstyle.checks.FooCheck whereas its internal key can be Checker/TreeWalker/Foo.
        Specified by:
        internalKey in interface ActiveRule

      • templateRuleKey

        public java.lang.String templateRuleKey()
        Description copied from interface: ActiveRule
        Optional rule key of the template rule.
        Specified by:
        templateRuleKey in interface ActiveRule

      • createdAt

        public long createdAt()

      • updatedAt

        public long updatedAt()

      • qpKey

        public java.lang.String qpKey()
        Description copied from interface: ActiveRule
        Key of the quality profile the rule belongs to.
        Specified by:
        qpKey in interface ActiveRule