com.google.javascript.rhino

Interface FunctionTypeI

All Superinterfaces:

ObjectTypeI, java.io.Serializable, TypeI

All Known Implementing Classes:

FunctionType, NoObjectType, NoResolvedType, NoType

public interface FunctionTypeI
extends ObjectTypeI

Author:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	FunctionTypeI.Builder Interface for building FunctionTypeI instances.

Nested classes/interfaces inherited from interface com.google.javascript.rhino.TypeI

TypeI.Nullability, TypeI.TypeInference

Method Summary

Modifier and Type	Method and Description
boolean	acceptsArguments(java.util.List<? extends TypeI> argumentTypes) Checks if a call to this function with the given list of arguments is valid.
TypeI	convertMethodToFunction() Creates a new function type B based on the original function type A.
java.util.Collection<ObjectTypeI>	getAncestorInterfaces()
java.lang.Iterable<FunctionTypeI>	getDirectSubTypes() Returns an iterable of direct types that are subtypes of this type.
ObjectTypeI	getInstanceType() Returns a type representing an instance of this constructor, or null if this is not a constructor.
int	getMaxArity() Returns the maximum number of allowed arguments, or Integer.MAX_VALUE if variadic.
int	getMinArity() Returns the number of required arguments.
java.lang.Iterable<TypeI>	getParameterTypes()
ObjectTypeI	getPrototypeProperty()
java.lang.String	getReferenceName() For a constructor function, returns the name of the instances.
TypeI	getReturnType()
Node	getSource() Gets the AST Node where this function was defined.
TypeI	getTypeOfThis() Gets the type of this in this function.
boolean	hasInstanceType() Returns whether this type represents a constructor.
boolean	hasProperties() Whether this function type has any properties (not counting "prototype").
void	setSource(Node n)
FunctionTypeI.Builder	toBuilder() Returns a Builder instance initialized to this function.

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

getConstructor, getEnumeratedTypeOfEnumObject, getInstantiatedTypeArgument, getLegacyResolvedType, getOwnerFunction, getOwnPropertyDefSite, getOwnPropertyJSDocInfo, getOwnPropertyNames, getPropertyDefSite, getPropertyJSDocInfo, getPropertyNames, getPropertyType, getPrototypeObject, getRawType, getSuperClassConstructor, getTemplateTypes, getTopDefiningInterface, hasOwnProperty, hasProperty, instantiateGenericsWithUnknown, isAmbiguousObject, isInstanceType, isLegacyNamedType, normalizeObjectForCheckAccessControls, withoutStrayProperties

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

autobox, autoboxAndGetObject, containsArray, getDisplayName, getEnumeratedTypeOfEnumElement, getGreatestSubtypeWithProperty, getJSDocInfo, getTypeParameters, getUnionMembers, isBooleanValueType, isBottom, isBoxableScalar, isConstructor, isEnumElement, isEnumObject, isEquivalentTo, isFullyInstantiated, isFunctionType, isGenericObjectType, isInstanceofObject, isInterface, isLiteralObject, isNullable, isNullType, isNumberValueType, isObjectType, isPartiallyInstantiated, isPrototypeObject, isRecordType, isSomeUnknownType, isStringValueType, isStructuralInterface, isSubtypeOf, isSubtypeWithoutStructuralTyping, isTop, isTypeVariable, isUnionType, isUnknownType, isUnresolved, isUnresolvedOrResolvedUnknown, isVoidable, isVoidType, meetWith, restrictByNotNullOrUndefined, toAnnotationString, toMaybeFunctionType, toMaybeObjectType, typeInference

Method Detail

convertMethodToFunction

TypeI convertMethodToFunction()

Creates a new function type B based on the original function type A. Takes the receiver type (this type) of A and makes it the first argument of B; B has no receiver type. Used by the DevirtualizePrototypeMethods pass.

hasInstanceType

boolean hasInstanceType()

Returns whether this type represents a constructor.

getInstanceType

ObjectTypeI getInstanceType()

Returns a type representing an instance of this constructor, or null if this is not a constructor.

getReturnType

TypeI getReturnType()

getReferenceName

java.lang.String getReferenceName()

For a constructor function, returns the name of the instances. For other functions, returns null.

getSource

Node getSource()

Gets the AST Node where this function was defined.

getDirectSubTypes

java.lang.Iterable<FunctionTypeI> getDirectSubTypes()

Returns an iterable of direct types that are subtypes of this type. This is only valid for constructors and interfaces, and will not be null. This allows a downward traversal of the subtype graph.

getTypeOfThis

TypeI getTypeOfThis()

Gets the type of this in this function.

hasProperties

boolean hasProperties()

Whether this function type has any properties (not counting "prototype").

setSource

void setSource(Node n)

acceptsArguments

boolean acceptsArguments(java.util.List<? extends TypeI> argumentTypes)

Checks if a call to this function with the given list of arguments is valid.

getAncestorInterfaces

java.util.Collection<ObjectTypeI> getAncestorInterfaces()

getPrototypeProperty

ObjectTypeI getPrototypeProperty()

getParameterTypes

java.lang.Iterable<TypeI> getParameterTypes()

getMinArity

int getMinArity()

Returns the number of required arguments.

getMaxArity

int getMaxArity()

Returns the maximum number of allowed arguments, or Integer.MAX_VALUE if variadic.

toBuilder

FunctionTypeI.Builder toBuilder()

Returns a Builder instance initialized to this function.