java.lang.Object
- com.optum.sourcehawk.core.result.ScanResult

All Implemented Interfaces:

Serializable
```
public final class ScanResult
extends Object
implements Serializable
```
The result of a scan

Author:

Brian Wyka

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class ScanResult.MessageDescriptor
Encapsulates all of the traits of a message

static class ScanResult.ScanResultBuilder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static ScanResult.ScanResultBuilder`	`builder()`
`boolean`	`equals(Object o)`
`int`	`getErrorCount()`	The number of errors encountered during the scan
`Collection<String>`	`getFormattedMessages()`	Messages formatted for reporting Format: [SEVERITY] repositoryFilePath :: message
`Map<String,Collection<ScanResult.MessageDescriptor>>`	`getMessages()`	All of the messages associated with the scan Key: Repository File Path Value: Collection of `ScanResult.MessageDescriptor`
`int`	`getWarningCount()`	The number of warnings encountered during the scan
`int`	`hashCode()`
`boolean`	`isPassed()`	Whether or not the scan passed
`boolean`	`isPassedWithNoWarnings()`	Determine if the result is passed, AND has no warnings
`static ScanResult`	`passed()`	Constructs a "passed" instance of `ScanResult`
`static ScanResult`	`reduce(ScanResult one, ScanResult two)`	Reduce two `ScanResult`s into one
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Method Detail
  - isPassedWithNoWarnings
```
public boolean isPassedWithNoWarnings()
```
    Determine if the result is passed, AND has no warnings
    
    Returns:
    
    true if passed and has no warnings, false otherwise
  - passed
```
public static ScanResult passed()
```
    Constructs a "passed" instance of ScanResult
    
    Returns:
    
    the scan result
  - reduce
```
public static ScanResult reduce(ScanResult one,
                                ScanResult two)
```
    Reduce two ScanResults into one
    
    Parameters:
    
    one - the first scan result
    
    two - the second scan result
    
    Returns:
    
    the reduced scan result
  - builder
```
public static ScanResult.ScanResultBuilder builder()
```
  - isPassed
```
public boolean isPassed()
```
    Whether or not the scan passed
  - getErrorCount
```
public int getErrorCount()
```
    The number of errors encountered during the scan
  - getWarningCount
```
public int getWarningCount()
```
    The number of warnings encountered during the scan
  - getMessages
```
public Map<String,Collection<ScanResult.MessageDescriptor>> getMessages()
```
    All of the messages associated with the scan Key: Repository File Path Value: Collection of ScanResult.MessageDescriptor
  - getFormattedMessages
```
public Collection<String> getFormattedMessages()
```
    Messages formatted for reporting Format: [SEVERITY] repositoryFilePath :: message
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Modifier and Type	Class	Description
`static class`	`ScanResult.MessageDescriptor`	Encapsulates all of the traits of a message
`static class`	`ScanResult.ScanResultBuilder`

Class ScanResult

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

isPassedWithNoWarnings

passed

reduce

builder

isPassed

getErrorCount

getWarningCount

getMessages

getFormattedMessages

equals

hashCode

toString