Class Rule

java.lang.Object
edu.umd.cs.findbugs.sarif.Rule
final class Rule extends Object
Object which represents reportingDescriptor in run.driver.rules property. (ยง3.19.23)
See Also:

  • Field Details

    • LOGGER

      private static final Logger LOGGER

    • id

      final @NonNull String id

    • shortDescription

      final @NonNull String shortDescription

    • fullDescription

      final @NonNull String fullDescription

    • defaultText

      final @NonNull String defaultText

    • helpUri

      final @Nullable URI helpUri

    • tags

      final @NonNull List<String> tags

    • cweid

      final int cweid

  • Constructor Details

    • Rule

      Rule(@NonNull String id, @NonNull String shortDescription, @NonNull String fullDescription, @NonNull String defaultText, @Nullable URI helpUri, @NonNull List<String> tags, int cweid)

  • Method Details

    • toJsonObject

      com.google.gson.JsonObject toJsonObject()

    • createCweRelationship

      private com.google.gson.JsonObject createCweRelationship()

    • convertHtmlToPlainText

      private String convertHtmlToPlainText(String htmlText)
      Converts HTML text to plain text for use in SARIF output.
      Parameters:
      htmlText - the HTML text to convert
      Returns:
      plain text representation, or a default message if conversion fails

    • fromBugPattern

      static @NonNull Rule fromBugPattern(BugPattern bugPattern, String formattedMessage)