Package com.e1c.g5.v8.dt.internal.bsl.check.comment

Class DocumentationCommentDelegatingCheck

java.lang.Object

com.e1c.g5.v8.dt.check.components.BasicCheck

com.e1c.g5.v8.dt.internal.bsl.check.comment.DocumentationCommentDelegatingCheck

All Implemented Interfaces:

ITopObjectFilter, ICheck

public final class DocumentationCommentDelegatingCheck
extends BasicCheck

The delegating check that performs processing of Module's methods documenting comments, builds the intermediary model and serves all dependent documenting comment checks with it

Nested Class Summary

Nested classes/interfaces inherited from class com.e1c.g5.v8.dt.check.components.BasicCheck

BasicCheck.CheckConfigurer, BasicCheck.CheckParameterBuilder, BasicCheck.ContainmentConfigurationBuilder, BasicCheck.DelegateCheckConfigurationBuilder, BasicCheck.ModuleConfigurationBuilder, BasicCheck.ResultAcceptor, BasicCheck.TopObjectConfigurationBuilder, BasicCheck.TopObjectFeatureConfigurationBuilder

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CHECK_ID	This check unique indentifier

Constructor Summary

Constructors

Constructor	Description
DocumentationCommentDelegatingCheck()

Method Summary

Modifier and Type	Method	Description
protected void	check(Object object, BasicCheck.ResultAcceptor resultAcceptor, ICheckParameters parameters, org.eclipse.core.runtime.IProgressMonitor progressMonitor)	The method that performs the check.
protected void	configureCheck(BasicCheck.CheckConfigurer configurer)	The check is performed in case of changes of the tracjed object model/language module changes.
String	getCheckId()	Gets the unique identifier of the check.

Methods inherited from class com.e1c.g5.v8.dt.check.components.BasicCheck

check, check, configureContextCollector, isCheckApplicable, postConfigureContextCollector

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.e1c.g5.v8.dt.check.ICheck

check, prepareContext, prepareContext

Field Details

CHECK_ID

public static final String CHECK_ID

This check unique indentifier

See Also:

• Constant Field Values

Constructor Details

DocumentationCommentDelegatingCheck

public DocumentationCommentDelegatingCheck()

Method Details

getCheckId

public String getCheckId()

Description copied from interface: ICheck

Gets the unique identifier of the check. The identifier should be unique. The system performs automated identifier conflict resolution in case of non-unique identifiers, with addition of conflict-resolving symbols to the identifier

Returns:

The identifier of the check. May not be null

check

protected void check(Object object,
 BasicCheck.ResultAcceptor resultAcceptor,
 ICheckParameters parameters,
 org.eclipse.core.runtime.IProgressMonitor progressMonitor)

Description copied from class: BasicCheck

The method that performs the check. Check results (issues) need to be placed into the result acceptor. Validation may be cancelled by a user. Complex implemantations should take this into the account and check IProgressMonitor.isCanceled() periodically during long-running operations.

Overrides:

check in class BasicCheck

Parameters:

object - The object to check, not null

resultAcceptor - Result acceptor, not null

parameters - The set of check execution parameters taken from check settings, not null

progressMonitor - Current check progress monitor, not null

configureCheck

protected void configureCheck(BasicCheck.CheckConfigurer configurer)

Description copied from class: BasicCheck

The check is performed in case of changes of the tracjed object model/language module changes. In order to define the rules of the check performing, the developer should define the set of EClass'es and their features those changes are being tracked/or be targets of the validation

Specified by:

configureCheck in class BasicCheck