com.google.javascript.jscomp.newtypes

Class RawNominalType

java.lang.Object

com.google.javascript.jscomp.newtypes.Namespace

com.google.javascript.jscomp.newtypes.RawNominalType

public final class RawNominalType
extends Namespace

Represents a class or interface as defined in the code. If the raw nominal type has a @template, then many nominal types can be created from it by instantiation.

Author:

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

Field Summary

Fields inherited from class com.google.javascript.jscomp.newtypes.Namespace

commonTypes, name, namespaceType, otherProps

Method Summary

Modifier and Type	Method and Description
void	addClassProperty(String pname, Node defSite, JSType type, boolean isConstant) Add a new non-optional declared property to instances of this class
void	addCtorProperty(String pname, Node defSite, JSType type, boolean isConstant) Add a new non-optional declared property to this class's constructor
boolean	addInterfaces(com.google.common.collect.ImmutableSet<NominalType> interfaces)
void	addPropertyWhichMayNotBeOnAllInstances(String pname, JSType type)
void	addProtoProperty(String pname, Node defSite, JSType type, boolean isConstant) Add a new declared prototype property to this class
boolean	addSuperClass(NominalType superclass)
void	addUndeclaredClassProperty(String pname, JSType type, Node defSite) Add a new undeclared property to instances of this class
void	addUndeclaredCtorProperty(String pname, Node defSite) Add a new undeclared property to this class's constructor
void	addUndeclaredProtoProperty(String pname, Node defSite) Add a new undeclared prototype property to this class
protected JSType	computeJSType()
void	finalize()
Set<String>	getAllOwnProps()
NominalType	getAsNominalType()
FunctionType	getConstructorFunction()
JSType	getCtorPropDeclaredType(String pname)
Node	getDefSite()
JSType	getInstanceAsJSType()
JSType	getInstancePropDeclaredType(String pname)
JSType	getInstanceWithNullability(boolean includeNull)
com.google.common.collect.ImmutableSet<NominalType>	getInterfaces()
JSType	getProtoPropDeclaredType(String pname)
NominalType	getSuperClass()
boolean	hasCtorProp(String pname)
boolean	inheritsFromIObject()
boolean	isClass()
boolean	isDict()
boolean	isFinalized()
boolean	isInterface()
boolean	isStruct()
static RawNominalType	makeDictClass(JSTypes commonTypes, Node defSite, String name, com.google.common.collect.ImmutableList<String> typeParameters)
static RawNominalType	makeNominalInterface(JSTypes commonTypes, Node defSite, String name, com.google.common.collect.ImmutableList<String> typeParameters)
static RawNominalType	makeStructClass(JSTypes commonTypes, Node defSite, String name, com.google.common.collect.ImmutableList<String> typeParameters)
static RawNominalType	makeStructuralInterface(JSTypes commonTypes, Node defSite, String name, com.google.common.collect.ImmutableList<String> typeParameters)
static RawNominalType	makeUnrestrictedClass(JSTypes commonTypes, Node defSite, String name, com.google.common.collect.ImmutableList<String> typeParameters)
boolean	mayHaveOwnProp(String pname)
boolean	mayHaveProp(String pname)
void	setCtorFunction(FunctionType ctorFn)
String	toString()

Methods inherited from class com.google.javascript.jscomp.newtypes.Namespace

addNamespace, addProperty, addTypedef, addUndeclaredProperty, copyWindowProperties, getDeclaration, getName, getPropDeclaredType, getSubnamespace, hasProp, hasSubnamespace, isDefined, toJSType

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

makeUnrestrictedClass

public static RawNominalType makeUnrestrictedClass(JSTypes commonTypes,
                                                   Node defSite,
                                                   String name,
                                                   com.google.common.collect.ImmutableList<String> typeParameters)

makeStructClass

public static RawNominalType makeStructClass(JSTypes commonTypes,
                                             Node defSite,
                                             String name,
                                             com.google.common.collect.ImmutableList<String> typeParameters)

makeDictClass

public static RawNominalType makeDictClass(JSTypes commonTypes,
                                           Node defSite,
                                           String name,
                                           com.google.common.collect.ImmutableList<String> typeParameters)

makeNominalInterface

public static RawNominalType makeNominalInterface(JSTypes commonTypes,
                                                  Node defSite,
                                                  String name,
                                                  com.google.common.collect.ImmutableList<String> typeParameters)

makeStructuralInterface

public static RawNominalType makeStructuralInterface(JSTypes commonTypes,
                                                     Node defSite,
                                                     String name,
                                                     com.google.common.collect.ImmutableList<String> typeParameters)

getDefSite

public Node getDefSite()

isClass

public boolean isClass()

isInterface

public boolean isInterface()

isStruct

public boolean isStruct()

isDict

public boolean isDict()

isFinalized

public boolean isFinalized()

getConstructorFunction

public FunctionType getConstructorFunction()

setCtorFunction

public void setCtorFunction(FunctionType ctorFn)

addSuperClass

public boolean addSuperClass(NominalType superclass)

Returns:

Whether the superclass can be added without creating a cycle.

inheritsFromIObject

public boolean inheritsFromIObject()

addInterfaces

public boolean addInterfaces(com.google.common.collect.ImmutableSet<NominalType> interfaces)

Returns:

Whether the interface can be added without creating a cycle.

getSuperClass

public NominalType getSuperClass()

getInterfaces

public com.google.common.collect.ImmutableSet<NominalType> getInterfaces()

getProtoPropDeclaredType

public JSType getProtoPropDeclaredType(String pname)

mayHaveOwnProp

public boolean mayHaveOwnProp(String pname)

mayHaveProp

public boolean mayHaveProp(String pname)

getInstancePropDeclaredType

public JSType getInstancePropDeclaredType(String pname)

getAllOwnProps

public Set<String> getAllOwnProps()

addPropertyWhichMayNotBeOnAllInstances

public void addPropertyWhichMayNotBeOnAllInstances(String pname,
                                                   JSType type)

addClassProperty

public void addClassProperty(String pname,
                             Node defSite,
                             JSType type,
                             boolean isConstant)

Add a new non-optional declared property to instances of this class

addUndeclaredClassProperty

public void addUndeclaredClassProperty(String pname,
                                       JSType type,
                                       Node defSite)

Add a new undeclared property to instances of this class

addProtoProperty

public void addProtoProperty(String pname,
                             Node defSite,
                             JSType type,
                             boolean isConstant)

Add a new declared prototype property to this class

addUndeclaredProtoProperty

public void addUndeclaredProtoProperty(String pname,
                                       Node defSite)

Add a new undeclared prototype property to this class

hasCtorProp

public boolean hasCtorProp(String pname)

addCtorProperty

public void addCtorProperty(String pname,
                            Node defSite,
                            JSType type,
                            boolean isConstant)

Add a new non-optional declared property to this class's constructor

addUndeclaredCtorProperty

public void addUndeclaredCtorProperty(String pname,
                                      Node defSite)

Add a new undeclared property to this class's constructor

getCtorPropDeclaredType

public JSType getCtorPropDeclaredType(String pname)

finalize

public void finalize()

Overrides:

finalize in class Object

toString

public String toString()

Overrides:

toString in class Namespace

computeJSType

protected JSType computeJSType()

Specified by:

computeJSType in class Namespace

getAsNominalType

public NominalType getAsNominalType()

getInstanceAsJSType

public JSType getInstanceAsJSType()

getInstanceWithNullability

public JSType getInstanceWithNullability(boolean includeNull)