public class FunctionType extends PrototypeObjectType implements FunctionTypeI
Note: the parameters list is the LP node that is the parent of the actual NAME node containing the parsed argument list (annotated with JSDOC_TYPE_PROP's for the compile-time type of each argument.
JSType.TypePair
templateTypeMap
Modifier and Type | Method and Description |
---|---|
boolean |
canBeCalled()
This predicate is used to test whether a given type can be used as the
'function' in a function call.
|
List<FunctionType> |
checkExtendsLoop()
check if there is a loop in the type extends chain
|
List<FunctionType> |
checkExtendsLoop(HashSet<FunctionType> cache,
List<FunctionType> path) |
void |
clearCachedValues()
Clear cached values.
|
TypeI |
convertMethodToFunction()
Creates a new function type B based on the original function type A.
|
boolean |
explicitlyImplOrExtInterface(FunctionType interfaceType)
check whether or not this function type has implemented
the given interface
if this function is an interface, check whether or not
this interface has extended the given interface
|
void |
extendTemplateTypeMapBasedOn(ObjectType type)
Extends the TemplateTypeMap of the function's this type, based on the
specified type.
|
FunctionType |
forgetParameterAndReturnTypes()
Create a new constructor with the parameters and return type stripped.
|
Iterable<ObjectType> |
getAllImplementedInterfaces()
Returns all interfaces implemented by a class or its superclass and any
superclasses for any of those interfaces.
|
FunctionType |
getBindReturnType(int argsToBind)
Get the return value of calling "bind" on this function
with the specified number of arguments.
|
Iterable<ObjectType> |
getExtendedInterfaces()
Returns interfaces directly extended by an interface
|
int |
getExtendedInterfacesCount()
Returns the number of interfaces directly extended by an interface
|
Iterable<ObjectType> |
getImplementedInterfaces()
Returns interfaces implemented directly by a class or its superclass.
|
ObjectType |
getInstanceType()
Gets the type of instance of this function.
|
int |
getMaxArguments()
Gets the maximum number of arguments that this function requires,
or Integer.MAX_VALUE if this is a variable argument function.
|
int |
getMinArguments()
Gets the minimum number of arguments that this function requires.
|
Iterable<ObjectType> |
getOwnImplementedInterfaces()
Returns interfaces directly implemented by the class.
|
Set<String> |
getOwnPropertyNames()
Includes the prototype iff someone has created it.
|
Iterable<Node> |
getParameters() |
Node |
getParametersNode()
Gets an LP node that contains all params.
|
JSType |
getPropertyType(String name)
Gets the property type of the property whose name is given.
|
Map<String,JSType> |
getPropertyTypeMap()
get the map of properties to types covered in a function type
|
ObjectType |
getPrototype()
Gets the
prototype property of this function type. |
JSType |
getReturnType() |
Property |
getSlot(String name)
Default getSlot implementation.
|
Node |
getSource()
Gets the source node or null if this is an unknown function.
|
List<FunctionType> |
getSubTypes()
Returns a list of types that are subtypes of this type.
|
FunctionType |
getSuperClassConstructor()
Given a constructor or an interface type, get its superclass constructor
or
null if none exists. |
static ObjectType |
getTopDefiningInterface(ObjectType type,
String propertyName)
Given an interface and a property, finds the top-most super interface
that has the property defined (including this interface).
|
ObjectType |
getTopMostDefiningType(String propertyName)
Given a constructor or an interface type and a property, finds the
top-most superclass that has the property defined (including this
constructor).
|
JSType |
getTypeOfThis()
Gets the type of
this in this function. |
boolean |
hasAnyTemplateTypesInternal() |
boolean |
hasCachedValues()
Returns true if any cached values have been set for this type.
|
boolean |
hasEqualCallType(FunctionType otherType) |
int |
hashCode() |
boolean |
hasImplementedInterfaces() |
boolean |
hasInstanceType()
Returns whether this function type has an instance type.
|
boolean |
hasProperties() |
boolean |
isConstructor()
Whether this type is a
FunctionType that is a constructor or a
named type that points to such a type. |
boolean |
isInstanceType()
Whether this type is an Instance object of some constructor.
|
boolean |
isInterface()
Whether this type is a
FunctionType that is an interface or a named
type that points to such a type. |
boolean |
isOrdinaryFunction()
Whether this type is a
FunctionType that is an ordinary function or
a named type that points to such a type. |
boolean |
isReturnTypeInferred() |
boolean |
isStructuralInterface() |
boolean |
isSubtype(JSType that)
A function is a subtype of another if their call methods are related via
subtyping and
this is a subtype of that with regard to
the prototype chain. |
protected boolean |
isSubtype(JSType that,
com.google.javascript.rhino.jstype.JSType.ImplCache implicitImplCache)
checking isSubtype with structural interface matching
|
boolean |
makesDicts()
When a class B inherits from A and A is annotated as a dict, then B
automatically gets the annotation, even if B's constructor is not
explicitly annotated.
|
boolean |
makesStructs()
When a class B inherits from A and A is annotated as a struct, then B
automatically gets the annotation, even if B's constructor is not
explicitly annotated.
|
void |
setDict() |
void |
setExtendedInterfaces(List<ObjectType> extendedInterfaces) |
void |
setImplementedInterfaces(List<ObjectType> implementedInterfaces) |
void |
setImplicitMatch(boolean flag)
sets the current interface type to support
structural interface matching (abbr.
|
void |
setPrototypeBasedOn(ObjectType baseType)
Sets the prototype, creating the prototype object from the given
base type.
|
void |
setSource(Node source)
Sets the source node.
|
void |
setStruct() |
String |
toDebugHashCodeString()
A hash code function for diagnosing complicated issues
around type-identity.
|
FunctionType |
toMaybeFunctionType()
Downcasts this to a FunctionType, or returns null if this is not
a function.
|
protected boolean |
treatThisTypesAsCovariant(FunctionType other,
com.google.javascript.rhino.jstype.JSType.ImplCache implicitImplCache) |
<T> T |
visit(Visitor<T> visitor)
Visit this type with the given visitor.
|
getConstructor, getCtorExtendedInterfaces, getCtorImplementedInterfaces, getImplicitPrototype, getOwnerFunction, getReferenceName, hasReferenceName, isAnonymous, isNativeObjectType, matchConstraint, matchesNumberContext, matchesObjectContext, matchesStringContext, matchRecordTypeConstraint, removeProperty, setPropertyJSDocInfo, setPropertyNode, unboxesTo
cast, createDelegateSuffix, defineDeclaredProperty, defineInferredProperty, defineSynthesizedProperty, findPropertyType, getDisplayName, getJSDocInfo, getNormalizedReferenceName, getOwnPropertyJSDocInfo, getOwnSlot, getParentScope, getPossibleToBooleanOutcomes, getPropertiesCount, getPropertyNames, getPropertyNode, getRootNode, getTemplateTypes, hasOwnProperty, hasProperty, isFunctionPrototypeType, isObject, isPropertyInExterns, isPropertyTypeDeclared, isPropertyTypeInferred, isStructuralType, isUnknownType, setJSDocInfo, testForEquality
autobox, autoboxesTo, canCastTo, canTestForEqualityWith, canTestForShallowEqualityWith, collapseUnion, dereference, differsFrom, equals, extendTemplateTypeMap, getGreatestSubtype, getLeastSupertype, getRestrictedTypeGivenToBooleanOutcome, getTemplateTypeMap, getTypesUnderEquality, getTypesUnderInequality, getTypesUnderShallowEquality, getTypesUnderShallowInequality, hasAnyTemplateTypes, hasDisplayName, isAllType, isArrayType, isBooleanObjectType, isBooleanValueType, isBottom, isCheckedUnknownType, isDateType, isDict, isEmptyType, isEnumElementType, isEnumType, isEquivalent, isEquivalentTo, isEquivalentTo, isExplicitlyVoidable, isFunctionType, isGlobalThisType, isNamedType, isNominalConstructor, isNominalType, isNoObjectType, isNoResolvedType, isNoType, isNullable, isNullType, isNumber, isNumberObjectType, isNumberValueType, isRecordType, isRegexpType, isResolved, isString, isStringObjectType, isStringValueType, isStruct, isSubtypeOf, isSubtypeWithoutStructuralTyping, isTemplateType, isTemplatizedType, isUnionType, isVoidable, isVoidType, matchesInt32Context, matchesUint32Context, resolve, restrictByNotNullOrUndefined, setValidator, toAnnotationString, toMaybeEnumElementType, toMaybeEnumType, toMaybeFunctionType, toMaybeNamedType, toMaybeObjectType, toMaybeRecordType, toMaybeTemplateType, toMaybeTemplatizedType, toMaybeUnionType, toNonNullAnnotationString, toObjectType, toString
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
getReferenceName
isBottom, isEquivalentTo, isFunctionType, isSubtypeOf, isUnknownType, restrictByNotNullOrUndefined, toMaybeObjectType
public boolean isInstanceType()
JSType
InstanceObjectType
.isInstanceType
in class JSType
public boolean isConstructor()
JSType
FunctionType
that is a constructor or a
named type that points to such a type.isConstructor
in interface TypeI
isConstructor
in class JSType
public boolean isInterface()
JSType
FunctionType
that is an interface or a named
type that points to such a type.isInterface
in interface TypeI
isInterface
in class JSType
public boolean isOrdinaryFunction()
JSType
FunctionType
that is an ordinary function or
a named type that points to such a type.isOrdinaryFunction
in class JSType
public boolean makesStructs()
public boolean makesDicts()
public void setStruct()
public void setDict()
public FunctionType toMaybeFunctionType()
JSType
toMaybeFunctionType
in interface TypeI
toMaybeFunctionType
in class JSType
public boolean canBeCalled()
JSType
canBeCalled
in class PrototypeObjectType
true
if this type might be callable.public boolean hasImplementedInterfaces()
public Node getParametersNode()
public int getMinArguments()
public int getMaxArguments()
public JSType getReturnType()
public boolean isReturnTypeInferred()
public Property getSlot(String name)
ObjectType
getSlot
in class ObjectType
public Set<String> getOwnPropertyNames()
getOwnPropertyNames
in class ObjectType
public ObjectType getPrototype()
prototype
property of this function type. This is
equivalent to (ObjectType) getPropertyType("prototype")
.public void setPrototypeBasedOn(ObjectType baseType)
baseType
- The base type.public void extendTemplateTypeMapBasedOn(ObjectType type)
type
- public boolean explicitlyImplOrExtInterface(FunctionType interfaceType)
interfaceType
- the interface typepublic Iterable<ObjectType> getAllImplementedInterfaces()
public Iterable<ObjectType> getImplementedInterfaces()
public Iterable<ObjectType> getOwnImplementedInterfaces()
public void setImplementedInterfaces(List<ObjectType> implementedInterfaces)
public Iterable<ObjectType> getExtendedInterfaces()
public int getExtendedInterfacesCount()
public void setExtendedInterfaces(List<ObjectType> extendedInterfaces) throws UnsupportedOperationException
UnsupportedOperationException
public JSType getPropertyType(String name)
ObjectType
getPropertyType
in class ObjectType
UnknownType
. This method never
returns null
.public FunctionType getBindReturnType(int argsToBind)
public FunctionType getSuperClassConstructor()
null
if none exists.public static ObjectType getTopDefiningInterface(ObjectType type, String propertyName)
public ObjectType getTopMostDefiningType(String propertyName)
public boolean hasEqualCallType(FunctionType otherType)
public boolean isSubtype(JSType that)
this
is a subtype of that
with regard to
the prototype chain.isSubtype
in class PrototypeObjectType
this <: that
protected boolean isSubtype(JSType that, com.google.javascript.rhino.jstype.JSType.ImplCache implicitImplCache)
JSType
isSubtype
in class PrototypeObjectType
implicitImplCache
- a cache that records the checked
or currently checking type pairs, for example, if previous
checking found that constructor C is a subtype of interface I,
then in the cache, table key <I,C>
maps to IMPLEMENT status.protected boolean treatThisTypesAsCovariant(FunctionType other, com.google.javascript.rhino.jstype.JSType.ImplCache implicitImplCache)
public <T> T visit(Visitor<T> visitor)
JSType
visit
in class ObjectType
Visitor
public ObjectType getInstanceType()
getInstanceType
in interface FunctionTypeI
IllegalStateException
- if this function is not a constructor
(see isConstructor()
).public boolean hasInstanceType()
public JSType getTypeOfThis()
this
in this function.getTypeOfThis
in interface FunctionTypeI
getTypeOfThis
in class ObjectType
public Node getSource()
getSource
in interface FunctionTypeI
public void setSource(Node source)
setSource
in interface FunctionTypeI
public void clearCachedValues()
ObjectType
clearCachedValues
in class ObjectType
public List<FunctionType> getSubTypes()
getSubTypes
in interface FunctionTypeI
public boolean hasCachedValues()
ObjectType
hasCachedValues
in class PrototypeObjectType
public String toDebugHashCodeString()
JSType
toDebugHashCodeString
in class JSType
public FunctionType forgetParameterAndReturnTypes()
public boolean hasAnyTemplateTypesInternal()
public TypeI convertMethodToFunction()
FunctionTypeI
convertMethodToFunction
in interface FunctionTypeI
public boolean hasProperties()
hasProperties
in interface FunctionTypeI
public void setImplicitMatch(boolean flag)
flag
- indicates whether or not it should support SMIpublic boolean isStructuralInterface()
isStructuralInterface
in class JSType
public Map<String,JSType> getPropertyTypeMap()
getPropertyTypeMap
in class ObjectType
public List<FunctionType> checkExtendsLoop()
public List<FunctionType> checkExtendsLoop(HashSet<FunctionType> cache, List<FunctionType> path)
Copyright © 2009–2023 Google. All rights reserved.