Package edu.umd.cs.findbugs.sarif

Class Rule

java.lang.Object

edu.umd.cs.findbugs.sarif.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) @NonNull java.lang.String	defaultText
(package private) @NonNull java.lang.String	fullDescription
(package private) @Nullable java.net.URI	helpUri
(package private) @NonNull java.lang.String	id
private static java.util.logging.Logger	LOGGER
(package private) @NonNull java.lang.String	shortDescription
(package private) @NonNull java.util.List<java.lang.String>	tags

Constructor Summary

Constructors

Constructor	Description
Rule(@NonNull java.lang.String id, @NonNull java.lang.String shortDescription, @NonNull java.lang.String fullDescription, @NonNull java.lang.String defaultText, @Nullable java.net.URI helpUri, @NonNull java.util.List<java.lang.String> tags, int cweid)

Method Summary

Modifier and Type	Method	Description
private java.lang.String	convertHtmlToPlainText(java.lang.String htmlText)	Converts HTML text to plain text for use in SARIF output.
private com.google.gson.JsonObject	createCweRelationship()
(package private) static @NonNull Rule	fromBugPattern(BugPattern bugPattern, java.lang.String formattedMessage)
(package private) com.google.gson.JsonObject	toJsonObject()

Methods inherited from class java.lang.Object

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

Field Detail

LOGGER

private static final java.util.logging.Logger LOGGER

id

final @NonNull java.lang.String id

shortDescription

final @NonNull java.lang.String shortDescription

fullDescription

final @NonNull java.lang.String fullDescription

defaultText

final @NonNull java.lang.String defaultText

helpUri

final @Nullable java.net.URI helpUri

tags

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

cweid

final int cweid

Constructor Detail

Rule

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

Method Detail

toJsonObject

com.google.gson.JsonObject toJsonObject()

createCweRelationship

private com.google.gson.JsonObject createCweRelationship()

convertHtmlToPlainText

private java.lang.String convertHtmlToPlainText(java.lang.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,
                                    java.lang.String formattedMessage)