com.google.javascript.jscomp.newtypes

Class JSTypeCreatorFromJSDoc

java.lang.Object

com.google.javascript.jscomp.newtypes.JSTypeCreatorFromJSDoc

public class JSTypeCreatorFromJSDoc
extends Object

Author:

blickly@google.com (Ben Lickly), dimvar@google.com (Dimitris Vardoulakis)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JSTypeCreatorFromJSDoc.UnknownTypeException Exception for when unrecognized type names are encountered

Constructor Summary

Constructors

Constructor and Description
JSTypeCreatorFromJSDoc()

Method Summary

Methods

Modifier and Type	Method and Description
com.google.common.collect.ImmutableSet<NominalType>	getExtendedInterfaces(JSDocInfo jsdoc, NominalType.RawNominalType ownerType, DeclaredTypeRegistry registry, com.google.common.collect.ImmutableList<String> typeParameters)
FunctionTypeBuilder	getFunctionType(JSDocInfo jsdoc, Node funNode, NominalType.RawNominalType ownerType, DeclaredTypeRegistry registry) Consumes either a "classic" function jsdoc with @param, @return, etc, or a jsdoc with @type{function ...} and finds the types of the formal parameters and the return value.
com.google.common.collect.ImmutableSet<NominalType>	getImplementedInterfaces(JSDocInfo jsdoc, NominalType.RawNominalType ownerType, DeclaredTypeRegistry registry, com.google.common.collect.ImmutableList<String> typeParameters)
JSType	getNodeTypeDeclaration(JSDocInfo jsdoc, NominalType.RawNominalType ownerType, DeclaredTypeRegistry registry)
NominalType	getNominalType(Node n, NominalType.RawNominalType ownerType, DeclaredTypeRegistry registry, com.google.common.collect.ImmutableList<String> typeParameters)
Map<Node,String>	getUnknownTypesMap()
Set<String>	getWarnings()
boolean	hasKnownType(Node n, NominalType.RawNominalType ownerType, DeclaredTypeRegistry registry, com.google.common.collect.ImmutableList<String> typeParameters)
boolean	isRestArg(JSDocInfo funJsdoc, String formalParamName)

Methods inherited from class java.lang.Object

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

Constructor Detail

JSTypeCreatorFromJSDoc

public JSTypeCreatorFromJSDoc()

Method Detail

getNodeTypeDeclaration

public JSType getNodeTypeDeclaration(JSDocInfo jsdoc,
                            NominalType.RawNominalType ownerType,
                            DeclaredTypeRegistry registry)

getWarnings

public Set<String> getWarnings()

getUnknownTypesMap

public Map<Node,String> getUnknownTypesMap()

hasKnownType

public boolean hasKnownType(Node n,
                   NominalType.RawNominalType ownerType,
                   DeclaredTypeRegistry registry,
                   com.google.common.collect.ImmutableList<String> typeParameters)

getNominalType

public NominalType getNominalType(Node n,
                         NominalType.RawNominalType ownerType,
                         DeclaredTypeRegistry registry,
                         com.google.common.collect.ImmutableList<String> typeParameters)

getImplementedInterfaces

public com.google.common.collect.ImmutableSet<NominalType> getImplementedInterfaces(JSDocInfo jsdoc,
                                                                           NominalType.RawNominalType ownerType,
                                                                           DeclaredTypeRegistry registry,
                                                                           com.google.common.collect.ImmutableList<String> typeParameters)

getExtendedInterfaces

public com.google.common.collect.ImmutableSet<NominalType> getExtendedInterfaces(JSDocInfo jsdoc,
                                                                        NominalType.RawNominalType ownerType,
                                                                        DeclaredTypeRegistry registry,
                                                                        com.google.common.collect.ImmutableList<String> typeParameters)

getFunctionType

public FunctionTypeBuilder getFunctionType(JSDocInfo jsdoc,
                                  Node funNode,
                                  NominalType.RawNominalType ownerType,
                                  DeclaredTypeRegistry registry)

Consumes either a "classic" function jsdoc with @param, @return, etc, or a jsdoc with @type{function ...} and finds the types of the formal parameters and the return value. It returns a builder because the callers of this function must separately handle @constructor, @interface, etc.

isRestArg

public boolean isRestArg(JSDocInfo funJsdoc,
                String formalParamName)