Flutter SDK

/* * Copyright (c) 2018, the Dart project authors. Please see the AUTHORS file * for details. All rights reserved. Use of this source code is governed by a * BSD-style license that can be found in the LICENSE file. * * This file has been automatically generated. Please do not edit it manually. * To regenerate the file, use the script "pkg/analysis_server/tool/spec/generate_files". */ package com.google.dart.server.generated; import com.google.dart.server.*; import org.dartlang.analysis.server.protocol.*; import java.util.List; import java.util.Map; /** * The interface {@code AnalysisServer} defines the behavior of objects that interface to an * analysis server. * * @coverage dart.server */ public interface AnalysisServer { /** * Add the given listener to the list of listeners that will receive notification when new * analysis results become available. * * @param listener the listener to be added */ public void addAnalysisServerListener(AnalysisServerListener listener); /** * Add the given listener to the list of listeners that will receive notification when the server * is not active * * @param listener the listener to be added */ public void addStatusListener(AnalysisServerStatusListener listener); /** * {@code analysis.getErrors} * * Return the errors associated with the given file. If the errors for the given file have not yet * been computed, or the most recently computed errors for the given file are out of date, then the * response for this request will be delayed until they have been computed. If some or all of the * errors for the file cannot be computed, then the subset of the errors that can be computed will * be returned and the response will contain an error to indicate why the errors could not be * computed. If the content of the file changes after this request was received but before a * response could be sent, then an error of type CONTENT_MODIFIED will be generated. * * This request is intended to be used by clients that cannot asynchronously apply updated error * information. Clients that can apply error information as it becomes available should use the * information provided by the 'analysis.errors' notification. * * If a request is made for a file which does not exist, or which is not currently subject to * analysis (e.g. because it is not associated with any analysis root specified to * analysis.setAnalysisRoots), an error of type GET_ERRORS_INVALID_FILE will be generated. * * @param file The file for which errors are being requested. */ public void analysis_getErrors(String file, GetErrorsConsumer consumer); /** * {@code analysis.getHover} * * Return the hover information associate with the given location. If some or all of the hover * information is not available at the time this request is processed the information will be * omitted from the response. * * @param file The file in which hover information is being requested. * @param offset The offset for which hover information is being requested. */ public void analysis_getHover(String file, int offset, GetHoverConsumer consumer); /** * {@code analysis.getImportedElements} * * Return a description of all of the elements referenced in a given region of a given file that * come from imported libraries. * * If a request is made for a file that does not exist, or that is not currently subject to * analysis (e.g. because it is not associated with any analysis root specified via * analysis.setAnalysisRoots), an error of type GET_IMPORTED_ELEMENTS_INVALID_FILE will be * generated. * * @param file The file in which import information is being requested. * @param offset The offset of the region for which import information is being requested. * @param length The length of the region for which import information is being requested. */ public void analysis_getImportedElements(String file, int offset, int length, GetImportedElementsConsumer consumer); /** * {@code analysis.getLibraryDependencies} * * Return library dependency information for use in client-side indexing and package URI * resolution. * * Clients that are only using the libraries field should consider using the analyzedFiles * notification instead. */ public void analysis_getLibraryDependencies(GetLibraryDependenciesConsumer consumer); /** * {@code analysis.getNavigation} * * Return the navigation information associated with the given region of the given file. If the * navigation information for the given file has not yet been computed, or the most recently * computed navigation information for the given file is out of date, then the response for this * request will be delayed until it has been computed. If the content of the file changes after * this request was received but before a response could be sent, then an error of type * CONTENT_MODIFIED will be generated. * * If a navigation region overlaps (but extends either before or after) the given region of the * file it will be included in the result. This means that it is theoretically possible to get the * same navigation region in response to multiple requests. Clients can avoid this by always * choosing a region that starts at the beginning of a line and ends at the end of a (possibly * different) line in the file. * * If a request is made for a file which does not exist, or which is not currently subject to * analysis (e.g. because it is not associated with any analysis root specified to * analysis.setAnalysisRoots), an error of type GET_NAVIGATION_INVALID_FILE will be generated. * * @param file The file in which navigation information is being requested. * @param offset The offset of the region for which navigation information is being requested. * @param length The length of the region for which navigation information is being requested. */ public void analysis_getNavigation(String file, int offset, int length, GetNavigationConsumer consumer); /** * {@code analysis.getReachableSources} * * Return the transitive closure of reachable sources for a given file. * * If a request is made for a file which does not exist, or which is not currently subject to * analysis (e.g. because it is not associated with any analysis root specified to * analysis.setAnalysisRoots), an error of type GET_REACHABLE_SOURCES_INVALID_FILE will be * generated. * * @param file The file for which reachable source information is being requested. */ public void analysis_getReachableSources(String file, GetReachableSourcesConsumer consumer); /** * {@code analysis.reanalyze} * * Force the re-analysis of everything contained in the specified analysis roots. This will cause * all previously computed analysis results to be discarded and recomputed, and will cause all * subscribed notifications to be re-sent. * * If no analysis roots are provided, then all current analysis roots will be re-analyzed. If an * empty list of analysis roots is provided, then nothing will be re-analyzed. If the list contains * one or more paths that are not currently analysis roots, then an error of type * INVALID_ANALYSIS_ROOT will be generated. * * @param roots A list of the analysis roots that are to be re-analyzed. */ public void analysis_reanalyze(List<String> roots); /** * {@code analysis.setAnalysisRoots} * * Sets the root paths used to determine which files to analyze. The set of files to be analyzed * are all of the files in one of the root paths that are not either explicitly or implicitly * excluded. A file is explicitly excluded if it is in one of the excluded paths. A file is * implicitly excluded if it is in a subdirectory of one of the root paths where the name of the * subdirectory starts with a period (that