Package com.google.javascript.rhino.jstype

Class ProxyObjectType

java.lang.Object
com.google.javascript.rhino.jstype.JSType
com.google.javascript.rhino.jstype.ObjectType
com.google.javascript.rhino.jstype.ProxyObjectType
Direct Known Subclasses:
NamedType, TemplateType, TemplatizedType
public class ProxyObjectType extends ObjectType
An object type which uses composition to delegate all calls.
See Also:

  • Method Details

    • getPropertyKind

      public final JSType.HasPropertyKind getPropertyKind(Property.Key propertyName, boolean autobox)
      Description copied from class: JSType
      Checks whether the property is present on the object.
      Overrides:
      getPropertyKind in class ObjectType
      Parameters:
      propertyName - The property name.
      autobox - Whether to check for the presents on an autoboxed type

    • loosenTypecheckingDueToForwardReferencedSupertype

      public final boolean loosenTypecheckingDueToForwardReferencedSupertype()
      Description copied from class: JSType
      During type definition, was one of the supertypes of this type a forward reference?

      This is a hack to work around the fact that inheritance chains and template types aren't wired up correctly when this happens, which causes various false positives in checks. The known bugs associated are b/145145406, b/144327372, and b/132980305.

      This method should only be used to suppress potential false positives caused by one of the above bugs, in the case where we think suppressing typechecking is preferable to emitting a false positive.

      Overrides:
      loosenTypecheckingDueToForwardReferencedSupertype in class JSType

    • 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

    • getReferenceName

      public 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.

      Returning an empty string means something different than returning null. An empty string may indicate an anonymous constructor, which we treat differently than a literal type without a reference name. e.g. in InstanceObjectType.appendTo(TypeStringBuilder)

      Specified by:
      getReferenceName in class ObjectType
      Returns:
      the object's name or null if this is an anonymous object

    • matchesNumberContext

      public final boolean matchesNumberContext()
      Description copied from class: JSType
      This predicate is used to test whether a given type can appear in a numeric context, such as an operand of a multiply operator.
      Overrides:
      matchesNumberContext in class JSType

    • matchesStringContext

      public final boolean matchesStringContext()
      Description copied from class: JSType
      This predicate is used to test whether a given type can appear in a String context, such as an operand of a string concat (+) operator. All types have at least the potential for converting to String. When we add externally defined types, such as a browser OM, we may choose to add types that do not automatically convert to String.
      Overrides:
      matchesStringContext in class JSType

    • matchesSymbolContext

      public final boolean matchesSymbolContext()
      Description copied from class: JSType
      This predicate is used to test whether a given type can appear in a symbol context such as property access.
      Overrides:
      matchesSymbolContext in class JSType

    • matchesObjectContext

      public final boolean matchesObjectContext()
      Description copied from class: JSType
      This predicate is used to test whether a given type can appear in an Object context, such as the expression in a with statement. Most types we will encounter, except notably null, have at least the potential for converting to Object. Host defined objects can get peculiar.
      Overrides:
      matchesObjectContext in class JSType

    • canBeCalled

      public final boolean canBeCalled()
      Description copied from class: JSType
      This predicate is used to test whether a given type can be used as the 'function' in a function call.
      Overrides:
      canBeCalled in class JSType
      Returns:
      true if this type might be callable.

    • isStructuralType

      public final boolean isStructuralType()
      Overrides:
      isStructuralType in class ObjectType

    • isNoType

      public final boolean isNoType()
      Overrides:
      isNoType in class JSType

    • isNoObjectType

      public final boolean isNoObjectType()
      Overrides:
      isNoObjectType in class JSType

    • isNoResolvedType

      public final boolean isNoResolvedType()
      Overrides:
      isNoResolvedType in class JSType

    • isUnknownType

      public final boolean isUnknownType()
      Description copied from class: ObjectType
      We treat this as the unknown type if any of its implicit prototype properties is unknown.
      Overrides:
      isUnknownType in class ObjectType

    • isCheckedUnknownType

      public final boolean isCheckedUnknownType()
      Overrides:
      isCheckedUnknownType in class JSType

    • isNullable

      public final boolean isNullable()
      Description copied from class: JSType
      Tests whether this type is nullable.
      Overrides:
      isNullable in class JSType

    • isVoidable

      public final boolean isVoidable()
      Description copied from class: JSType
      Tests whether this type is voidable.
      Overrides:
      isVoidable in class JSType

    • toMaybeEnumType

      public final EnumType toMaybeEnumType()
      Description copied from class: JSType
      Downcasts this to an EnumType, or returns null if this is not an EnumType.
      Overrides:
      toMaybeEnumType in class JSType

    • isConstructor

      public final boolean isConstructor()
      Description copied from class: JSType
      Whether this type is a FunctionType that is a constructor or a named type that points to such a type.
      Overrides:
      isConstructor 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 JSType

    • isInstanceType

      public final boolean isInstanceType()
      Description copied from class: JSType
      Whether this type is an Instance object of some constructor. Does not necessarily mean this is an InstanceObjectType.
      Overrides:
      isInstanceType in class JSType

    • isInterface

      public final boolean isInterface()
      Description copied from class: JSType
      Whether this type is a FunctionType that is an interface or a named type that points to such a type.
      Overrides:
      isInterface in class JSType

    • isOrdinaryFunction

      public final boolean isOrdinaryFunction()
      Description copied from class: JSType
      Whether this type is a FunctionType that is an ordinary function (i.e. not a constructor, nominal interface, or record interface), or a named type that points to such a type.
      Overrides:
      isOrdinaryFunction in class JSType

    • isAllType

      public final boolean isAllType()
      Overrides:
      isAllType in class JSType

    • isStruct

      public final boolean isStruct()
      Description copied from class: JSType
      Returns true iff this can be a struct. UnionType overrides the method, assume this is not a union here.
      Overrides:
      isStruct in class JSType

    • isDict

      public final boolean isDict()
      Description copied from class: JSType
      Returns true iff this can be a dict. UnionType overrides the method, assume this is not a union here.
      Overrides:
      isDict in class JSType

    • isNativeObjectType

      public final boolean isNativeObjectType()
      Description copied from class: ObjectType
      Whether this is a built-in object.
      Overrides:
      isNativeObjectType in class ObjectType

    • toMaybeRecordType

      public final RecordType toMaybeRecordType()
      Description copied from class: JSType
      Downcasts this to a RecordType, or returns null if this is not a RecordType.
      Overrides:
      toMaybeRecordType in class JSType

    • toMaybeUnionType

      public final UnionType toMaybeUnionType()
      Description copied from class: JSType
      Downcasts this to a UnionType, or returns null if this is not a UnionType. Named in honor of Haskell's Maybe type constructor.
      Overrides:
      toMaybeUnionType in class JSType

    • toMaybeFunctionType

      public final FunctionType toMaybeFunctionType()
      Description copied from class: JSType
      Downcasts this to a FunctionType, or returns null if this is not a function.

      For the purposes of this function, we define a MaybeFunctionType as any type in the sub-lattice { x | LEAST_FUNCTION_TYPE <= x <= GREATEST_FUNCTION_TYPE } This definition excludes bottom types like NoType and NoObjectType.

      This definition is somewhat arbitrary and axiomatic, but this is the definition that makes the most sense for the most callers.

      Overrides:
      toMaybeFunctionType in class JSType

    • toMaybeEnumElementType

      public final EnumElementType toMaybeEnumElementType()
      Description copied from class: JSType
      Downcasts this to an EnumElementType, or returns null if this is not an EnumElementType.
      Overrides:
      toMaybeEnumElementType in class JSType

    • toMaybeKnownSymbolType

      public final KnownSymbolType toMaybeKnownSymbolType()
      Overrides:
      toMaybeKnownSymbolType in class JSType

    • testForEquality

      public final Tri testForEquality(JSType that)
      Description copied from class: JSType
      Compares this and that.
      Overrides:
      testForEquality in class ObjectType
      Returns:
      • Tri.TRUE if the comparison of values of this type and that always succeed (such as undefined compared to null)
      • Tri.FALSE if the comparison of values of this type and that always fails (such as undefined compared to number)
      • Tri.UNKNOWN if the comparison can succeed or fail depending on the concrete values

    • getOwnerFunction

      public final @Nullable FunctionType getOwnerFunction()
      Overrides:
      getOwnerFunction in class ObjectType

    • getCtorImplementedInterfaces

      public Iterable<ObjectType> getCtorImplementedInterfaces()
      Description copied from class: ObjectType
      Gets the interfaces implemented by the ctor associated with this type. Intended to be overridden by subclasses.
      Overrides:
      getCtorImplementedInterfaces in class ObjectType

    • getCtorExtendedInterfaces

      public Iterable<ObjectType> getCtorExtendedInterfaces()
      Description copied from class: ObjectType
      Gets the interfaces extended by the interface associated with this type. Intended to be overridden by subclasses.
      Overrides:
      getCtorExtendedInterfaces in class ObjectType

    • getImplicitPrototype

      public final @Nullable ObjectType getImplicitPrototype()
      Description copied from class: ObjectType
      Gets the implicit prototype (a.k.a. the [[Prototype]] property).
      Specified by:
      getImplicitPrototype in class ObjectType

    • findPropertyTypeWithoutConsideringTemplateTypes

      protected JSType findPropertyTypeWithoutConsideringTemplateTypes(Property.Key propertyName)
      Description copied from class: JSType
      Looks up a property on this type, but without properly replacing any templates in the result.

      Subclasses can override this if they need more complicated logic for property lookup than just autoboxing to an object.

      This is only for use by findPropertyType(JSType). Call that method instead if you need to lookup a property on a random JSType

      Overrides:
      findPropertyTypeWithoutConsideringTemplateTypes in class ObjectType

    • getJSDocInfo

      public final JSDocInfo getJSDocInfo()
      Description copied from class: ObjectType
      Gets the docInfo for this type.
      Overrides:
      getJSDocInfo in class ObjectType

    • setJSDocInfo

      public final void setJSDocInfo(JSDocInfo info)
      Description copied from class: ObjectType
      Sets the docInfo for this type from the given JSDocInfo. The JSDocInfo may be null.
      Overrides:
      setJSDocInfo in class ObjectType

    • setPropertyJSDocInfo

      public final void setPropertyJSDocInfo(Property.Key propertyName, JSDocInfo info)
      Description copied from class: ObjectType
      Sets the docInfo for the specified property from the JSDocInfo on its definition.
      Overrides:
      setPropertyJSDocInfo in class ObjectType
      Parameters:
      info - JSDocInfo for the property definition. May be null.

    • getConstructor

      public final @Nullable FunctionType getConstructor()
      Description copied from class: ObjectType
      Gets this object's constructor.
      Specified by:
      getConstructor in class ObjectType
      Returns:
      this object's constructor or null if it is a native object (constructed natively v.s. by instantiation of a function)

    • getTemplateTypes

      public @Nullable com.google.common.collect.ImmutableList<JSType> getTemplateTypes()
      Description copied from class: ObjectType
      Gets the declared default element type.
      Overrides:
      getTemplateTypes in class ObjectType
      See Also:

    • getTemplateParamCount

      public int getTemplateParamCount()
      Description copied from class: JSType
      Return the number of template parameters declared for this type.

      In general, this value corresponds to the number of `@template` declarations on the type definition. It does not include template parameters from superclasses or superinterfaces.

      Overrides:
      getTemplateParamCount in class JSType

    • visitReferenceType

      public final <T> T visitReferenceType(Visitor<T> visitor)

    • visit

      public <T> T visit(Visitor<T> visitor)
      Description copied from class: JSType
      Visit this type with the given visitor.
      Overrides:
      visit in class ObjectType
      Returns:
      the value returned by the visitor
      See Also:

    • getTypeOfThis

      public final JSType getTypeOfThis()
      Overrides:
      getTypeOfThis in class ObjectType

    • collapseUnion

      public final JSType collapseUnion()
      Description copied from class: JSType
      Gets the least supertype of this that's not a union.
      Overrides:
      collapseUnion in class JSType

    • matchConstraint

      public final void matchConstraint(JSType constraint)
      Description copied from class: JSType
      Modify this type so that it matches the specified type.

      This is useful for reverse type-inference, where we want to infer that an object literal matches its constraint (much like how the java compiler does reverse-inference to figure out generics).

      Overrides:
      matchConstraint in class JSType

    • toMaybeTemplatizedType

      public TemplatizedType toMaybeTemplatizedType()
      Description copied from class: JSType
      Downcasts this to a TemplatizedType, or returns null if this is not a templatized type.
      Overrides:
      toMaybeTemplatizedType in class JSType

    • toMaybeTemplateType

      public TemplateType toMaybeTemplateType()
      Description copied from class: JSType
      Downcasts this to a TemplateType, or returns null if this is not a template type.
      Overrides:
      toMaybeTemplateType in class JSType

    • hasAnyTemplateTypesInternal

      public boolean hasAnyTemplateTypesInternal()

    • getTemplateTypeMap

      public TemplateTypeMap getTemplateTypeMap()
      Description copied from class: JSType
      Returns the template type map associated with this type.
      Overrides:
      getTemplateTypeMap in class JSType