Class AbstractDiagnostic

java.lang.Object

com.github._1c_syntax.bsl.languageserver.diagnostics.AbstractDiagnostic

All Implemented Interfaces:

BSLDiagnostic

Direct Known Subclasses:

AbstractMetadataDiagnostic, AbstractSymbolTreeDiagnostic, BadWordsDiagnostic, CachedPublicDiagnostic, CanonicalSpellingKeywordsDiagnostic, CommentedCodeDiagnostic, CommonModuleInvalidTypeDiagnostic, CommonModuleMissingAPIDiagnostic, CommonModuleNameCachedDiagnostic, CommonModuleNameClientDiagnostic, CommonModuleNameClientServerDiagnostic, CommonModuleNameFullAccessDiagnostic, CommonModuleNameGlobalClientDiagnostic, CommonModuleNameGlobalDiagnostic, CommonModuleNameServerCallDiagnostic, CommonModuleNameWordsDiagnostic, ConsecutiveEmptyLinesDiagnostic, CrazyMultilineStringDiagnostic, DeprecatedMethodCallDiagnostic, GlobalContextMethodCollision8312Diagnostic, IncorrectLineBreakDiagnostic, InvalidCharacterInFileDiagnostic, LatinAndCyrillicSymbolInWordDiagnostic, LineLengthDiagnostic, MissingCommonModuleMethodDiagnostic, MissingEventSubscriptionHandlerDiagnostic, MissingSpaceDiagnostic, NonStandardRegionDiagnostic, OrdinaryAppSupportDiagnostic, PrivilegedModuleMethodCallDiagnostic, ProtectedModuleDiagnostic, RewriteMethodParameterDiagnostic, SetPermissionsForNewObjectsDiagnostic, SpaceAtStartCommentDiagnostic, TransferringParametersBetweenClientAndServerDiagnostic, TypoDiagnostic, UnavailableMemberCallDiagnostic, UnusedLocalVariableDiagnostic, UsingServiceTagDiagnostic, WrongDataPathForFormElementsDiagnostic, WrongHttpServiceHandlerDiagnostic, WrongWebServiceHandlerDiagnostic, YoLetterUsageDiagnostic

public abstract class AbstractDiagnostic
extends Object
implements BSLDiagnostic

Базовый класс диагностики.

Управляет жизненным циклом проверки: сбрасывает накопленные диагностики, запоминает обрабатываемый DocumentContext и делегирует поиск замечаний методу check(), который реализуют наследники.

Field Summary

Fields

Modifier and Type	Field	Description
protected final DiagnosticStorage	diagnosticStorage	Хранилище найденных диагностикой замечаний.
protected DocumentContext	documentContext	Контекст обрабатываемого документа.
protected DiagnosticInfo	info	Метаинформация о диагностике.

Constructor Summary

Constructors

Constructor	Description
AbstractDiagnostic()

Method Summary

Modifier and Type	Method	Description
protected abstract void	check()	Выполняет проверку документа и наполняет diagnosticStorage найденными замечаниями.
List<Diagnostic>	getDiagnostics(DocumentContext documentContext)	Выполнить диагностику документа.
DiagnosticInfo	getInfo()	Метаинформация о диагностике.
void	setInfo(DiagnosticInfo info)	Метаинформация о диагностике.

Methods inherited from class Object

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

Methods inherited from interface BSLDiagnostic

configure

Field Details

info

protected DiagnosticInfo info

Метаинформация о диагностике.

diagnosticStorage

protected final DiagnosticStorage diagnosticStorage

Хранилище найденных диагностикой замечаний.

documentContext

protected DocumentContext documentContext

Контекст обрабатываемого документа.

Constructor Details

AbstractDiagnostic

public AbstractDiagnostic()

Method Details

getDiagnostics

public List<Diagnostic> getDiagnostics(DocumentContext documentContext)

Description copied from interface: BSLDiagnostic

Выполнить диагностику документа.

Specified by:

getDiagnostics in interface BSLDiagnostic

Parameters:

documentContext - Контекст документа, для которого выполняется диагностика

Returns:

Список найденных замечаний

check

protected abstract void check()

Выполняет проверку документа и наполняет diagnosticStorage найденными замечаниями.

getInfo

public DiagnosticInfo getInfo()

Метаинформация о диагностике.

Specified by:

getInfo in interface BSLDiagnostic

Returns:

Метаинформация о диагностике

setInfo

public void setInfo(DiagnosticInfo info)

Метаинформация о диагностике.

Specified by:

setInfo in interface BSLDiagnostic

Parameters:

info - Метаинформация о диагностике