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

Class BslCommentClearableTextProcessor

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

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

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

All Implemented Interfaces:

FeatureValueCollector, IBasicProcessor

public final class BslCommentClearableTextProcessor
extends BslCommentTextProcessor

Clearing comments that have no translation.

Nested Class Summary

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

DocCommentProcessor.Parent

Field Summary

Fields inherited from class com.e1c.langtool.v8.dt.bsl.translator.BslCommentTextProcessor

context

Fields inherited from class com.e1c.langtool.v8.dt.bsl.translator.AbstractBslCommentTextProcessor

eObjectReplaceProvider, lines, method, module, translationProvider

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

typeComputationContext

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

monitor, rootObject

Constructor Summary

Constructors

Constructor	Description
BslCommentClearableTextProcessor(org.eclipse.core.resources.IFile file, FeatureKey featureKeyPreffix, BslDocumentationComment comment, List<org.eclipse.xtext.nodemodel.INode> lines, org.eclipse.text.edits.MultiTextEdit edit, IProjectTranslationProvider translationProvider, Function<org.eclipse.emf.ecore.EObject,String> eObjectReplaceProvider, TranslatorProperties translatorProperties, BslTranslationLogger problemLogger, Method method, BmOperationContext typeComputationContext, DocCommentKeyComputer keyComputer, ITranslationFeatureKeyProvider featureKeyProvider, IResourceLookup resourceLookup, IV8ProjectManager v8ProjectManager, org.eclipse.xtext.scoping.IScopeProvider scopeProvider)	Instantiates a new bsl comment clearable text processor.
BslCommentClearableTextProcessor(org.eclipse.core.resources.IFile file, org.eclipse.emf.ecore.EObject context, FeatureKey featureKeyPreffix, BslDocumentationComment comment, List<org.eclipse.xtext.nodemodel.INode> lines, org.eclipse.text.edits.MultiTextEdit edit, IProjectTranslationProvider translationProvider, Function<org.eclipse.emf.ecore.EObject,String> eObjectReplaceProvider, TranslatorProperties translatorProperties, BslTranslationLogger problemLogger, BmOperationContext typeComputationContext, DocCommentKeyComputer keyComputer, ITranslationFeatureKeyProvider featureKeyProvider, IResourceLookup resourceLookup, IV8ProjectManager v8ProjectManager, org.eclipse.xtext.scoping.IScopeProvider scopeProvider)	Instantiates a new bsl comment clearable text processor.

Method Summary

Modifier and Type	Method	Description
protected <T> void	doProcess(DocCommentProcessor.Parent parent, T object, Class<T> clazz)	Processes concrete object of Bsl comment
protected void	doProcessTranslatable(BslDocumentationComment.Description object, FeatureValue fv)	Do process translatable.
protected boolean	isRealLink(LinkPart link)
protected void	replaceLinkPart(LinkPart link)	Replaces link part.
protected void	replaceTypes(TypeSection.TypeDefinition typeDef)	Replaces types.
protected void	translateDocComment(BslDocumentationComment.Description object, String translation, boolean methodDescription)	Translate doc comment.

Methods inherited from class com.e1c.langtool.v8.dt.bsl.translator.BslCommentTextProcessor

addReplace, doProcessTranslatable, isMethodDescription, translateTagDescription

Methods inherited from class com.e1c.langtool.v8.dt.bsl.translator.AbstractBslCommentTextProcessor

computeDerivedPropertyCache

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

create, doProcess, doProcess, getFieldProperty, getFieldPropertyByOrder, getFunctionReturnTypeFieldOrder, getTypeComputationContext, isComputedValue, 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

Constructor Details

BslCommentClearableTextProcessor

public BslCommentClearableTextProcessor(org.eclipse.core.resources.IFile file,
 FeatureKey featureKeyPreffix,
 BslDocumentationComment comment,
 List<org.eclipse.xtext.nodemodel.INode> lines,
 org.eclipse.text.edits.MultiTextEdit edit,
 IProjectTranslationProvider translationProvider,
 Function<org.eclipse.emf.ecore.EObject,String> eObjectReplaceProvider,
 TranslatorProperties translatorProperties,
 BslTranslationLogger problemLogger,
 Method method,
 BmOperationContext typeComputationContext,
 DocCommentKeyComputer keyComputer,
 ITranslationFeatureKeyProvider featureKeyProvider,
 IResourceLookup resourceLookup,
 IV8ProjectManager v8ProjectManager,
 org.eclipse.xtext.scoping.IScopeProvider scopeProvider)

Instantiates a new bsl comment clearable text processor.

Parameters:

file - the file of the module, cannot be null.

featureKeyPreffix - the feature key prefix, cannot be null.

comment - the root documentation comment model object, cannot be null.

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

edit - the edits that will be append by translator changes, cannot be null.

translationProvider - the translation provider, cannot be null.

eObjectReplaceProvider - the e object replace provider, cannot be null.

translatorProperties - the translator properties, cannot be null.

problemLogger - the translation problem logger, can be null.

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

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

keyComputer - the DocCommentKeyComputer, cannot be null.

featureKeyProvider - the ITranslationFeatureKeyProvider, cannot be null.

resourceLookup - the IResourceLookup, cannot be null.

v8ProjectManager - the IV8ProjectManager, cannot be null.

scopeProvider - the IScopeProvider, cannot be null.

BslCommentClearableTextProcessor

public BslCommentClearableTextProcessor(org.eclipse.core.resources.IFile file,
 org.eclipse.emf.ecore.EObject context,
 FeatureKey featureKeyPreffix,
 BslDocumentationComment comment,
 List<org.eclipse.xtext.nodemodel.INode> lines,
 org.eclipse.text.edits.MultiTextEdit edit,
 IProjectTranslationProvider translationProvider,
 Function<org.eclipse.emf.ecore.EObject,String> eObjectReplaceProvider,
 TranslatorProperties translatorProperties,
 BslTranslationLogger problemLogger,
 BmOperationContext typeComputationContext,
 DocCommentKeyComputer keyComputer,
 ITranslationFeatureKeyProvider featureKeyProvider,
 IResourceLookup resourceLookup,
 IV8ProjectManager v8ProjectManager,
 org.eclipse.xtext.scoping.IScopeProvider scopeProvider)

Instantiates a new bsl comment clearable text processor.

Parameters:

file - the file of the module, cannot be null.

context - the context

featureKeyPreffix - the feature key prefix, cannot be null.

comment - the root documentation comment model object, cannot be null.

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

edit - the edits that will be append by translator changes, cannot be null.

translationProvider - the translation provider, cannot be null.

eObjectReplaceProvider - the e object replace provider, cannot be null.

translatorProperties - the translator properties, cannot be null.

problemLogger - the translation problem logger, can be null.

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

keyComputer - the DocCommentKeyComputer, cannot be null.

featureKeyProvider - the ITranslationFeatureKeyProvider, cannot be null.

resourceLookup - the IResourceLookup, cannot be null.

v8ProjectManager - the IV8ProjectManager, cannot be null.

scopeProvider - the IScopeProvider, cannot be null.

Method Details

doProcess

protected <T> void doProcess(DocCommentProcessor.Parent parent,
 T object,
 Class<T> clazz)

Description copied from class: DocCommentProcessor

Processes concrete object of Bsl comment

Overrides:

doProcess in class BslCommentTextProcessor

object - processing object, can't be null

doProcessTranslatable

protected void doProcessTranslatable(BslDocumentationComment.Description object,
 FeatureValue fv)

Description copied from class: BslCommentTextProcessor

Do process translatable.

Overrides:

doProcessTranslatable in class BslCommentTextProcessor

Parameters:

object - the object, cannot be null.

fv - the feature value, cannot be null.

replaceLinkPart

protected void replaceLinkPart(LinkPart link)

Description copied from class: BslCommentTextProcessor

Replaces link part.

Overrides:

replaceLinkPart in class BslCommentTextProcessor

Parameters:

link - the link, can be null.

isRealLink

protected boolean isRealLink(LinkPart link)

Overrides:

isRealLink in class DocCommentCollector

translateDocComment

protected void translateDocComment(BslDocumentationComment.Description object,
 String translation,
 boolean methodDescription)

Description copied from class: BslCommentTextProcessor

Translate doc comment.

Overrides:

translateDocComment in class BslCommentTextProcessor

Parameters:

object - the object, cannot be null.

translation - the translation, cannot be null.

methodDescription - the method description

replaceTypes

protected void replaceTypes(TypeSection.TypeDefinition typeDef)

Description copied from class: BslCommentTextProcessor

Replaces types.

Overrides:

replaceTypes in class BslCommentTextProcessor

Parameters:

typeDef - the type definition, cannot be null.