Package com.e1c.langtool.v8.dt.bsl.translator

Class AbstractBslCommentTextProcessor

java.lang.Object

com.e1c.langtool.v8.dt.bsl.comment.DocCommentProcessor

com.e1c.langtool.v8.dt.bsl.comment.DocCommentCollector

com.e1c.langtool.v8.dt.bsl.translator.AbstractBslCommentTextProcessor

All Implemented Interfaces:

FeatureValueCollector, IBasicProcessor

Direct Known Subclasses:

BslCommentTextProcessor, ExternalDocCommentFieldProcessor

public abstract class AbstractBslCommentTextProcessor
extends DocCommentCollector

Abstract text processor for Documentation comment model. Computes derived property cache for fields that linked to return type properties.

Nested Class Summary

Nested classes/interfaces inherited from class com.e1c.langtool.v8.dt.bsl.comment.DocCommentProcessor

DocCommentProcessor.Parent

Field Summary

Fields

Modifier and Type	Field	Description
protected final Function<org.eclipse.emf.ecore.EObject,String>	eObjectReplaceProvider
protected final List<org.eclipse.xtext.nodemodel.INode>	lines	The list of nodes of current doc-comment.
protected final Method	method	The method of current doc-comment.
protected final Module	module	the module of current doc-comment.
protected final IProjectTranslationProvider	translationProvider

Fields inherited from class com.e1c.langtool.v8.dt.bsl.comment.DocCommentCollector

featureKeyProvider, typeComputationContext

Fields inherited from class com.e1c.langtool.v8.dt.bsl.comment.DocCommentProcessor

monitor, rootObject

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractBslCommentTextProcessor(org.eclipse.core.resources.IFile file, FeatureKey featureKeyPreffix, IDescriptionPart rootObject, List<org.eclipse.xtext.nodemodel.INode> lines, ICollectingParameters parameters, IProjectTranslationProvider translationProvider, Function<org.eclipse.emf.ecore.EObject,String> eObjectReplaceProvider, Method method, BmOperationContext typeComputationContext)	Instantiates a new abstract bsl comment text processor.
protected	AbstractBslCommentTextProcessor(org.eclipse.core.resources.IFile file, FeatureKey featureKeyPreffix, IDescriptionPart rootObject, List<org.eclipse.xtext.nodemodel.INode> lines, ICollectingParameters parameters, org.eclipse.emf.ecore.EObject context, IProjectTranslationProvider translationProvider, Function<org.eclipse.emf.ecore.EObject,String> eObjectReplaceProvider, BmOperationContext typeComputationContext, Method method)	Instantiates a new abstract bsl comment text processor.

Method Summary

Modifier and Type	Method	Description
protected void	computeDerivedPropertyCache(DocCommentProcessor.Parent parent, TypeSection.FieldDefinition object)	Compute derived property cache for the field definition.

Methods inherited from class com.e1c.langtool.v8.dt.bsl.comment.DocCommentCollector

create, doProcess, doProcess, doProcess, getFieldProperty, getFieldPropertyByOrder, getFunctionReturnTypeFieldOrder, getTypeComputationContext, isComputedValue, isRealLink, isSkipTextPart, setAddAction

Methods inherited from class com.e1c.langtool.v8.dt.bsl.comment.DocCommentProcessor

isCanceled, process

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.e1c.langtool.IBasicProcessor

isCanceled, process

Field Details

module

protected final Module module

the module of current doc-comment.

method

protected final Method method

The method of current doc-comment.

lines

protected final List<org.eclipse.xtext.nodemodel.INode> lines

The list of nodes of current doc-comment.

translationProvider

protected final IProjectTranslationProvider translationProvider

eObjectReplaceProvider

protected final Function<org.eclipse.emf.ecore.EObject,String> eObjectReplaceProvider

Constructor Details

AbstractBslCommentTextProcessor

protected AbstractBslCommentTextProcessor(org.eclipse.core.resources.IFile file,
 FeatureKey featureKeyPreffix,
 IDescriptionPart rootObject,
 List<org.eclipse.xtext.nodemodel.INode> lines,
 ICollectingParameters parameters,
 IProjectTranslationProvider translationProvider,
 Function<org.eclipse.emf.ecore.EObject,String> eObjectReplaceProvider,
 Method method,
 BmOperationContext typeComputationContext)

Instantiates a new abstract bsl comment text processor.

Parameters:

file - the file of module, cannot be null.

featureKeyPreffix - the feature key preffix, cannot be null.

rootObject - the root object of doc-comment, cannot be null.

lines - the list of nodes, cannot be null.

parameters - the parameters collecting parameters, cannot be null.

translationProvider - the translation provider, cannot be null.

eObjectReplaceProvider - the EObject replace provider, cannot be null.

method - the method of the doc-comment, cannot be null.

typeComputationContext - the BM operation type computation context, cannot be {@code null

AbstractBslCommentTextProcessor

protected AbstractBslCommentTextProcessor(org.eclipse.core.resources.IFile file,
 FeatureKey featureKeyPreffix,
 IDescriptionPart rootObject,
 List<org.eclipse.xtext.nodemodel.INode> lines,
 ICollectingParameters parameters,
 org.eclipse.emf.ecore.EObject context,
 IProjectTranslationProvider translationProvider,
 Function<org.eclipse.emf.ecore.EObject,String> eObjectReplaceProvider,
 BmOperationContext typeComputationContext,
 Method method)

Instantiates a new abstract bsl comment text processor.

Parameters:

file - the file of module, cannot be null.

featureKeyPreffix - the feature key preffix, cannot be null.

rootObject - the root object of doc-comment, cannot be null.

lines - the list of nodes, cannot be null.

parameters - the parameters collecting parameters, cannot be null.

context - the context object, cannot be null.

translationProvider - the translation provider, cannot be null.

eObjectReplaceProvider - the EObject replace provider, cannot be null.

typeComputationContext - the BM operation type computation context, cannot be null

method - the method, can be null

Method Details

computeDerivedPropertyCache

protected void computeDerivedPropertyCache(DocCommentProcessor.Parent parent,
 TypeSection.FieldDefinition object)

Compute derived property cache for the field definition. It compute and put cache into translator cache system.

Parameters:

parent - the parent doc-comment object, cannot be null.

object - the field definition object, cannot be null.