com.puppycrawl.tools.checkstyle

Class SarifLogger

java.lang.Object

com.puppycrawl.tools.checkstyle.api.AutomaticBean

com.puppycrawl.tools.checkstyle.SarifLogger

All Implemented Interfaces:

AuditListener, Configurable, Contextualizable, java.util.EventListener

public class SarifLogger
extends AutomaticBean
implements AuditListener

Simple SARIF logger. SARIF stands for the static analysis results interchange format. Reference: https://sarifweb.azurewebsites.net/

Nested Class Summary

Nested classes/interfaces inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean

AutomaticBean.OutputStreamOptions

Constructor Summary

Constructors

Constructor and Description
SarifLogger(java.io.OutputStream outputStream, AutomaticBean.OutputStreamOptions outputStreamOptions) Creates a new SarifLogger instance.

Method Summary

Modifier and Type	Method and Description
void	addError(AuditEvent event) Notify that an audit error was discovered on a specific file.
void	addException(AuditEvent event, java.lang.Throwable throwable) Notify that an exception happened while performing audit.
void	auditFinished(AuditEvent event) Notify that the audit is finished.
void	auditStarted(AuditEvent event) Notify that the audit is about to start.
static java.lang.String	escape(java.lang.String value) Escape \b, \f, \n, \r, \t, \", \\ and U+0000 through U+001F.
void	fileFinished(AuditEvent event) Notify that audit is finished on a specific file.
void	fileStarted(AuditEvent event) Notify that audit is about to start on a specific file.
protected void	finishLocalSetup() Provides a hook to finish the part of this component's setup that was not handled by the bean introspection.
static java.lang.String	readResource(java.lang.String name) Read string from given resource.

Methods inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean

configure, contextualize, getConfiguration, setupChild

Methods inherited from class java.lang.Object

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

Constructor Detail

SarifLogger

public SarifLogger(java.io.OutputStream outputStream,
                   AutomaticBean.OutputStreamOptions outputStreamOptions)
            throws java.io.IOException

Creates a new SarifLogger instance.

Parameters:

outputStream - where to log audit events

outputStreamOptions - if CLOSE that should be closed in auditFinished()

Throws:

java.lang.IllegalArgumentException - if outputStreamOptions is null

java.io.IOException - if there is reading errors.

Method Detail

finishLocalSetup

protected void finishLocalSetup()

Description copied from class: AutomaticBean

Provides a hook to finish the part of this component's setup that was not handled by the bean introspection.

The default implementation does nothing.

Specified by:

finishLocalSetup in class AutomaticBean

auditStarted

public void auditStarted(AuditEvent event)

Description copied from interface: AuditListener

Notify that the audit is about to start.

Specified by:

auditStarted in interface AuditListener

Parameters:

event - the event details

auditFinished

public void auditFinished(AuditEvent event)

Notify that the audit is finished. Following idea suppressions are false positives

Specified by:

auditFinished in interface AuditListener

Parameters:

event - the event details

addError

public void addError(AuditEvent event)

Notify that an audit error was discovered on a specific file. Following idea suppressions are false positives

Specified by:

addError in interface AuditListener

Parameters:

event - the event details

addException

public void addException(AuditEvent event,
                         java.lang.Throwable throwable)

Notify that an exception happened while performing audit. Following idea suppressions are false positives

Specified by:

addException in interface AuditListener

Parameters:

event - the event details

throwable - details of the exception

fileStarted

public void fileStarted(AuditEvent event)

Description copied from interface: AuditListener

Notify that audit is about to start on a specific file.

Specified by:

fileStarted in interface AuditListener

Parameters:

event - the event details

fileFinished

public void fileFinished(AuditEvent event)

Description copied from interface: AuditListener

Notify that audit is finished on a specific file.

Specified by:

fileFinished in interface AuditListener

Parameters:

event - the event details

escape

public static java.lang.String escape(java.lang.String value)

Escape \b, \f, \n, \r, \t, \", \\ and U+0000 through U+001F. Reference: https://www.ietf.org/rfc/rfc4627.txt - 2.5. Strings

Parameters:

value - the value to escape.

Returns:

the escaped value if necessary.

readResource

public static java.lang.String readResource(java.lang.String name)
                                     throws java.io.IOException

Read string from given resource.

Parameters:

name - name of the desired resource

Returns:

the string content from the give resource

Throws:

java.io.IOException - if there is reading errors