com.google.api.tools.framework.model

Class SymbolTable

java.lang.Object

com.google.api.tools.framework.model.SymbolTable

@Immutable
public class SymbolTable
extends java.lang.Object

Represents a symbol table, an object mapping interfaces and types by name. It also maintains a set of simple names of fields. Established by stage Resolved.

Constructor Summary

Constructors

Constructor and Description
SymbolTable(java.util.Map<java.lang.String,Interface> interfaceByName, java.util.Map<java.lang.String,TypeRef> typeByName, java.util.Set<java.lang.String> fieldNames, java.util.Map<java.lang.String,? extends java.util.List<Method>> methodsBySimpleName)

Method Summary

Modifier and Type	Method and Description
boolean	containsFieldName(java.lang.String fieldName)
com.google.common.collect.ImmutableCollection<TypeRef>	getDeclaredTypes() Get all declared types in the symbol table.
com.google.common.collect.ImmutableCollection<Interface>	getInterfaces() Get all interfaces in the symbol table.
static java.lang.String	getTypeNameInSymbolTable(java.lang.String fullName) Returns the type name used to store in symbol table.
Interface	lookupInterface(java.lang.String fullName) Get the interface by its full name.
java.util.List<TypeRef>	lookupMatchingTypes(java.lang.String typeNamePattern, com.google.protobuf.DescriptorProtos.FieldDescriptorProto.Type kind) Get the list of types that match the typeNamePattern and the kind.
java.util.List<Method>	lookupMethodSimpleName(java.lang.String methodName)
TypeRef	lookupType(java.lang.String fullName) Get the type by its full name.
static java.lang.Iterable<java.lang.String>	nameCandidates(java.lang.String inContainer, java.lang.String name) Returns the candidates for name resolution of a name within a container(e.g.
ProtoElement	resolve(java.lang.String id) Attempts to resolve the given id into a protocol element, applying certain heuristics.
Interface	resolveInterface(java.lang.String inPackage, java.lang.String name) Resolves a interface by a partial name within a given package context, following PB (== C++) conventions.
TypeRef	resolveType(java.lang.String inPackage, java.lang.String name) Resolves a type by its partial name within a given package context, following PB (== C++) conventions.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SymbolTable

public SymbolTable(java.util.Map<java.lang.String,Interface> interfaceByName,
                   java.util.Map<java.lang.String,TypeRef> typeByName,
                   java.util.Set<java.lang.String> fieldNames,
                   java.util.Map<java.lang.String,? extends java.util.List<Method>> methodsBySimpleName)

Method Detail

lookupInterface

@Nullable
public Interface lookupInterface(java.lang.String fullName)

Get the interface by its full name.

resolveInterface

@Nullable
public Interface resolveInterface(java.lang.String inPackage,
                                            java.lang.String name)

Resolves a interface by a partial name within a given package context, following PB (== C++) conventions.

lookupType

@Nullable
public TypeRef lookupType(java.lang.String fullName)

Get the type by its full name.

lookupMatchingTypes

public java.util.List<TypeRef> lookupMatchingTypes(java.lang.String typeNamePattern,
                                                   com.google.protobuf.DescriptorProtos.FieldDescriptorProto.Type kind)

Get the list of types that match the typeNamePattern and the kind. Pattern can be of the form foo.bar.* to match any name which starts with the prefix foo.bar, or a fixed name.

getTypeNameInSymbolTable

public static java.lang.String getTypeNameInSymbolTable(java.lang.String fullName)

Returns the type name used to store in symbol table.

Message fullname starts with a '.' if no package is specified in the proto file. Remove the preceding '.' to make it consistent with other types.

resolveType

@Nullable
public TypeRef resolveType(java.lang.String inPackage,
                                     java.lang.String name)

Resolves a type by its partial name within a given package context, following PB (== C++) conventions. If the given name is a builtin type name for a primitive type in the PB language, a reference for that type will be returned.

getInterfaces

public com.google.common.collect.ImmutableCollection<Interface> getInterfaces()

Get all interfaces in the symbol table.

getDeclaredTypes

public com.google.common.collect.ImmutableCollection<TypeRef> getDeclaredTypes()

Get all declared types in the symbol table.

nameCandidates

public static java.lang.Iterable<java.lang.String> nameCandidates(java.lang.String inContainer,
                                                                  java.lang.String name)

Returns the candidates for name resolution of a name within a container(e.g. package, message, enum, service elements) context following PB (== C++) conventions. Iterates those names which shadow other names first; recognizes and removes a leading '.' for overriding shadowing. Given a container name a.b.c.M.N and a type name R.s, this will deliver in order a.b.c.M.N.R.s, a.b.c.M.R.s, a.b.c.R.s, a.b.R.s, a.R.s, R.s.

resolve

@Nullable
public ProtoElement resolve(java.lang.String id)

Attempts to resolve the given id into a protocol element, applying certain heuristics.

First the name is attempted to interpret as a type or as an interface, in that order. If that succeeds, the associated proto element is returned.

If resolution does not succeed, the last component of the name is chopped of, and resolution is attempted recursively on the parent name. On success, the chopped name is looked up in the parent depending on its type.

containsFieldName

public boolean containsFieldName(java.lang.String fieldName)

lookupMethodSimpleName

@Nullable
public java.util.List<Method> lookupMethodSimpleName(java.lang.String methodName)