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

Class DocumentationCommentBasicDelegateCheck.DocumentationCommentResultAcceptor

  • Enclosing class:
    DocumentationCommentBasicDelegateCheck
    public static final class DocumentationCommentBasicDelegateCheck.DocumentationCommentResultAcceptor
extends Object
    Accepts results of the check in form of Issue's. The result is automatically bound to the context object of the check and cannot be changed. In case if you need the free navigation and reporting of issues - consider implementing the ICheck directly instead of BasicCheck This class is instantiated by the ACC subsystem and is not intended for the direct instantiation.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void addIssue​(String message, int length)
      Adds an issue which starts at the beginning of the context object's related string and have the specified length
      void addIssue​(String message, int lineNumber, int offset, int length)
      Adds issue at the given line, offset and length within the line
      void addIssue​(String message, org.eclipse.emf.ecore.EObject target, org.eclipse.emf.ecore.EStructuralFeature feature)
      Adds issue associated with the given target object and feature.
      void addIssue​(String message, org.eclipse.emf.ecore.EObject target, org.eclipse.emf.ecore.EStructuralFeature manyFeature, int index)
      Adds issue for element with given index in feature collection and with the given message.

    • Method Detail

      • addIssue

        public void addIssue​(String message,
                     org.eclipse.emf.ecore.EObject target,
                     org.eclipse.emf.ecore.EStructuralFeature feature)
        Adds issue associated with the given target object and feature.
        Parameters:
        message - The issue's message, not null
        target - The target object of the current module, cannot be null.
        feature - The target object feature, not null

      • addIssue

        public void addIssue​(String message,
                     org.eclipse.emf.ecore.EObject target,
                     org.eclipse.emf.ecore.EStructuralFeature manyFeature,
                     int index)
        Adds issue for element with given index in feature collection and with the given message.
        Parameters:
        message - The issue's message, not null
        target - the target object of the current module, cannot be null.
        manyFeature - The target object feature, not null
        index - The index in feature collection. May not be negative

      • addIssue

        public void addIssue​(String message,
                     int length)
        Adds an issue which starts at the beginning of the context object's related string and have the specified length
        Parameters:
        message - The issue's message, not null
        length - The length of the issue target region, may not be negative

      • addIssue

        public void addIssue​(String message,
                     int lineNumber,
                     int offset,
                     int length)
        Adds issue at the given line, offset and length within the line
        Parameters:
        message - The issue's message, not null
        lineNumber - The line number. May not be null
        offset - The offset from the line start. May not be null
        length - The length of the issue target region, may not be negative