org.paninij.proc.check.capsule.decl

Class DeclCheck

java.lang.Object

org.paninij.proc.check.capsule.decl.DeclCheck

All Implemented Interfaces:

CapsuleCheck, Check

Direct Known Subclasses:

CheckDesignDecl, CheckInitDecl, CheckRunDecl

public abstract class DeclCheck
extends java.lang.Object
implements CapsuleCheck

An abstract class extended by checks. Subclasses are meant to check whether one of a capsule core's declarations is well-formed one. (`CheckForTooManyDecls` should probably be run before running any checks which extend this class.)

Nested Class Summary

Nested classes/interfaces inherited from interface org.paninij.proc.check.Check

Check.Result

Constructor Summary

Constructors

Constructor and Description
DeclCheck()

Method Summary

Modifier and Type	Method and Description
Check.Result	checkCapsule(javax.lang.model.element.TypeElement core)
abstract java.lang.String	getDeclName()
abstract java.lang.Class<? extends Check>	getErrorSource()
abstract boolean	hasValidParameters(javax.lang.model.element.TypeElement core, javax.lang.model.element.ExecutableElement decl)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.paninij.proc.check.capsule.CapsuleCheck

checkCapsule

Constructor Detail

DeclCheck

public DeclCheck()

Method Detail

getErrorSource

public abstract java.lang.Class<? extends Check> getErrorSource()

getDeclName

public abstract java.lang.String getDeclName()

hasValidParameters

public abstract boolean hasValidParameters(javax.lang.model.element.TypeElement core,
                                           javax.lang.model.element.ExecutableElement decl)

checkCapsule

public Check.Result checkCapsule(javax.lang.model.element.TypeElement core)

Specified by:

checkCapsule in interface CapsuleCheck

Parameters:

core - A type element for the capsule core to be checked.

Returns:

The result of the check.