Package com.optum.sourcehawk.exec.scan

Class ScanResultLogger

java.lang.Object

com.optum.sourcehawk.exec.AbstractExecResultLogger<ScanResult>

com.optum.sourcehawk.exec.scan.ScanResultLogger

public class ScanResultLogger
extends AbstractExecResultLogger<ScanResult>

A logger for scan results

Author:

Brian Wyka

See Also:

ScanResult, OutputFormat

Field Summary

Fields inherited from class com.optum.sourcehawk.exec.AbstractExecResultLogger

JSON_WRITER

Method Summary

Modifier and Type	Method	Description
static ScanResultLogger	create()
protected String	formatMarkdown(ScanResult scanResult, Verbosity verbosity)	Format the result for markdown output format
protected Collection<Pair<Severity,Pair<String,String>>>	formatTextMessages(ScanResult scanResult)	Format the result messages for text output
protected Pair<Severity,String>	formatTextSummary(ScanResult scanResult)	Format the summary for plain text output format

Methods inherited from class com.optum.sourcehawk.exec.AbstractExecResultLogger

formatJson, log

Methods inherited from class java.lang.Object

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

Method Detail

formatTextSummary

protected Pair<Severity,String> formatTextSummary(ScanResult scanResult)

Format the summary for plain text output format

Specified by:

formatTextSummary in class AbstractExecResultLogger<ScanResult>

Parameters:

scanResult - the result

Returns:

the formatted text output for the summary

formatTextMessages

protected Collection<Pair<Severity,Pair<String,String>>> formatTextMessages(ScanResult scanResult)

Format the result messages for text output

Specified by:

formatTextMessages in class AbstractExecResultLogger<ScanResult>

Parameters:

scanResult - the result

Returns:

the formatted text log statements

formatMarkdown

protected String formatMarkdown(ScanResult scanResult,
                                Verbosity verbosity)

Format the result for markdown output format

Specified by:

formatMarkdown in class AbstractExecResultLogger<ScanResult>

Parameters:

scanResult - the result

verbosity - the output verbosity

Returns:

the formatted markdown output

create

public static ScanResultLogger create()