eu.cqse.check.framework.core

Class CheckInfo

java.lang.Object

eu.cqse.check.framework.core.CheckInfo

public class CheckInfo
extends java.lang.Object

A check info contains information about a custom check.

Constructor Summary

Constructors

Constructor and Description

CheckInfo(java.lang.Class<?> checkClass, java.lang.String name, java.lang.String description, java.lang.String groupName, java.lang.String categoryName, EFindingEnablement defaultEnablement, ELanguage[] languages, ECheckParameter[] parameters, java.lang.Class<? extends IGlobalExtractionPhase<?,?>>[] phases, java.util.LinkedHashMap<java.lang.String,CheckOptionWrapper<?>> options) Creates a new check info with the given parameters.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCategoryName()
java.lang.String	getCheckClassName() Returns the full class name of the check.
EFindingEnablement	getDefaultEnablement() Returns the default enablement.
java.lang.String	getDescription() Returns the description.
java.lang.String	getGroupName() Returns the analysis group name.
java.lang.String	getIdentifier() Returns a unique identifier for this check.
java.lang.String	getName() Returns the name.
UnmodifiableMap<java.lang.String,CheckOptionWrapper<?>>	getOptions() Returns all options that can be provided to this check.
java.util.Set<ECheckParameter>	getParameters() Returns the parameters that must be provided to this check.
java.util.Set<java.lang.Class<? extends IGlobalExtractionPhase<?,?>>>	getRequiredPhases()
java.lang.String	getSimpleClassName() Returns the simple class name of the check.
java.util.Set<ELanguage>	getSupportedLanguages() Returns the supported languages.
CheckImplementationBase	instantiateCheckImplementation() Creates a new instance of the underlying check implementation.

Methods inherited from class java.lang.Object

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

Constructor Detail

CheckInfo

public CheckInfo(java.lang.Class<?> checkClass,
                 java.lang.String name,
                 java.lang.String description,
                 java.lang.String groupName,
                 java.lang.String categoryName,
                 EFindingEnablement defaultEnablement,
                 ELanguage[] languages,
                 ECheckParameter[] parameters,
                 java.lang.Class<? extends IGlobalExtractionPhase<?,?>>[] phases,
                 java.util.LinkedHashMap<java.lang.String,CheckOptionWrapper<?>> options)

Creates a new check info with the given parameters. None of them must be null.

Method Detail

instantiateCheckImplementation

public CheckImplementationBase instantiateCheckImplementation()
                                                       throws CheckException

Creates a new instance of the underlying check implementation.

Throws:

CheckException

getName

public java.lang.String getName()

Returns the name.

getDescription

public java.lang.String getDescription()

Returns the description.

getGroupName

public java.lang.String getGroupName()

Returns the analysis group name.

getCategoryName

public java.lang.String getCategoryName()

See Also:

categoryName

getDefaultEnablement

public EFindingEnablement getDefaultEnablement()

Returns the default enablement.

getSupportedLanguages

public java.util.Set<ELanguage> getSupportedLanguages()

Returns the supported languages.

getRequiredPhases

public java.util.Set<java.lang.Class<? extends IGlobalExtractionPhase<?,?>>> getRequiredPhases()

See Also:

phases

getParameters

public java.util.Set<ECheckParameter> getParameters()

Returns the parameters that must be provided to this check.

getOptions

public UnmodifiableMap<java.lang.String,CheckOptionWrapper<?>> getOptions()

Returns all options that can be provided to this check. This is an UnmodifiableMap backed by a LinkedHashMap since that preserves the order of options (the order in which they are defined in the custom check).

getIdentifier

public java.lang.String getIdentifier()

Returns a unique identifier for this check.

getSimpleClassName

public java.lang.String getSimpleClassName()

Returns the simple class name of the check.

getCheckClassName

public java.lang.String getCheckClassName()

Returns the full class name of the check.