Package com.optum.sourcehawk.core.result

Class FixResult

java.lang.Object

com.optum.sourcehawk.core.result.FixResult

All Implemented Interfaces:

Serializable

public final class FixResult
extends Object
implements Serializable

The result of a fix

Author:

Brian Wyka

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FixResult.FixResultBuilder
static class	FixResult.MessageDescriptor	Encapsulates all of the traits of a fix result message

Method Summary

Modifier and Type	Method	Description
static FixResult.FixResultBuilder	builder()
boolean	equals(Object o)
int	getErrorCount()	The number of errors which occurred
int	getFixCount()	The number of fixes made
@NonNull Collection<String>	getFormattedMessages()	Messages formatted for reporting
@NonNull Map<String,Collection<FixResult.MessageDescriptor>>	getMessages()	All of the messages associated with the scan
int	hashCode()
boolean	isError()	Whether or not an error occurred during fix
boolean	isFixesApplied()	Whether or not fixes were applied
boolean	isNoResolver()	Whether or not there was a resolver to use
static FixResult	reduce(FixResult one, FixResult two)	Reduce two FixResults into one
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

reduce

public static FixResult reduce(FixResult one,
                               FixResult two)

Reduce two FixResults into one

Parameters:

one - the first fix result

two - the second fix result

Returns:

the reduced fix result

builder

public static FixResult.FixResultBuilder builder()

isNoResolver

public boolean isNoResolver()

Whether or not there was a resolver to use

isFixesApplied

public boolean isFixesApplied()

Whether or not fixes were applied

isError

public boolean isError()

Whether or not an error occurred during fix

getFixCount

public int getFixCount()

The number of fixes made

getErrorCount

public int getErrorCount()

The number of errors which occurred

getMessages

@NonNull
public @NonNull Map<String,Collection<FixResult.MessageDescriptor>> getMessages()

All of the messages associated with the scan

Key: Repository File Path Value: Collection of FixResult.MessageDescriptor

getFormattedMessages

@NonNull
public @NonNull 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