com.btkelly.gnag.utils

Class ViolationFormatter

java.lang.Object

com.btkelly.gnag.utils.ViolationFormatter

public final class ViolationFormatter
extends java.lang.Object

Creates formatted HTML strings representing individual violations.

Method Summary

Modifier and Type	Method and Description
static java.lang.String	getHtmlStringForAggregatedComment(@NotNull Violation violation) Use this method to create a formatted HTML string representing a violation that will be posted as part of an aggregated comment.
static java.lang.String	getHtmlStringForInlineComment(@NotNull Violation violation) Use this method to create a formatted HTML string representing a violation that will be posted as an inline comment.

Methods inherited from class java.lang.Object

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

Method Detail

getHtmlStringForInlineComment

public static java.lang.String getHtmlStringForInlineComment(@NotNull
                                                             @NotNull Violation violation)

Use this method to create a formatted HTML string representing a violation that will be posted as an inline comment. Only intended for use when posting inline comments to GitHub.

getHtmlStringForAggregatedComment

public static java.lang.String getHtmlStringForAggregatedComment(@NotNull
                                                                 @NotNull Violation violation)

Use this method to create a formatted HTML string representing a violation that will be posted as part of an aggregated comment. Intended for use when generating the local Gnag report, and when posting aggregated comments to GitHub.