1 /* 2 * Copyright 2016 Google Inc. All Rights Reserved. 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * http://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 17 package com.google.turbine.binder.lookup; 18 19 import com.google.common.collect.ImmutableList; 20 21 /** 22 * An index of canonical type names. 23 * 24 * <p>Used to resolve top-level qualified type names in the classpath, and the sources being 25 * compiled. Also provides lookup scopes for individual packages. 26 * 27 * <p>Only top-level classes are stored. Nested type names can't usually be assumed to be canonical 28 * (the qualifier may inherited the named type, rather than declaring it directly), so nested types 29 * are resolved separately with appropriate handling of non-canonical names. For bytecode we may end 30 * up storing desugared nested classes (e.g. {@code Map$Entry}), but we can't tell until the class 31 * file has been read and we have access to the InnerClasses attribtue. 32 */ 33 public interface TopLevelIndex { 34 35 /** Returns a scope to look up top-level qualified type names. */ scope()36 Scope scope(); 37 38 /** Returns a scope to look up members of the given package. */ lookupPackage(ImmutableList<String> packagename)39 Scope lookupPackage(ImmutableList<String> packagename); 40 } 41