Package com.e1c.g5.v8.dt.bsl.check
Class DocumentationCommentBasicDelegateCheck
- java.lang.Object
-
- com.e1c.g5.v8.dt.check.components.BasicCheck
-
- com.e1c.g5.v8.dt.bsl.check.DocumentationCommentBasicDelegateCheck
-
- All Implemented Interfaces:
ITopObjectFilter
,ICheck
public abstract class DocumentationCommentBasicDelegateCheck extends BasicCheck
Basic documentation comment check. Delelopers should use it to perform easier validations of documenting comments
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
DocumentationCommentBasicDelegateCheck.DocumentationCommentResultAcceptor
Accepts results of the check in form ofIssue
's.-
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
-
-
Constructor Summary
Constructors Constructor Description DocumentationCommentBasicDelegateCheck()
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods 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 abstract void
checkDocumentationCommentObject(IDescriptionPart descriptionPart, BslDocumentationComment rootNode, DocumentationCommentBasicDelegateCheck.DocumentationCommentResultAcceptor resultAceptor, ICheckParameters parameters, org.eclipse.core.runtime.IProgressMonitor progressMonitor)
Checks the documentation comment model object.-
Methods inherited from class com.e1c.g5.v8.dt.check.components.BasicCheck
check, configureCheck, configureContextCollector, isCheckApplicable
-
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
getCheckId
-
-
-
-
Method Detail
-
check
protected final 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 checkIProgressMonitor.isCanceled()
periodically during long-running operations.- Specified by:
check
in classBasicCheck
- Parameters:
object
- The object to check, notnull
resultAcceptor
- Result acceptor, notnull
parameters
- The set of check execution parameters taken from check settings, notnull
progressMonitor
- Current check progress monitor, notnull
-
checkDocumentationCommentObject
protected abstract void checkDocumentationCommentObject(IDescriptionPart descriptionPart, BslDocumentationComment rootNode, DocumentationCommentBasicDelegateCheck.DocumentationCommentResultAcceptor resultAceptor, ICheckParameters parameters, org.eclipse.core.runtime.IProgressMonitor progressMonitor)
Checks the documentation comment model object. Check developers should implement their main check logic by overriding this method- Parameters:
descriptionPart
- The checked part of the documentation comment model. May not benull
rootNode
- The root node of the documentation comment model. May not benull
resultAceptor
- The check's result acceptor. May not benull
parameters
- The accessor of the check's parameters. May not benull
progressMonitor
- The progress monitor. It should be checked for the canceling in case of the long/complex checks. May not benull
-
-