CustomCodeAnalysisPlugin class

Inheritance

• Object
• ServerPlugin
• CustomCodeAnalysisPlugin

Constructors

CustomCodeAnalysisPlugin(ResourceProvider provider)

Properties

analysisDriverScheduler ↔ AnalysisDriverScheduler

The scheduler used by any analysis drivers that are created.

getter/setter pair, inherited

byteStore → ByteStore

Return the byte store used by any analysis drivers that are created, or null if the cache location isn't known because the 'plugin.version' request has not yet been received.

no setter, inherited

channel → PluginCommunicationChannel

Return the communication channel being used to communicate with the analysis server, or null if the plugin has not been started.

no setter, inherited

contactInfo → String?

Return the user visible information about how to contact the plugin authors with any problems that are found, or null if there is no contact info.

no setter, inherited

driverMap → Map<ContextRoot, AnalysisDriverGeneric>

A table mapping the current context roots to the analysis driver created for that root.

final, inherited

fileGlobsToAnalyze → List<String>

Return a list of glob patterns selecting the files that this plugin is interested in analyzing.

no setter, override

hashCode → int

The hash code for this object.

no setter, inherited

name → String

Return the user visible name of this plugin.

no setter, override

performanceLog → PerformanceLog

The performance log used by any analysis drivers that are created.

final, inherited

resourceProvider → OverlayResourceProvider

The resource provider used to access the file system.

final, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

sdkManager → DartSdkManager

Return the SDK manager used to manage SDKs.

no setter, inherited

subscriptionManager → SubscriptionManager

The object used to manage analysis subscriptions.

final, inherited

version → String

Return the version number of the plugin spec required by this plugin, encoded as a string.

no setter, override

Methods

contentChanged(String path) → void

Handle the fact that the file with the given path has been modified.

override

contextRootContaining(String filePath) → ContextRoot?

Return the context root containing the file at the given filePath.

inherited

createAnalysisDriver(ContextRoot contextRoot) → AnalysisDriverGeneric

Create an analysis driver that can analyze the files within the given contextRoot.

override

driverForPath(String path) → AnalysisDriverGeneric?

Return the driver being used to analyze the file with the given path.

inherited

getResolvedUnitResult(String path) → Future<ResolvedUnitResult>

Return the result of analyzing the file with the given path.

inherited

handleAnalysisGetNavigation(AnalysisGetNavigationParams params) → Future<AnalysisGetNavigationResult>

Handle an 'analysis.getNavigation' request.

inherited

handleAnalysisHandleWatchEvents(AnalysisHandleWatchEventsParams parameters) → Future<AnalysisHandleWatchEventsResult>

Handle an 'analysis.handleWatchEvents' request.

inherited

handleAnalysisSetContextRoots(AnalysisSetContextRootsParams parameters) → Future<AnalysisSetContextRootsResult>

Handle an 'analysis.setContextRoots' request.

inherited

handleAnalysisSetPriorityFiles(AnalysisSetPriorityFilesParams parameters) → Future<AnalysisSetPriorityFilesResult>

Handle an 'analysis.setPriorityFiles' request.

override

handleAnalysisSetSubscriptions(AnalysisSetSubscriptionsParams parameters) → Future<AnalysisSetSubscriptionsResult>

Handle an 'analysis.setSubscriptions' request. Most subclasses should not override this method, but should instead use the subscriptionManager to access the list of subscriptions for any given file.

inherited

handleAnalysisUpdateContent(AnalysisUpdateContentParams parameters) → Future<AnalysisUpdateContentResult>

Handle an 'analysis.updateContent' request. Most subclasses should not override this method, but should instead use the contentCache to access the current content of overlaid files.

inherited

handleCompletionGetSuggestions(CompletionGetSuggestionsParams parameters) → Future<CompletionGetSuggestionsResult>

Handle a 'completion.getSuggestions' request.

inherited

handleEditGetAssists(EditGetAssistsParams parameters) → Future<EditGetAssistsResult>

Handle an 'edit.getAssists' request.

inherited

handleEditGetAvailableRefactorings(EditGetAvailableRefactoringsParams parameters) → Future<EditGetAvailableRefactoringsResult>

Handle an 'edit.getAvailableRefactorings' request. Subclasses that override this method in order to participate in refactorings must also override the method handleEditGetRefactoring.

inherited

handleEditGetFixes(EditGetFixesParams parameters) → Future<EditGetFixesResult>

Handle an 'edit.getFixes' request.

override

handleEditGetRefactoring(EditGetRefactoringParams parameters) → Future<EditGetRefactoringResult?>

Handle an 'edit.getRefactoring' request.

inherited

handleKytheGetKytheEntries(KytheGetKytheEntriesParams parameters) → Future<KytheGetKytheEntriesResult?>

Handle a 'kythe.getKytheEntries' request.

inherited

handlePluginShutdown(PluginShutdownParams parameters) → Future<PluginShutdownResult>

Handle a 'plugin.shutdown' request. Subclasses can override this method to perform any required clean-up, but cannot prevent the plugin from shutting down.

inherited

handlePluginVersionCheck(PluginVersionCheckParams parameters) → Future<PluginVersionCheckResult>

Handle a 'plugin.versionCheck' request.

inherited

isCompatibleWith(Version serverVersion) → bool

Return true if this plugin is compatible with an analysis server that is using the given version of the plugin API.

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

onDone() → void

The method that is called when the analysis server closes the communication channel. This method will not be invoked under normal conditions because the server will send a shutdown request and the plugin will stop listening to the channel before the server closes the channel.

inherited

onError(Object exception, StackTrace stackTrace) → void

The method that is called when an error has occurred in the analysis server. This method will not be invoked under normal conditions.

inherited

sendFoldingNotification(String path) → Future<void>

If the plugin provides folding information, send a folding notification for the file with the given path to the server.

inherited

sendHighlightsNotification(String path) → Future<void>

If the plugin provides highlighting information, send a highlights notification for the file with the given path to the server.

inherited

sendNavigationNotification(String path) → Future<void>

If the plugin provides navigation information, send a navigation notification for the file with the given path to the server.

inherited

sendNotificationsForFile(String path) → void

Send notifications for the services subscribed to for the file with the given path.

inherited

sendNotificationsForSubscriptions(Map<String, List<AnalysisService>> subscriptions) → void

Send notifications corresponding to the given description of subscriptions. The map is keyed by the path of each file for which notifications should be sent and has values representing the list of services associated with the notifications to send.

inherited

sendOccurrencesNotification(String path) → Future<void>

If the plugin provides occurrences information, send an occurrences notification for the file with the given path to the server.

inherited

sendOutlineNotification(String path) → Future<void>

If the plugin provides outline information, send an outline notification for the file with the given path to the server.

inherited

start(PluginCommunicationChannel channel) → void

Start this plugin by listening to the given communication channel.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited