com.google.javascript.rhino.jstype

Class NamedType

java.lang.Object

com.google.javascript.rhino.jstype.JSType

com.google.javascript.rhino.jstype.ObjectType

com.google.javascript.rhino.jstype.ProxyObjectType

com.google.javascript.rhino.jstype.NamedType

All Implemented Interfaces:

ObjectTypeI, TypeI, java.io.Serializable

Direct Known Subclasses:

NamespaceType

public class NamedType
extends ProxyObjectType

A NamedType is a named reference to some other type. This provides a convenient mechanism for implementing forward references to types; a NamedType can be used as a placeholder until its reference is resolved. It is also useful for representing type names in JsDoc type annotations, some of which may never be resolved (as they may refer to types in host systems not yet supported by JSCompiler, such as the JVM.)

An important distinction: NamedType is a type name reference, whereas ObjectType is a named type object, such as an Enum name. The Enum itself is typically used only in a dot operator to name one of its constants, or in a declaration, where its name will appear in a NamedType.

A NamedType is not currently a full-fledged typedef, because it cannot resolve to any JavaScript type. It can only resolve to a named JSTypeRegistry type, or to FunctionType or EnumType.

If full typedefs are to be supported, then each method on each type class needs to be reviewed to make sure that everything works correctly through typedefs. Alternatively, we would need to walk through the parse tree and unroll each reference to a NamedType to its resolved type before applying the rest of the analysis.

TODO(user): Revisit all of this logic.

The existing typing logic is hacky. Unresolved types should get processed in a more consistent way, but with the Rhino merge coming, there will be much that has to be changed.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	NamedType.PropertyContinuation Store enough information to define a property at a later time.

Nested classes/interfaces inherited from class com.google.javascript.rhino.jstype.JSType

JSType.EqCache, JSType.ImplCache, JSType.MatchStatus, JSType.TypePair

Field Summary

Fields

Modifier and Type	Field and Description
private int	charno
private int	lineno
private java.util.List<NamedType.PropertyContinuation>	propertyContinuations Property-defining continuations.
private java.lang.String	reference
private static long	serialVersionUID
private java.lang.String	sourceName
private com.google.common.base.Predicate<JSType>	validator Validates the type resolution.

Fields inherited from class com.google.javascript.rhino.jstype.JSType

ALPHA, registry, templateTypeMap

Constructor Summary

Constructors

Constructor and Description
NamedType(JSTypeRegistry registry, java.lang.String reference, java.lang.String sourceName, int lineno, int charno) Create a named type based on the reference.

Method Summary

Modifier and Type	Method and Description
private void	checkEnumElementCycle(ErrorReporter t)
private void	checkProtoCycle(ErrorReporter t)
(package private) boolean	defineProperty(java.lang.String propertyName, JSType type, boolean inferred, Node propertyNode) Defines a property.
private void	finishPropertyContinuations()
JSType	getReferencedType() Returns the type to which this refers (which is unknown if unresolved).
java.lang.String	getReferenceName() Gets the reference name for this object.
private JSType	getTypedefType(ErrorReporter t, StaticTypedSlot<JSType> slot)
private void	handleTypeCycle(ErrorReporter t)
private void	handleUnresolvedType(ErrorReporter t, boolean ignoreForwardReferencedTypes)
int	hashCode()
boolean	hasReferenceName() Returns true if the object is named.
boolean	isNominalType() Whether this type is a nominal type (a named instance object or a named enum).
private JSType	lookupViaProperties(ErrorReporter reporter, StaticTypedScope<JSType> enclosing) Resolves a type by looking up its first component in the scope, and subsequent components as properties.
(package private) JSType	resolveInternal(ErrorReporter t, StaticTypedScope<JSType> enclosing) Resolve the referenced type within the enclosing scope.
private void	resolveViaProperties(ErrorReporter reporter, StaticTypedScope<JSType> enclosing) Resolves a named type by looking up its first component in the scope, and subsequent components as properties.
private boolean	resolveViaRegistry(ErrorReporter reporter) Resolves a named type by looking it up in the registry.
private void	setReferencedAndResolvedType(JSType type, ErrorReporter reporter)
boolean	setValidator(com.google.common.base.Predicate<JSType> validator) Certain types have constraints on them at resolution-time.
NamedType	toMaybeNamedType()
(package private) java.lang.String	toStringHelper(boolean forAnnotations)
<T> T	visit(Visitor<T> visitor) Visit this type with the given visitor.
(package private) void	warning(ErrorReporter reporter, java.lang.String message)

Methods inherited from class com.google.javascript.rhino.jstype.ProxyObjectType

canBeCalled, collapseUnion, findPropertyType, getConstructor, getCtorImplementedInterfaces, getImplicitPrototype, getJSDocInfo, getOwnerFunction, getPropertyMap, getReferencedObjTypeInternal, getReferencedTypeInternal, getTemplateTypeMap, getTemplateTypes, getTypeOfThis, hasAnyTemplateTypesInternal, isAllType, isCheckedUnknownType, isConstructor, isDict, isInstanceType, isInterface, isNativeObjectType, isNoObjectType, isNoResolvedType, isNoType, isNullable, isOrdinaryFunction, isStruct, isStructuralType, isSubtype, isSubtype, isUnknownType, matchConstraint, matchesNumberContext, matchesObjectContext, matchesStringContext, removeProperty, setJSDocInfo, setPropertyJSDocInfo, setReferencedType, testForEquality, toDebugHashCodeString, toMaybeEnumElementType, toMaybeEnumType, toMaybeFunctionType, toMaybeRecordType, toMaybeTemplateType, toMaybeTemplatizedType, toMaybeUnionType, visit, visitReferenceType

Methods inherited from class com.google.javascript.rhino.jstype.ObjectType

cast, checkStructuralEquivalenceHelper, clearCachedValues, collectPropertyNames, createDelegateSuffix, defineDeclaredProperty, defineInferredProperty, defineSynthesizedProperty, detectImplicitPrototypeCycle, detectInheritanceCycle, getCtorExtendedInterfaces, getDisplayName, getNormalizedReferenceName, getOwnPropertyJSDocInfo, getOwnPropertyNames, getOwnSlot, getParentScope, getPossibleToBooleanOutcomes, getPropertiesCount, getPropertyNames, getPropertyNode, getPropertyType, getPropertyTypeMap, getRootNode, getSlot, hasCachedValues, hasOwnDeclaredProperty, hasOwnProperty, hasProperty, isFunctionPrototypeType, isImplicitPrototype, isObject, isPropertyInExterns, isPropertyTypeDeclared, isPropertyTypeInferred, isStructuralSubtype, setOwnerFunction, setPropertyNode

Methods inherited from class com.google.javascript.rhino.jstype.JSType

autobox, autoboxesTo, canCastTo, canTestForEqualityWith, canTestForShallowEqualityWith, checkEquivalenceHelper, checkEquivalenceHelper, dereference, differsFrom, equals, extendTemplateTypeMap, filterNoResolvedType, getGreatestSubtype, getGreatestSubtype, getLeastSupertype, getLeastSupertype, getNativeType, getRestrictedTypeGivenToBooleanOutcome, getTypesUnderEquality, getTypesUnderInequality, getTypesUnderShallowEquality, getTypesUnderShallowInequality, hasAnyTemplateTypes, hasDisplayName, isArrayType, isBooleanObjectType, isBooleanValueType, isBottom, isDateType, isEmptyType, isEnumElementType, isEnumType, isEquivalent, isEquivalentTo, isEquivalentTo, isExemptFromTemplateTypeInvariance, isExplicitlyVoidable, isFunctionType, isGlobalThisType, isNamedType, isNominalConstructor, isNullType, isNumber, isNumberObjectType, isNumberValueType, isRecordType, isRegexpType, isResolved, isString, isStringObjectType, isStringValueType, isStructuralInterface, isSubtypeHelper, isSubtypeOf, isSubtypeWithoutStructuralTyping, isTemplateType, isTemplatizedType, isTheObjectType, isUnionType, isVoidable, isVoidType, matchesInt32Context, matchesUint32Context, resolve, restrictByNotNullOrUndefined, safeResolve, setResolvedTypeInternal, testForEqualityHelper, toAnnotationString, toMaybeFunctionType, toMaybeObjectType, toNonNullAnnotationString, toObjectType, toString, unboxesTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.javascript.rhino.TypeI

isBottom, isEquivalentTo, isFunctionType, isSubtypeOf, restrictByNotNullOrUndefined, toMaybeObjectType

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

reference

private final java.lang.String reference

sourceName

private final java.lang.String sourceName

lineno

private final int lineno

charno

private final int charno

validator

private com.google.common.base.Predicate<JSType> validator

Validates the type resolution.

propertyContinuations

private java.util.List<NamedType.PropertyContinuation> propertyContinuations

Property-defining continuations.

Constructor Detail

NamedType

NamedType(JSTypeRegistry registry,
          java.lang.String reference,
          java.lang.String sourceName,
          int lineno,
          int charno)

Create a named type based on the reference.

Method Detail

defineProperty

boolean defineProperty(java.lang.String propertyName,
                       JSType type,
                       boolean inferred,
                       Node propertyNode)

Description copied from class: ObjectType

Defines a property.

For clarity, callers should prefer ObjectType.defineDeclaredProperty(java.lang.String, com.google.javascript.rhino.jstype.JSType, com.google.javascript.rhino.Node) and ObjectType.defineInferredProperty(java.lang.String, com.google.javascript.rhino.jstype.JSType, com.google.javascript.rhino.Node).

Overrides:

defineProperty in class ProxyObjectType

Parameters:

propertyName - the property's name

type - the type

inferred - true if this property's type is inferred

propertyNode - the node that represents the definition of property. Depending on the actual sub-type the node type might be different. The general idea is to have an estimate of where in the source code this property is defined.

Returns:

True if the property was registered successfully, false if this conflicts with a previous property type declaration.

finishPropertyContinuations

private void finishPropertyContinuations()

getReferencedType

public JSType getReferencedType()

Returns the type to which this refers (which is unknown if unresolved).

getReferenceName

public java.lang.String getReferenceName()

Description copied from class: ObjectType

Gets the reference name for this object. This includes named types like constructors, prototypes, and enums. It notably does not include literal types like strings and booleans and structural types.

Overrides:

getReferenceName in class ProxyObjectType

Returns:

the object's name or null if this is an anonymous object

toStringHelper

java.lang.String toStringHelper(boolean forAnnotations)

Overrides:

toStringHelper in class ProxyObjectType

Parameters:

forAnnotations - Whether this is for use in code generator annotations. Otherwise, it's for warnings.

hasReferenceName

public boolean hasReferenceName()

Description copied from class: ObjectType

Returns true if the object is named.

Overrides:

hasReferenceName in class ProxyObjectType

Returns:

true if the object is named, false if it is anonymous

toMaybeNamedType

public NamedType toMaybeNamedType()

Overrides:

toMaybeNamedType in class JSType

isNominalType

public boolean isNominalType()

Description copied from class: JSType

Whether this type is a nominal type (a named instance object or a named enum).

Overrides:

isNominalType in class ProxyObjectType

hashCode

public int hashCode()

Overrides:

hashCode in class ProxyObjectType

resolveInternal

JSType resolveInternal(ErrorReporter t,
                       StaticTypedScope<JSType> enclosing)

Resolve the referenced type within the enclosing scope.

Overrides:

resolveInternal in class ProxyObjectType

See Also:

JSType.resolve(com.google.javascript.rhino.ErrorReporter, com.google.javascript.rhino.jstype.StaticTypedScope<com.google.javascript.rhino.jstype.JSType>)

resolveViaRegistry

private boolean resolveViaRegistry(ErrorReporter reporter)

Resolves a named type by looking it up in the registry.

Returns:

True if we resolved successfully.

resolveViaProperties

private void resolveViaProperties(ErrorReporter reporter,
                                  StaticTypedScope<JSType> enclosing)

Resolves a named type by looking up its first component in the scope, and subsequent components as properties. The scope must have been fully parsed and a symbol table constructed.

lookupViaProperties

private JSType lookupViaProperties(ErrorReporter reporter,
                                   StaticTypedScope<JSType> enclosing)

Resolves a type by looking up its first component in the scope, and subsequent components as properties. The scope must have been fully parsed and a symbol table constructed.

Returns:

The type of the symbol, or null if the type could not be found.

setReferencedAndResolvedType

private void setReferencedAndResolvedType(JSType type,
                                          ErrorReporter reporter)

handleTypeCycle

private void handleTypeCycle(ErrorReporter t)

checkEnumElementCycle

private void checkEnumElementCycle(ErrorReporter t)

checkProtoCycle

private void checkProtoCycle(ErrorReporter t)

handleUnresolvedType

private void handleUnresolvedType(ErrorReporter t,
                                  boolean ignoreForwardReferencedTypes)

getTypedefType

private JSType getTypedefType(ErrorReporter t,
                              StaticTypedSlot<JSType> slot)

setValidator

public boolean setValidator(com.google.common.base.Predicate<JSType> validator)

Description copied from class: JSType

Certain types have constraints on them at resolution-time. For example, a type in an @extends annotation must be an object. Clients should inject a validator that emits a warning if the type does not validate, and return false.

Overrides:

setValidator in class JSType

warning

void warning(ErrorReporter reporter,
             java.lang.String message)

visit

public <T> T visit(Visitor<T> visitor)

Description copied from class: JSType

Visit this type with the given visitor.

Overrides:

visit in class ProxyObjectType

Returns:

the value returned by the visitor

See Also:

Visitor