com.google.gwt.dev.jjs.ast

Class JDeclaredType

java.lang.Object

com.google.gwt.dev.jjs.ast.JNode

com.google.gwt.dev.jjs.ast.JType

com.google.gwt.dev.jjs.ast.JReferenceType

com.google.gwt.dev.jjs.ast.JDeclaredType

All Implemented Interfaces:

CanBeAbstract, CanBeFinal, HasName, JVisitable, HasSourceInfo, Serializable

Direct Known Subclasses:

JClassType, JInterfaceType

public abstract class JDeclaredType
extends JReferenceType

Base class for any declared type. Declared types have fields and methods. Two of the methods are treated specially: the class initializer method (named $clinit) and the instance initializer method (named $init). The class initializer method is responsible for initializing all class variables as well as those of the superclasses (by calling the superclass class initializer method). The instance initializer is responsible for initializing all instance variables as well as those of the superclasses (by calling the superclass instance initializer method). Optimizations may eliminate class initializers ($clinit) if no static variables need initialization, and use the private variable clinitTargetto keep track which initializer in the superclass chain needs to be called.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JDeclaredType.JsInteropType The type of JsType this can be: NONE, NO_PROTOTYPE, JS_PROTOTYPE, NATIVE_PROTOTYPE (e.g.

Nested classes/interfaces inherited from interface com.google.gwt.dev.jjs.ast.HasName

HasName.Util

Field Summary

Fields

Modifier and Type	Field and Description
protected List<JField>	fields This type's fields.
protected JDeclaredType.JsInteropType	jsInteropType
protected String	jsPrototype
protected List<JMethod>	methods This type's methods.

Fields inherited from class com.google.gwt.dev.jjs.ast.JType

name

Fields inherited from interface com.google.gwt.dev.jjs.ast.HasName

BY_NAME_COMPARATOR

Constructor Summary

Constructors

Constructor and Description
JDeclaredType(SourceInfo info, String name, JDeclaredType.JsInteropType interopType)
JDeclaredType(SourceInfo info, String name, JDeclaredType.JsInteropType interopType, String jsPrototype)

Method Summary

Methods

Modifier and Type	Method and Description
void	addField(JField field) Adds a field to this type.
void	addImplements(JInterfaceType superInterface) Adds an implemented interface to this type.
void	addMethod(JMethod method) Adds a method to this type.
boolean	checkClinitTo(JDeclaredType targetType) Returns true if a static field access of targetType from within this type should generate a clinit call.
JMethod	findMethod(String methodSignature, boolean recurse) Returns the method with the given signature, if there is one. Optionally can search up the super type chain.
JDeclaredType	findSubtype(Iterable<JDeclaredType> types) Determines whether a subclass of this type is in the collection types.
JMethod	getClinitMethod() Returns the class initializer method.
JDeclaredType	getClinitTarget() Returns the class that must be initialized to use this class.
String[]	getCompoundName() Returns the compound name.
JDeclaredType	getEnclosingType() Returns the type which encloses this type.
List<JField>	getFields() Returns this type's fields;does not include fields defined in a super type unless they are overridden by this type.
List<JInterfaceType>	getImplements() Returns this type's implemented interfaces.
JMethod	getInitMethod() Returns the instance initializer ($init) method.
String	getJavahSignatureName()
JDeclaredType.JsInteropType	getJsInteropType()
String	getJsNamespace()
String	getJsniSignatureName()
String	getJsPrototype()
List<JMethod>	getMethods() Returns this type's declared methods; does not include methods defined in a super type unless they are overridden by this type.
String	getQualifiedExportName()
abstract JClassType	getSuperClass() Returns this type's super class, or null if this type is Object or an interface.
boolean	hasClinit() Returns true when this class's clinit must be run dynamically.
boolean	isExternal() True if this class is provided externally to the program by the program's host execution environment.
boolean	isInstantiable() Returns whether this type can be instantiated.
boolean	isJsType()
void	removeField(int i) Removes the field at the specified index.
void	removeMethod(int i) Removes the method at the specified index.
void	resolve(List<JInterfaceType> resolvedInterfaces, String jsNamespace) Resolves external references during AST stitching.
void	setEnclosingType(JDeclaredType enclosingType) Sets the type which encloses this types.
void	setExternal(boolean isExternal)
void	setJsNamespace(String jsNamespace)
void	sortFields(Comparator<? super JField> sort) Sorts this type's fields according to the specified sort.
void	sortMethods(Comparator<? super JMethod> sort) Sorts this type's methods according to the specified sort.
protected abstract Object	writeReplace() Subclasses must replace themselves with a shallow reference when isExternal() is true.

Methods inherited from class com.google.gwt.dev.jjs.ast.JReferenceType

canBeNull, getDefaultValue, getNonNull, getUnderlyingType, replaces

Methods inherited from class com.google.gwt.dev.jjs.ast.JType

getName, getPackageName, getShortName, isEnumOrSubclass

Methods inherited from class com.google.gwt.dev.jjs.ast.JNode

getSourceInfo, setSourceInfo, toSource, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.google.gwt.dev.jjs.ast.CanBeAbstract

isAbstract

Methods inherited from interface com.google.gwt.dev.jjs.ast.CanBeFinal

isFinal

Methods inherited from interface com.google.gwt.dev.jjs.ast.JVisitable

traverse

Field Detail

jsPrototype

protected final String jsPrototype

jsInteropType

protected final JDeclaredType.JsInteropType jsInteropType

fields

protected transient List<JField> fields

This type's fields. Special serialization treatment.

methods

protected transient List<JMethod> methods

This type's methods. Special serialization treatment.

Constructor Detail

JDeclaredType

public JDeclaredType(SourceInfo info,
             String name,
             JDeclaredType.JsInteropType interopType,
             String jsPrototype)

JDeclaredType

public JDeclaredType(SourceInfo info,
             String name,
             JDeclaredType.JsInteropType interopType)

Method Detail

addField

public void addField(JField field)

Adds a field to this type.

addImplements

public void addImplements(JInterfaceType superInterface)

Adds an implemented interface to this type.

addMethod

public final void addMethod(JMethod method)

Adds a method to this type.

checkClinitTo

public boolean checkClinitTo(JDeclaredType targetType)

Returns true if a static field access of targetType from within this type should generate a clinit call. This will be true in cases where targetType has a live clinit method which we cannot statically know has already run. We can statically know the clinit method has already run when:

1. this == targetType
2. this is a subclass of targetType, because my clinit would have already run this targetType's clinit; see JLS 12.4

findMethod

public JMethod findMethod(String methodSignature,
                 boolean recurse)

Returns the method with the given signature, if there is one.
Optionally can search up the super type chain.

findSubtype

public JDeclaredType findSubtype(Iterable<JDeclaredType> types)

Determines whether a subclass of this type is in the collection types.

Parameters:

types - a collections of types.

Returns:

the first subtype found in the collection if the collection types contains a subtype of this type; null otherwise.

getClinitMethod

public final JMethod getClinitMethod()

Returns the class initializer method. Can only be called after making sure the class has a class initializer method.

Returns:

The class initializer method.

getClinitTarget

public final JDeclaredType getClinitTarget()

Returns the class that must be initialized to use this class. May be a superclass, or null if this class has no static initializer.

getCompoundName

public String[] getCompoundName()

Description copied from class: JType

Returns the compound name.

The compound name of a class is an array that contains the simple names of all enclosing types followed by the simple name of this type (in outer to inner order).

A simple name is the name as it appears in the class declaration (e.g. Name in "class Name { .. }"), i.e. it is a name that does not include enclosing type names nor package.

Overrides:

getCompoundName in class JType

getEnclosingType

public JDeclaredType getEnclosingType()

Returns the type which encloses this type.

Returns:

The enclosing type. May be null.

getFields

public List<JField> getFields()

Returns this type's fields;does not include fields defined in a super type unless they are overridden by this type.

getImplements

public List<JInterfaceType> getImplements()

Returns this type's implemented interfaces. Returns an empty list if this type implements no interfaces.

getInitMethod

public final JMethod getInitMethod()

Returns the instance initializer ($init) method. Can only be called after making sure the class has an instance initializer method.

Returns:

The instance initializer method.

getJavahSignatureName

public String getJavahSignatureName()

Overrides:

getJavahSignatureName in class JReferenceType

getJsniSignatureName

public String getJsniSignatureName()

Overrides:

getJsniSignatureName in class JReferenceType

getMethods

public final List<JMethod> getMethods()

Returns this type's declared methods; does not include methods defined in a super type unless they are overridden by this type.

isJsType

public boolean isJsType()

getJsInteropType

public JDeclaredType.JsInteropType getJsInteropType()

getJsPrototype

public String getJsPrototype()

getSuperClass

public abstract JClassType getSuperClass()

Returns this type's super class, or null if this type is Object or an interface.

hasClinit

public boolean hasClinit()

Returns true when this class's clinit must be run dynamically.

isExternal

public boolean isExternal()

Description copied from class: JType

True if this class is provided externally to the program by the program's host execution environment. For example, while compiling for the JVM, JRE types are external types. External types definitions are provided by class files which are considered opaque by the GWT compiler. TODO(scottb): Means something totally different after AST stiching is done.

Overrides:

isExternal in class JType

isInstantiable

public boolean isInstantiable()

Returns whether this type can be instantiated.

removeField

public void removeField(int i)

Removes the field at the specified index.

removeMethod

public void removeMethod(int i)

Removes the method at the specified index.

resolve

public void resolve(List<JInterfaceType> resolvedInterfaces,
           String jsNamespace)

Resolves external references during AST stitching.

setEnclosingType

public void setEnclosingType(JDeclaredType enclosingType)

Sets the type which encloses this types.

Parameters:

enclosingType - May be null.

setExternal

public void setExternal(boolean isExternal)

sortFields

public void sortFields(Comparator<? super JField> sort)

Sorts this type's fields according to the specified sort.

sortMethods

public void sortMethods(Comparator<? super JMethod> sort)

Sorts this type's methods according to the specified sort.

writeReplace

protected abstract Object writeReplace()

Subclasses must replace themselves with a shallow reference when isExternal() is true.

getQualifiedExportName

public String getQualifiedExportName()

getJsNamespace

public String getJsNamespace()

setJsNamespace

public void setJsNamespace(String jsNamespace)