net.adamcin.oakpal.api

Class SimpleProgressCheck

java.lang.Object

net.adamcin.oakpal.api.SimpleProgressCheck

All Implemented Interfaces:

ProgressCheck, ScanListener, ViolationReporter

Direct Known Subclasses:

SimpleProgressCheckFactoryCheck

@ConsumerType
public class SimpleProgressCheck
extends Object
implements ProgressCheck

Simple implementation of a ProgressCheck with convenient methods for reporting and collecting violations.

Field Summary

Fields

Modifier and Type	Field and Description
protected ReportCollector	collector

Constructor Summary

Constructors

Constructor and Description
SimpleProgressCheck()

Method Summary

Modifier and Type	Method and Description
Collection<Violation>	getReportedViolations() Called at the end of execution to collect any detected violations.
protected @Nullable ResourceBundle	getResourceBundle() Used by getString(String) to retrieve localized messages.
protected @NotNull String	getString(@NotNull String key) Lookup a localized string from the resource bundle.
protected void	majorViolation(String description, org.apache.jackrabbit.vault.packaging.PackageId... packages)
protected void	minorViolation(String description, org.apache.jackrabbit.vault.packaging.PackageId... packages)
protected void	reporting(@NotNull Consumer<SimpleViolation.Builder> customizer) Report a violation with a customizing consumer function.
protected void	reportViolation(Severity severity, String description, org.apache.jackrabbit.vault.packaging.PackageId... packages)
protected void	reportViolation(Violation violation)
void	setResourceBundle(ResourceBundle resourceBundle) Called by the framework before a scan to provide a resource bundle for immediate localization of strings.
protected void	severeViolation(String description, org.apache.jackrabbit.vault.packaging.PackageId... packages)
void	startedScan() Called once at the beginning of the scan to notify for re-initialization of listener state.

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.adamcin.oakpal.api.ProgressCheck

afterExtract, beforeExtract, deletedPath, getCheckName, identifyPackage, identifySubpackage, importedPath, importedPath, readManifest

Methods inherited from interface net.adamcin.oakpal.api.ScanListener

finishedScan

Methods inherited from interface net.adamcin.oakpal.api.ViolationReporter

getResourceBundleBaseName

Field Detail

collector

protected final ReportCollector collector

Constructor Detail

SimpleProgressCheck

public SimpleProgressCheck()

Method Detail

setResourceBundle

public void setResourceBundle(ResourceBundle resourceBundle)

Description copied from interface: ViolationReporter

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

Specified by:

setResourceBundle in interface ViolationReporter

Parameters:

resourceBundle - the resource bundle

getResourceBundle

@Nullable
protected @Nullable ResourceBundle getResourceBundle()
                                                        throws MissingResourceException

Used by getString(String) to retrieve localized messages. NOTE: If this method is called before a non-null ResourceBundle has been injected via ViolationReporter.setResourceBundle(ResourceBundle), it will try to get a fallback ResourceBundle by calling ResourceBundle.getBundle(String), which invokes the default classloader and locale behavior, using ViolationReporter.getResourceBundleBaseName() as the resource bundle base name.

Returns:

the resource bundle

Throws:

MissingResourceException

See Also:

ResourceBundle.getBundle(String), ViolationReporter.getResourceBundleBaseName()

getString

@NotNull
protected @NotNull String getString(@NotNull
                                             @NotNull String key)

Lookup a localized string from the resource bundle.

Parameters:

key - the i18n key

Returns:

the localized string

Throws:

MissingResourceException - if an attempt is made to load a missing ResourceBundle

reportViolation

protected void reportViolation(Violation violation)

reporting

protected final void reporting(@NotNull
                               @NotNull Consumer<SimpleViolation.Builder> customizer)

Report a violation with a customizing consumer function.

Parameters:

customizer - the customizing consumer function

reportViolation

protected final void reportViolation(Severity severity,
                                     String description,
                                     org.apache.jackrabbit.vault.packaging.PackageId... packages)

minorViolation

protected final void minorViolation(String description,
                                    org.apache.jackrabbit.vault.packaging.PackageId... packages)

majorViolation

protected final void majorViolation(String description,
                                    org.apache.jackrabbit.vault.packaging.PackageId... packages)

severeViolation

protected final void severeViolation(String description,
                                     org.apache.jackrabbit.vault.packaging.PackageId... packages)

startedScan

public void startedScan()

Description copied from interface: ScanListener

Called once at the beginning of the scan to notify for re-initialization of listener state.

Specified by:

startedScan in interface ScanListener

getReportedViolations

public Collection<Violation> getReportedViolations()

Description copied from interface: ViolationReporter

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

Specified by:

getReportedViolations in interface ViolationReporter

Returns:

any reported violations.