com.google.gwt.dev.jjs.ast

Class JMethod

java.lang.Object

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

com.google.gwt.dev.jjs.ast.JMethod

All Implemented Interfaces:

CanBeAbstract, CanBeFinal, CanBeJsNative, CanBeSetFinal, CanBeStatic, CanHaveSuppressedWarnings, HasEnclosingType, HasJsInfo, HasJsName, HasName, HasType, JMember, HasSourceInfo, Serializable

Direct Known Subclasses:

JConstructor

public class JMethod
extends JNode
implements JMember, CanBeAbstract

A Java method implementation.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JMethod.Specialization AST representation of @SpecializeMethod.

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

HasName.Util

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

HasJsInfo.JsMemberType

Field Summary

Fields

Modifier and Type	Field and Description
static Comparator<JMethod>	BY_SIGNATURE_COMPARATOR
static JMethod	NULL_METHOD
protected String	signature

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

BY_NAME_COMPARATOR

Constructor Summary

Constructors

Constructor and Description
JMethod(SourceInfo info, String name, JDeclaredType enclosingType, JType returnType, boolean isAbstract, boolean isStatic, boolean isFinal, AccessModifier access) These are only supposed to be constructed by JProgram.

Method Summary

Modifier and Type	Method and Description
void	addOverriddenMethod(JMethod overriddenMethod) Add a method that this method overrides.
void	addOverridingMethod(JMethod overridingMethod) Add a method that overrides this method.
void	addThrownException(JClassType exceptionType)
void	addThrownExceptions(List<JClassType> exceptionTypes)
boolean	canBeImplementedExternally()
boolean	canBePolymorphic() Returns true if this method can participate in virtual dispatch.
boolean	canBeReferencedExternally()
JParameter	cloneParameter(JParameter from) Adds a new parameter to this method that is a copy of from.
JParameter	createFinalParameter(SourceInfo info, String name, JType type) Adds a new final parameter to this method.
JParameter	createParameter(SourceInfo info, String name, JType type) Adds a new parameter to this method.
JParameter	createParameter(SourceInfo info, String name, JType type, boolean isFinal, boolean isVarargs) Adds a new parameter to this method.
JParameter	createThisParameter(SourceInfo info, JType type) Creates a parameter to hold the value of this in devirtualized methods.
void	disallowDevirtualization()
boolean	exposesNonJsMember() Returns true if this method is the first JsMember in the method hierarchy that exposes an existing non-JsMember inside a class.
boolean	exposesPackagePrivateMethod() Returns true if this method is the first method in the method hierarchy that increases the visibility of a package private method.
void	freezeParamTypes()
AccessModifier	getAccess()
JAbstractMethodBody	getBody()
JDeclaredType	getEnclosingType()
static JMethod	getExternalizedMethod(String fullClassName, String signature, boolean isStatic) Creates an externalized representation for a method that needs to be resolved.
InliningMode	getInliningMode()
HasJsInfo.JsMemberType	getJsMemberType()
String	getJsName()
String	getJsNamespace()
String	getJsniSignature(boolean includeEnclosingClass, boolean includeReturnType)
String	getName()
List<JType>	getOriginalParamTypes()
JType	getOriginalReturnType()
Set<JMethod>	getOverriddenMethods() Returns the transitive closure of all the methods this method overrides; this set is ordered from most specific to least specific, where class methods appear before interface methods.
Set<JMethod>	getOverridingMethods() Returns the transitive closure of all the methods that override this method; caveat this list is only complete in monolithic compiles and should not be used in incremental compiles.
List<JParameter>	getParams() Returns the parameters of this method.
String	getQualifiedJsName()
String	getQualifiedName()
String	getSignature()
JMethod.Specialization	getSpecialization()
Set<String>	getSuppressedWarnings()
List<JClassType>	getThrownExceptions()
JType	getType() Returns the type of this expression.
boolean	hasSideEffects()
boolean	isAbstract()
boolean	isConstructor()
boolean	isDefaultMethod()
boolean	isDevirtualizationAllowed()
boolean	isExternal()
boolean	isFinal()
boolean	isForwarding()
boolean	isInliningAllowed()
boolean	isJsConstructor()
boolean	isJsInteropEntryPoint()
boolean	isJsMethodVarargs()
boolean	isJsNative()
boolean	isJsniMethod()
boolean	isJsOverlay()
boolean	isOrOverridesJsFunctionMethod()
boolean	isPackagePrivate()
boolean	isPrivate()
boolean	isPublic()
boolean	isStatic()
boolean	isSynthetic()
boolean	isSyntheticAccidentalOverride()
boolean	needsDynamicDispatch() Returns true if this method can participate in instance dispatch.
void	removeParam(int index) Removes the parameter at the specified index.
void	removeSpecialization()
void	resolve(JType originalReturnType, List<JType> originalParamTypes, JType returnType, List<JClassType> thrownExceptions) Resolve an external references during AST stitching.
void	setAbstract(boolean isAbstract)
void	setBody(JAbstractMethodBody body)
void	setDefaultMethod(boolean defaultMethod)
void	setFinal()
void	setFinal(boolean isFinal)
void	setForwarding()
void	setHasSideEffects(boolean hasSideEffects)
void	setInliningMode(InliningMode inliningMode)
void	setJsMemberInfo(HasJsInfo.JsMemberType type, String namespace, String name, boolean exported)
void	setJsOverlay()
void	setOriginalTypes(JType returnType, List<JType> paramTypes)
void	setSpecialization(List<JType> paramTypes, JType returnsType, String targetMethod)
void	setSuppressedWarnings(Set<String> suppressedWarnings)
void	setSynthetic()
void	setSyntheticAccidentalOverride()
void	setType(JType newType)
void	traverse(JVisitor visitor, Context ctx) Causes this object to have the visitor visit itself and its children.
protected void	visitChildren(JVisitor visitor)
protected Object	writeReplace()

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

getSourceInfo, setSourceInfo, toSource, toString

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode

Methods inherited from interface com.google.gwt.dev.jjs.HasSourceInfo

getSourceInfo

Field Detail

BY_SIGNATURE_COMPARATOR

public static final Comparator<JMethod> BY_SIGNATURE_COMPARATOR

NULL_METHOD

public static final JMethod NULL_METHOD

signature

protected transient String signature

Constructor Detail

JMethod

public JMethod(SourceInfo info,
               String name,
               JDeclaredType enclosingType,
               JType returnType,
               boolean isAbstract,
               boolean isStatic,
               boolean isFinal,
               AccessModifier access)

These are only supposed to be constructed by JProgram.

Method Detail

setJsMemberInfo

public void setJsMemberInfo(HasJsInfo.JsMemberType type,
                            String namespace,
                            String name,
                            boolean exported)

Specified by:

setJsMemberInfo in interface HasJsInfo

isJsInteropEntryPoint

public boolean isJsInteropEntryPoint()

Specified by:

isJsInteropEntryPoint in interface HasJsInfo

canBeReferencedExternally

public boolean canBeReferencedExternally()

Specified by:

canBeReferencedExternally in interface HasJsInfo

canBeImplementedExternally

public boolean canBeImplementedExternally()

Specified by:

canBeImplementedExternally in interface HasJsInfo

createFinalParameter

public JParameter createFinalParameter(SourceInfo info,
                                       String name,
                                       JType type)

Adds a new final parameter to this method.

createParameter

public JParameter createParameter(SourceInfo info,
                                  String name,
                                  JType type)

Adds a new parameter to this method.

createParameter

public JParameter createParameter(SourceInfo info,
                                  String name,
                                  JType type,
                                  boolean isFinal,
                                  boolean isVarargs)

Adds a new parameter to this method.

cloneParameter

public JParameter cloneParameter(JParameter from)

Adds a new parameter to this method that is a copy of from.

createThisParameter

public JParameter createThisParameter(SourceInfo info,
                                      JType type)

Creates a parameter to hold the value of this in devirtualized methods.

getJsNamespace

public String getJsNamespace()

Specified by:

getJsNamespace in interface HasJsName

getQualifiedJsName

public String getQualifiedJsName()

Specified by:

getQualifiedJsName in interface HasJsName

getJsName

public String getJsName()

Specified by:

getJsName in interface HasJsName

isJsConstructor

public boolean isJsConstructor()

exposesNonJsMember

public boolean exposesNonJsMember()

Returns true if this method is the first JsMember in the method hierarchy that exposes an existing non-JsMember inside a class.

getJsMemberType

public HasJsInfo.JsMemberType getJsMemberType()

Specified by:

getJsMemberType in interface HasJsInfo

isOrOverridesJsFunctionMethod

public boolean isOrOverridesJsFunctionMethod()

isJsNative

public boolean isJsNative()

Specified by:

isJsNative in interface CanBeJsNative

isJsOverlay

public boolean isJsOverlay()

Specified by:

isJsOverlay in interface HasJsInfo

setSyntheticAccidentalOverride

public void setSyntheticAccidentalOverride()

isSyntheticAccidentalOverride

public boolean isSyntheticAccidentalOverride()

setSpecialization

public void setSpecialization(List<JType> paramTypes,
                              JType returnsType,
                              String targetMethod)

getSpecialization

public JMethod.Specialization getSpecialization()

removeSpecialization

public void removeSpecialization()

isInliningAllowed

public boolean isInliningAllowed()

getInliningMode

public InliningMode getInliningMode()

setInliningMode

public void setInliningMode(InliningMode inliningMode)

hasSideEffects

public boolean hasSideEffects()

setHasSideEffects

public void setHasSideEffects(boolean hasSideEffects)

setDefaultMethod

public void setDefaultMethod(boolean defaultMethod)

setJsOverlay

public void setJsOverlay()

Specified by:

setJsOverlay in interface HasJsInfo

isDefaultMethod

public boolean isDefaultMethod()

isDevirtualizationAllowed

public boolean isDevirtualizationAllowed()

disallowDevirtualization

public void disallowDevirtualization()

isJsMethodVarargs

public boolean isJsMethodVarargs()

Specified by:

isJsMethodVarargs in interface HasJsInfo

getExternalizedMethod

public static JMethod getExternalizedMethod(String fullClassName,
                                            String signature,
                                            boolean isStatic)

Creates an externalized representation for a method that needs to be resolved. Useful to refer to methods of magic classes during GwtAstBuilder execution.

Parameters:

fullClassName - the class where the method is defined.

signature - the signature of the method (including its name).

addOverriddenMethod

public void addOverriddenMethod(JMethod overriddenMethod)

Add a method that this method overrides.

addOverridingMethod

public void addOverridingMethod(JMethod overridingMethod)

Add a method that overrides this method.

addThrownException

public void addThrownException(JClassType exceptionType)

addThrownExceptions

public void addThrownExceptions(List<JClassType> exceptionTypes)

canBePolymorphic

public boolean canBePolymorphic()

Returns true if this method can participate in virtual dispatch. Returns true for non-private instance methods; false for static methods, private instance methods, and constructors.

freezeParamTypes

public void freezeParamTypes()

exposesPackagePrivateMethod

public boolean exposesPackagePrivateMethod()

Returns true if this method is the first method in the method hierarchy that increases the visibility of a package private method.

getAccess

public AccessModifier getAccess()

getBody

public JAbstractMethodBody getBody()

getEnclosingType

public JDeclaredType getEnclosingType()

Specified by:

getEnclosingType in interface HasEnclosingType

getName

public String getName()

Specified by:

getName in interface HasName

getQualifiedName

public String getQualifiedName()

Specified by:

getQualifiedName in interface JMember

getOriginalParamTypes

public List<JType> getOriginalParamTypes()

getOriginalReturnType

public JType getOriginalReturnType()

getOverriddenMethods

public Set<JMethod> getOverriddenMethods()

Returns the transitive closure of all the methods this method overrides; this set is ordered from most specific to least specific, where class methods appear before interface methods.

getOverridingMethods

public Set<JMethod> getOverridingMethods()

Returns the transitive closure of all the methods that override this method; caveat this list is only complete in monolithic compiles and should not be used in incremental compiles. The returned set is ordered in such a way that most specific overriding methods appear after less specific ones.

getParams

public List<JParameter> getParams()

Returns the parameters of this method.

getSignature

public String getSignature()

getJsniSignature

public String getJsniSignature(boolean includeEnclosingClass,
                               boolean includeReturnType)

getThrownExceptions

public List<JClassType> getThrownExceptions()

getType

public JType getType()

Description copied from interface: HasType

Returns the type of this expression.

Specified by:

getType in interface HasType

isAbstract

public boolean isAbstract()

Specified by:

isAbstract in interface CanBeAbstract

isConstructor

public boolean isConstructor()

isPackagePrivate

public boolean isPackagePrivate()

isExternal

public boolean isExternal()

Specified by:

isExternal in interface JMember

isFinal

public boolean isFinal()

Specified by:

isFinal in interface CanBeFinal

isForwarding

public boolean isForwarding()

isJsniMethod

public boolean isJsniMethod()

isPrivate

public boolean isPrivate()

Specified by:

isPrivate in interface JMember

isPublic

public boolean isPublic()

Specified by:

isPublic in interface JMember

isStatic

public boolean isStatic()

Specified by:

isStatic in interface CanBeStatic

isSynthetic

public boolean isSynthetic()

Specified by:

isSynthetic in interface JMember

needsDynamicDispatch

public boolean needsDynamicDispatch()

Returns true if this method can participate in instance dispatch.

Specified by:

needsDynamicDispatch in interface JMember

removeParam

public void removeParam(int index)

Removes the parameter at the specified index.

resolve

public void resolve(JType originalReturnType,
                    List<JType> originalParamTypes,
                    JType returnType,
                    List<JClassType> thrownExceptions)

Resolve an external references during AST stitching.

setAbstract

public void setAbstract(boolean isAbstract)

setBody

public void setBody(JAbstractMethodBody body)

setFinal

public void setFinal()

Specified by:

setFinal in interface CanBeSetFinal

setFinal

public void setFinal(boolean isFinal)

setForwarding

public void setForwarding()

setOriginalTypes

public void setOriginalTypes(JType returnType,
                             List<JType> paramTypes)

setSynthetic

public void setSynthetic()

setType

public void setType(JType newType)

getSuppressedWarnings

public Set<String> getSuppressedWarnings()

Specified by:

getSuppressedWarnings in interface CanHaveSuppressedWarnings

setSuppressedWarnings

public void setSuppressedWarnings(Set<String> suppressedWarnings)

Specified by:

setSuppressedWarnings in interface CanHaveSuppressedWarnings

traverse

public void traverse(JVisitor visitor,
                     Context ctx)

Description copied from class: JNode

Causes this object to have the visitor visit itself and its children.

Specified by:

traverse in class JNode

Parameters:

visitor - the visitor that should traverse this node

ctx - the context of an existing traversal

visitChildren

protected void visitChildren(JVisitor visitor)

writeReplace

protected Object writeReplace()