com.google.javascript.rhino

Interface NominalTypeBuilder

All Known Implementing Classes:

NominalTypeBuilderOti

public interface NominalTypeBuilder

Builder interface for declaring properties on class-like (nominal) types. Nominal types consist primarily of three separate object types, which may each have their own properties declared on them separately: (1) the constructor function, (2) the instance type, and (3) the prototype object. This interface is used during the first part of type checking, while the type checker builds up the set of known types. At this stage, not all types actually exist in a usable form: specifically, NTI cannot express the type of a prototype object until immediately before the owner type is frozen. Thus, this interface serves as a placeholder to allow operating on (i.e. both assigning properties to, and referencing the yet-to-exist type) these not-yet-available types.

Method Summary

Modifier and Type	Method and Description
FunctionType	constructor() Returns the constructor as a JSType.
void	declareConstructorProperty(java.lang.String name, JSType type, Node defSite) Declares a static property on the nominal type's constructor.
void	declareInstanceProperty(java.lang.String name, JSType type, Node defSite) Declares an instance property on the nominal type.
void	declarePrototypeProperty(java.lang.String name, JSType type, Node defSite) Declares a property on the nominal type's prototype.
ObjectType	instance() Returns the instance type as a JSType.
ObjectType	prototypeOrInstance() Returns the type of the prototype object (OTI) or instance (NTI).
NominalTypeBuilder	superClass() Returns a NominalTypeBuilder for this type's superclass.

Method Detail

declareConstructorProperty

void declareConstructorProperty(java.lang.String name,
                                JSType type,
                                Node defSite)

Declares a static property on the nominal type's constructor.

declareInstanceProperty

void declareInstanceProperty(java.lang.String name,
                             JSType type,
                             Node defSite)

Declares an instance property on the nominal type.

declarePrototypeProperty

void declarePrototypeProperty(java.lang.String name,
                              JSType type,
                              Node defSite)

Declares a property on the nominal type's prototype.

superClass

NominalTypeBuilder superClass()

Returns a NominalTypeBuilder for this type's superclass.

constructor

FunctionType constructor()

Returns the constructor as a JSType.

instance

ObjectType instance()

Returns the instance type as a JSType.

prototypeOrInstance

ObjectType prototypeOrInstance()

Returns the type of the prototype object (OTI) or instance (NTI).