net.adamcin.oakpal.core

Class SimpleReport

java.lang.Object

net.adamcin.oakpal.core.SimpleReport

All Implemented Interfaces:

net.adamcin.oakpal.api.JsonObjectConvertible, CheckReport

public final class SimpleReport
extends Object
implements CheckReport

Simple POJO implementing a CheckReport, used for deserialization.

Constructor Summary

Constructors

Constructor and Description
SimpleReport(String checkName, Collection<net.adamcin.oakpal.api.Violation> violations)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
static SimpleReport	fromJson(@NotNull javax.json.JsonObject jsonReport)
static SimpleReport	generateReport(@NotNull ErrorListener reporter)
static SimpleReport	generateReport(@NotNull net.adamcin.oakpal.api.ProgressCheck reporter)
String	getCheckName() The serialized display name of the package check that created the report.
@NotNull Collection<net.adamcin.oakpal.api.Violation>	getViolations() The reported violations.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.adamcin.oakpal.core.CheckReport

getViolations, toJson

Constructor Detail

SimpleReport

public SimpleReport(String checkName,
                    Collection<net.adamcin.oakpal.api.Violation> violations)

Method Detail

getCheckName

public String getCheckName()

Description copied from interface: CheckReport

The serialized display name of the package check that created the report.

Specified by:

getCheckName in interface CheckReport

Returns:

the serialized display name of the reporter.

getViolations

@NotNull
public @NotNull Collection<net.adamcin.oakpal.api.Violation> getViolations()

Description copied from interface: CheckReport

The reported violations.

Specified by:

getViolations in interface CheckReport

Returns:

the reported violations

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

generateReport

public static SimpleReport generateReport(@NotNull
                                          @NotNull net.adamcin.oakpal.api.ProgressCheck reporter)

generateReport

public static SimpleReport generateReport(@NotNull
                                          @NotNull ErrorListener reporter)

fromJson

public static SimpleReport fromJson(@NotNull
                                    @NotNull javax.json.JsonObject jsonReport)