net.adamcin.oakpal.api

Interface ViolationReporter

All Known Subinterfaces:

ProgressCheck

All Known Implementing Classes:

ReportCollector, SimpleProgressCheck, SimpleProgressCheckFactoryCheck

@ConsumerType
public interface ViolationReporter

Base interface for violation reporters.

Method Summary

Modifier and Type	Method and Description
Collection<Violation>	getReportedViolations() Called at the end of execution to collect any detected violations.
default @Nullable String	getResourceBundleBaseName() Get the resource bundle base name for loading the default resource bundle for this violation reporter.
default void	setResourceBundle(ResourceBundle resourceBundle) Called by the framework before a scan to provide a resource bundle for immediate localization of strings.

Method Detail

getResourceBundleBaseName

@Nullable
default @Nullable String getResourceBundleBaseName()

Get the resource bundle base name for loading the default resource bundle for this violation reporter. Returns getClass().getName() by default. If this method is overridden to return null, the oakpal framework will not attempt to load a parent resource bundle specific to this violation reporter when creating a resource bundle during initialization.

Returns:

the resource bundle base name

setResourceBundle

default void setResourceBundle(ResourceBundle resourceBundle)

Called by the framework before a scan to provide a resource bundle for immediate localization of strings.

Parameters:

resourceBundle - the resource bundle

getReportedViolations

Collection<Violation> getReportedViolations()

Called at the end of execution to collect any detected violations.

Returns:

any reported violations.