Class Rule


  • final class Rule
    extends java.lang.Object
    Object which represents reportingDescriptor in run.driver.rules property. (ยง3.19.23)
    See Also:
    3.49 reportingDescriptor object
    • Field Summary

      Fields 
      Modifier and Type Field Description
      (package private) int cweid  
      (package private) java.lang.String defaultText  
      (package private) java.lang.String fullDescription  
      (package private) java.net.URI helpUri  
      (package private) java.lang.String id  
      (package private) java.lang.String shortDescription  
      (package private) java.util.List<java.lang.String> tags  
    • Constructor Summary

      Constructors 
      Constructor Description
      Rule​(java.lang.String id, java.lang.String shortDescription, java.lang.String fullDescription, java.lang.String defaultText, java.net.URI helpUri, java.util.List<java.lang.String> tags, int cweid)  
    • Field Detail

      • id

        @NonNull
        final java.lang.String id
      • shortDescription

        @NonNull
        final java.lang.String shortDescription
      • fullDescription

        @NonNull
        final java.lang.String fullDescription
      • defaultText

        @NonNull
        final java.lang.String defaultText
      • helpUri

        @Nullable
        final java.net.URI helpUri
      • tags

        @NonNull
        final java.util.List<java.lang.String> tags
    • Constructor Detail

    • Method Detail

      • toJsonObject

        com.google.gson.JsonObject toJsonObject()
      • createCweRelationship

        private com.google.gson.JsonObject createCweRelationship()
      • fromBugPattern

        @NonNull
        static Rule fromBugPattern​(BugPattern bugPattern,
                                   java.lang.String formattedMessage)