New analyzer_experimental snapshot.

pkg/analyzer_experimental/lib/src/generated/source_io.dart

 // This code was auto-generated, is not intended to be edited, and is subject to
 // significant change. Please see the README file for more information.
 library engine.source.io;
 import 'source.dart';
 import 'dart:io';
 import 'java_core.dart';
 import 'java_io.dart';
 import 'sdk.dart' show DartSdk;
 import 'engine.dart' show AnalysisContext, AnalysisEngine;
 export 'source.dart';
 /**
- * Instances of the class {@code FileBasedSource} implement a source that represents a file.
+ * Instances of the class `FileBasedSource` implement a source that represents a file.
  * @coverage dart.engine.source
  */
 class FileBasedSource implements Source {
 
   /**
    * The content cache used to access the contents of this source if they have been overridden from
    * what is on disk or cached.
    */
   ContentCache _contentCache;
 
@@ skipping 22 matching lines @@
     _jtd_constructor_338_impl(contentCache, file);
   }
   _jtd_constructor_338_impl(ContentCache contentCache, JavaFile file) {
     _jtd_constructor_339_impl(contentCache, file, UriKind.FILE_URI);
   }
 
   /**
    * Initialize a newly created source object.
    * @param contentCache the content cache used to access the contents of this source
    * @param file the file represented by this source
-   * @param flags {@code true} if this source is in one of the system libraries
+   * @param flags `true` if this source is in one of the system libraries
    */
   FileBasedSource.con2(ContentCache contentCache2, JavaFile file2, UriKind uriKind2) {
     _jtd_constructor_339_impl(contentCache2, file2, uriKind2);
   }
   _jtd_constructor_339_impl(ContentCache contentCache2, JavaFile file2, UriKind uriKind2) {
     this._contentCache = contentCache2;
     this._file = file2;
     this._uriKind = uriKind2;
     this._encoding = "${uriKind2.encoding}${file2.toURI().toString()}";
   }
@@ skipping 32 matching lines @@
   }
   String toString() {
     if (_file == null) {
       return "<unknown source>";
     }
     return _file.getAbsolutePath();
   }
 
   /**
    * Return the file represented by this source. This is an internal method that is only intended to
-   * be used by {@link UriResolver}.
+   * be used by [UriResolver].
    * @return the file represented by this source
    */
   JavaFile get file => _file;
 }
 /**
- * Instances of the class {@code PackageUriResolver} resolve {@code package} URI's in the context of
+ * Instances of the class `PackageUriResolver` resolve `package` URI's in the context of
  * an application.
- * <p>
+ *
  * For the purposes of sharing analysis, the path to each package under the "packages" directory
  * should be canonicalized, but to preserve relative links within a package, the remainder of the
  * path from the package directory to the leaf should not.
  * @coverage dart.engine.source
  */
 class PackageUriResolver extends UriResolver {
 
   /**
-   * The package directories that {@code package} URI's are assumed to be relative to.
+   * The package directories that `package` URI's are assumed to be relative to.
    */
   List<JavaFile> _packagesDirectories;
 
   /**
-   * The name of the {@code package} scheme.
+   * The name of the `package` scheme.
    */
   static String PACKAGE_SCHEME = "package";
 
   /**
    * Log exceptions thrown with the message "Required key not available" only once.
    */
   static bool _CanLogRequiredKeyIoException = true;
 
   /**
-   * Return {@code true} if the given URI is a {@code package} URI.
+   * Return `true` if the given URI is a `package` URI.
    * @param uri the URI being tested
-   * @return {@code true} if the given URI is a {@code package} URI
+   * @return `true` if the given URI is a `package` URI
    */
   static bool isPackageUri(Uri uri) => PACKAGE_SCHEME == uri.scheme;
 
   /**
-   * Initialize a newly created resolver to resolve {@code package} URI's relative to the given
+   * Initialize a newly created resolver to resolve `package` URI's relative to the given
    * package directories.
-   * @param packagesDirectories the package directories that {@code package} URI's are assumed to be
+   * @param packagesDirectories the package directories that `package` URI's are assumed to be
    * relative to
    */
   PackageUriResolver(List<JavaFile> packagesDirectories) {
     if (packagesDirectories.length < 1) {
       throw new IllegalArgumentException("At least one package directory must be provided");
     }
     this._packagesDirectories = packagesDirectories;
   }
   Source fromEncoding(ContentCache contentCache, UriKind kind, Uri uri) {
     if (identical(kind, UriKind.PACKAGE_URI)) {
@@ skipping 49 matching lines @@
             }
           }
         }
       }
     }
     return null;
   }
 
   /**
    * Answer the canonical file for the specified package.
-   * @param packagesDirectory the "packages" directory (not {@code null})
-   * @param pkgName the package name (not {@code null}, not empty)
-   * @param relPath the path relative to the package directory (not {@code null}, no leading slash,
+   * @param packagesDirectory the "packages" directory (not `null`)
+   * @param pkgName the package name (not `null`, not empty)
+   * @param relPath the path relative to the package directory (not `null`, no leading slash,
    * but may be empty string)
-   * @return the file (not {@code null})
+   * @return the file (not `null`)
    */
   JavaFile getCanonicalFile(JavaFile packagesDirectory, String pkgName, String relPath) {
     JavaFile pkgDir = new JavaFile.relative(packagesDirectory, pkgName);
     try {
       pkgDir = pkgDir.getCanonicalFile();
     } on IOException catch (e) {
       if (!e.toString().contains("Required key not available")) {
         AnalysisEngine.instance.logger.logError2("Canonical failed: ${pkgDir}", e);
       } else if (_CanLogRequiredKeyIoException) {
         _CanLogRequiredKeyIoException = false;
         AnalysisEngine.instance.logger.logError2("Canonical failed: ${pkgDir}", e);
       }
     }
     return new JavaFile.relative(pkgDir, relPath.replaceAll('/', new String.fromCharCode(JavaFile.separatorChar)));
   }
 }
 /**
- * Instances of the class {@link DirectoryBasedSourceContainer} represent a source container that
+ * Instances of the class [DirectoryBasedSourceContainer] represent a source container that
  * contains all sources within a given directory.
  * @coverage dart.engine.source
  */
 class DirectoryBasedSourceContainer implements SourceContainer {
 
   /**
    * Append the system file separator to the given path unless the path already ends with a
    * separator.
    * @param path the path to which the file separator is to be added
    * @return a path that ends with the system file separator
    */
   static String appendFileSeparator(String path) {
     if (path == null || path.length <= 0 || path.codeUnitAt(path.length - 1) == JavaFile.separatorChar) {
       return path;
     }
     return "${path}${JavaFile.separator}";
   }
 
   /**
-   * The container's path (not {@code null}).
+   * The container's path (not `null`).
    */
   String _path;
 
   /**
-   * Construct a container representing the specified directory and containing any sources whose{@link Source#getFullName()} starts with the directory's path. This is a convenience method,
-   * fully equivalent to {@link DirectoryBasedSourceContainer#DirectoryBasedSourceContainer(String)}.
-   * @param directory the directory (not {@code null})
+   * Construct a container representing the specified directory and containing any sources whose[Source#getFullName] starts with the directory's path. This is a convenience method,
+   * fully equivalent to [DirectoryBasedSourceContainer#DirectoryBasedSourceContainer].
+   * @param directory the directory (not `null`)
    */
   DirectoryBasedSourceContainer.con1(JavaFile directory) {
     _jtd_constructor_336_impl(directory);
   }
   _jtd_constructor_336_impl(JavaFile directory) {
     _jtd_constructor_337_impl(directory.getPath());
   }
 
   /**
-   * Construct a container representing the specified path and containing any sources whose{@link Source#getFullName()} starts with the specified path.
-   * @param path the path (not {@code null} and not empty)
+   * Construct a container representing the specified path and containing any sources whose[Source#getFullName] starts with the specified path.
+   * @param path the path (not `null` and not empty)
    */
   DirectoryBasedSourceContainer.con2(String path2) {
     _jtd_constructor_337_impl(path2);
   }
   _jtd_constructor_337_impl(String path2) {
     this._path = appendFileSeparator(path2);
   }
   bool contains(Source source) => source.fullName.startsWith(_path);
   bool operator ==(Object obj) => (obj is DirectoryBasedSourceContainer) && ((obj as DirectoryBasedSourceContainer)).path == path;
 
   /**
    * Answer the receiver's path, used to determine if a source is contained in the receiver.
-   * @return the path (not {@code null}, not empty)
+   * @return the path (not `null`, not empty)
    */
   String get path => _path;
   int get hashCode => _path.hashCode;
   String toString() => "SourceContainer[${_path}]";
 }
 /**
- * Instances of the class {@code FileUriResolver} resolve {@code file} URI's.
+ * Instances of the class `FileUriResolver` resolve `file` URI's.
  * @coverage dart.engine.source
  */
 class FileUriResolver extends UriResolver {
 
   /**
-   * The name of the {@code file} scheme.
+   * The name of the `file` scheme.
    */
   static String FILE_SCHEME = "file";
 
   /**
-   * Return {@code true} if the given URI is a {@code file} URI.
+   * Return `true` if the given URI is a `file` URI.
    * @param uri the URI being tested
-   * @return {@code true} if the given URI is a {@code file} URI
+   * @return `true` if the given URI is a `file` URI
    */
   static bool isFileUri(Uri uri) => uri.scheme == FILE_SCHEME;
   Source fromEncoding(ContentCache contentCache, UriKind kind, Uri uri) {
     if (identical(kind, UriKind.FILE_URI)) {
       return new FileBasedSource.con2(contentCache, new JavaFile.fromUri(uri), kind);
     }
     return null;
   }
   Source resolveAbsolute(ContentCache contentCache, Uri uri) {
     if (!isFileUri(uri)) {
       return null;
     }
     return new FileBasedSource.con1(contentCache, new JavaFile.fromUri(uri));
   }
 }