eu.cqse.check.framework.core

Annotation Type Check

@Documented
 @Retention(value=RUNTIME)
 @Target(value=TYPE)
 @IndexAnnotated
public @interface Check

Annotation that marks a class as custom check and provides some meta-data for it.

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
java.lang.String	description Returns the description.
java.lang.String	groupName Returns the analysis-group name.
ELanguage[]	languages Returns all supported languages.
java.lang.String	name Returns the name.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
java.lang.String	categoryName Returns the analysis name of the analysis category.
EFindingEnablement	defaultEnablement Returns the default enablement.
ECheckParameter[]	parameters Returns all parameters that must be provided to the check.
java.lang.Class<? extends IGlobalExtractionPhase<?,?>>[]	phases The pre-run extraction phases that are needed for this check to run.

Element Detail

name

public abstract java.lang.String name

Returns the name.

description

public abstract java.lang.String description

Returns the description.

groupName

public abstract java.lang.String groupName

Returns the analysis-group name.

languages

public abstract ELanguage[] languages

Returns all supported languages.

categoryName

public abstract java.lang.String categoryName

Returns the analysis name of the analysis category.

Default:

"Code Anomalies"

defaultEnablement

public abstract EFindingEnablement defaultEnablement

Returns the default enablement.

Default:

eu.cqse.check.framework.core.EFindingEnablement.YELLOW

parameters

public abstract ECheckParameter[] parameters

Returns all parameters that must be provided to the check.

Default:

{}

phases

public abstract java.lang.Class<? extends IGlobalExtractionPhase<?,?>>[] phases

The pre-run extraction phases that are needed for this check to run.

Default:

{}