com.google.javascript.jscomp.deps.DependencyResolver Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of closure-compiler-linter Show documentation

Closure Compiler is a JavaScript optimizing compiler. It parses your JavaScript, analyzes it, removes dead code and rewrites and minimizes what's left. It also checks syntax, variable references, and types, and warns about common JavaScript pitfalls. It is used in many of Google's JavaScript apps, including Gmail, Google Web Search, Google Maps, and Google Docs. This binary checks for style issues such as incorrect or missing JSDoc usage, and missing goog.require() statements. It does not do more advanced checks such as typechecking.

There is a newer version: v20200830

Show newest version

/*
 * Copyright 2009 The Closure Compiler Authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.google.javascript.jscomp.deps;

import java.util.Collection;
import java.util.Set;

/**
 * Interface for DependencyResolver to keep in line with 
 * {@link com.google.javascript.jscomp.deps.DefaultDependencyResolver}, which doesn't
 * provide an interface. This is so that later on, we can merge back with it.
 */
public interface DependencyResolver {

  /** Gets a list of dependencies for the provided code. */
  public Collection getDependencies(String code)
      throws ServiceException;

  /** Gets a list of dependencies for  *the provided list of symbols. */
  public Collection getDependencies(Collection symbols)
      throws ServiceException;

  /**
   * @param code The raw code to be parsed for requires.
   * @param seen The set of already seen symbols.
   * @param addClosureBaseFile Indicates whether the closure base file should be
   *        added to the dependency list.
   * @return A list of filenames for each of the dependencies for the provided
   *         code.
   * @throws ServiceException
   */
  public Collection getDependencies(String code,
      Set seen, boolean addClosureBaseFile) throws ServiceException;

  /**
   * @param symbols A list of required symbols.
   * @param seen The set of already seen symbols.
   * @return A list of filenames for each of the required symbols.
   * @throws ServiceException
   */
  public Collection getDependencies(Collection symbols,
      Set seen) throws ServiceException;

}