net.adamcin.oakpal.api

Class SimpleProgressCheckFactoryCheck<FACTORY extends ProgressCheckFactory>

java.lang.Object

net.adamcin.oakpal.api.SimpleProgressCheck

net.adamcin.oakpal.api.SimpleProgressCheckFactoryCheck<FACTORY>

Type Parameters:

FACTORY - the factory type parameter

All Implemented Interfaces:

ProgressCheck, ScanListener, ViolationReporter

@ConsumerType
public class SimpleProgressCheckFactoryCheck<FACTORY extends ProgressCheckFactory>
extends SimpleProgressCheck

Convenience type for simple progress checks that are identified by their factory.

Field Summary

Fields inherited from class net.adamcin.oakpal.api.SimpleProgressCheck

collector

Constructor Summary

Constructors

Constructor and Description
SimpleProgressCheckFactoryCheck(Class<FACTORY> factoryClass) Need to keep a handle on the concrete class.

Method Summary

Modifier and Type	Method and Description
String	getCheckName() Return an optional label for displaying reports made by this reporter.
@Nullable String	getResourceBundleBaseName() Get the resource bundle base name for loading the default resource bundle for this violation reporter.

Methods inherited from class net.adamcin.oakpal.api.SimpleProgressCheck

getReportedViolations, getResourceBundle, getString, majorViolation, minorViolation, reporting, reportViolation, reportViolation, setResourceBundle, severeViolation, startedScan

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, identifyPackage, identifySubpackage, importedPath, importedPath, readManifest

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

finishedScan

Constructor Detail

SimpleProgressCheckFactoryCheck

public SimpleProgressCheckFactoryCheck(Class<FACTORY> factoryClass)

Need to keep a handle on the concrete class.

Parameters:

factoryClass - the factory class

Method Detail

getCheckName

public String getCheckName()

Description copied from interface: ProgressCheck

Return an optional label for displaying reports made by this reporter.

Returns:

an optional display label for this reporter.

getResourceBundleBaseName

@Nullable
public @Nullable String getResourceBundleBaseName()

Description copied from interface: ViolationReporter

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