Package cdc.issues.checks

Class AbstractChecker<O>

java.lang.Object

cdc.issues.checks.AbstractChecker<O>

Type Parameters:

O - The checked object type.

All Implemented Interfaces:

cdc.util.debug.Printable

Direct Known Subclasses:

AbstractPartChecker, AbstractRuleChecker, CompositeChecker, LazyChecker

public abstract class AbstractChecker<O>
extends Object
implements cdc.util.debug.Printable

Base abstract class of checkers.

Author:

Damien Carbonne

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractChecker(SnapshotManager manager, Class<O> objectClass)	Create a checker.

Method Summary

Modifier and Type	Method	Description
boolean	accepts(O object)	Returns true if the passed object must be checked.
protected void	addStat(Location location, CheckResult result)	Add statistics entry.
CheckResult	check(CheckContext context, LocatedObject<? extends O> data)
abstract CheckResult	check(CheckContext context, O object, Location location)	Method that must be specialized to check an object.
protected static <O> void	checkAndStat(AbstractChecker<? super O> checker, CheckContext context, LocatedObject<? extends O> data)
protected static <O> void	checkAndStat(AbstractChecker<? super O> checker, CheckContext context, O object, Location location)
SnapshotManager	getManager()
Class<O>	getObjectClass()
abstract boolean	isEnabled()

Methods inherited from class java.lang.Object

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

Methods inherited from interface cdc.util.debug.Printable

indent, print, print

Constructor Detail

AbstractChecker

protected AbstractChecker(SnapshotManager manager,
                          Class<O> objectClass)

Create a checker.

Parameters:

manager - The manager.

objectClass - The object class.

Method Detail

checkAndStat

protected static <O> void checkAndStat(AbstractChecker<? super O> checker,
                                       CheckContext context,
                                       O object,
                                       Location location)

checkAndStat

protected static <O> void checkAndStat(AbstractChecker<? super O> checker,
                                       CheckContext context,
                                       LocatedObject<? extends O> data)

getManager

public final SnapshotManager getManager()

Returns:

The SnapshotManager.

getObjectClass

public final Class<O> getObjectClass()

Returns:

The class of checked objects.

isEnabled

public abstract boolean isEnabled()

Returns:

true if this checker is enabled.

addStat

protected final void addStat(Location location,
                             CheckResult result)

Add statistics entry.

Parameters:

location - The checked object.

result - The check result.

accepts

public boolean accepts(O object)

Returns true if the passed object must be checked.

A check may be applied to an object only if some conditions are met.
This may be overridden to define such conditions.
The default implementation always returns true.

Parameters:

object - The object to test.

Returns:

true if this checker accepts object.

check

public abstract CheckResult check(CheckContext context,
                                  O object,
                                  Location location)

Method that must be specialized to check an object.

It is this method responsibility to store detected issues into the associated manager.

Parameters:

context - The context.

object - The object to check.

location - The object location.

Returns:

The check result.

check

public final CheckResult check(CheckContext context,
                               LocatedObject<? extends O> data)