polyglot.types

Interface MethodInstance

All Superinterfaces:

java.lang.Cloneable, CodeInstance, Copy<TypeObject>, Declaration, FunctionInstance, MemberInstance, ProcedureInstance, java.io.Serializable, TypeObject

All Known Subinterfaces:

AnnotationTypeElemInstance, JL5MethodInstance

All Known Implementing Classes:

AnnotationTypeElemInstance_c, CovarRetOutputExtensionInfo.CovarRetMethodInstance_c, JL5MethodInstance_c, MethodInstance_c

public interface MethodInstance
extends FunctionInstance, MemberInstance, Declaration

A MethodInstance represents the type information for a Java method.

Nested Class Summary

Nested classes/interfaces inherited from interface polyglot.util.Copy

Copy.Util

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canOverride(MethodInstance mi) Return true if this method can override mi, false otherwise.
boolean	canOverrideImpl(MethodInstance mi, boolean quiet) Return true if this method can override mi.
void	checkOverride(MethodInstance mi) Return true if this method can override mi, throws a SemanticException otherwise.
MethodInstance	container(ReferenceType container)
MethodInstance	flags(Flags flags) Non-destructive updates.
MethodInstance	formalTypes(java.util.List<? extends Type> l)
java.util.List<? extends MethodInstance>	implemented() Get the set of methods this method implements.
java.util.List<MethodInstance>	implementedImpl(ReferenceType rt) Get the set of methods in rt and its superinterfaces that this method implements.
boolean	isSameMethod(MethodInstance mi) Return true if this method has the same signature as mi.
boolean	isSameMethodImpl(MethodInstance mi) Return true if this method has the same signature as mi.
boolean	methodCallValid(java.lang.String name, java.util.List<? extends Type> actualTypes) Return true if this method can be called with name name and actual parameters of types actualTypes.
boolean	methodCallValidImpl(java.lang.String name, java.util.List<? extends Type> actualTypes) Return true if this method can be called with name name and actual parameters of types actualTypes.
java.lang.String	name() The method's name.
MethodInstance	name(java.lang.String name)
MethodInstance	orig()
java.util.List<MethodInstance>	overrides() Get the list of methods this method (potentially) overrides, in order from this class (i.e., including this) to super classes.
java.util.List<MethodInstance>	overridesImpl() Get the list of methods this method (potentially) overrides, in order from this class (i.e., including this) to super classes.
MethodInstance	returnType(Type returnType)
void	setName(java.lang.String name) Destructively set the method's name.
MethodInstance	throwTypes(java.util.List<? extends Type> l)

Methods inherited from interface polyglot.types.FunctionInstance

returnType, setReturnType

Methods inherited from interface polyglot.types.ProcedureInstance

callValid, callValidImpl, designator, formalTypes, hasFormals, hasFormalsImpl, moreSpecific, moreSpecificImpl, setFormalTypes, setThrowTypes, signature, throwsSubset, throwsSubsetImpl, throwTypes

Methods inherited from interface polyglot.types.CodeInstance

flags

Methods inherited from interface polyglot.types.TypeObject

equalsImpl, isCanonical, position, typeSystem

Methods inherited from interface polyglot.util.Copy

copy

Methods inherited from interface polyglot.types.MemberInstance

container, flags, setContainer, setFlags

Methods inherited from interface polyglot.types.Declaration

declaration, setDeclaration

Method Detail

name

java.lang.String name()

The method's name.

setName

void setName(java.lang.String name)

Destructively set the method's name.

Parameters:

name - the name to set

flags

MethodInstance flags(Flags flags)

Non-destructive updates.

name

MethodInstance name(java.lang.String name)

returnType

MethodInstance returnType(Type returnType)

formalTypes

MethodInstance formalTypes(java.util.List<? extends Type> l)

throwTypes

MethodInstance throwTypes(java.util.List<? extends Type> l)

container

MethodInstance container(ReferenceType container)

orig

MethodInstance orig()

overrides

java.util.List<MethodInstance> overrides()

Get the list of methods this method (potentially) overrides, in order from this class (i.e., including this) to super classes.

Returns:

A list of MethodInstance, starting with this. Note that this list does not include methods declared in interfaces. Use implemented for that.

See Also:

MethodInstance

canOverride

boolean canOverride(MethodInstance mi)

Return true if this method can override mi, false otherwise.

checkOverride

void checkOverride(MethodInstance mi)
                   throws SemanticException

Return true if this method can override mi, throws a SemanticException otherwise.

Throws:

SemanticException

implemented

java.util.List<? extends MethodInstance> implemented()

Get the set of methods this method implements. No ordering is specified since the superinterfaces need not form a linear list (i.e., they can form a tree).

Returns:

List[MethodInstance]

isSameMethod

boolean isSameMethod(MethodInstance mi)

Return true if this method has the same signature as mi.

methodCallValid

boolean methodCallValid(java.lang.String name,
                      java.util.List<? extends Type> actualTypes)

Return true if this method can be called with name name and actual parameters of types actualTypes.

Parameters:

name - The method to call.

actualTypes - A list of argument types of type Type.

See Also:

Type

overridesImpl

java.util.List<MethodInstance> overridesImpl()

Get the list of methods this method (potentially) overrides, in order from this class (i.e., including this) to super classes. This method should not be called except by TypeSystem and by subclasses.

Returns:

A list of MethodInstance, starting with this.

See Also:

MethodInstance

canOverrideImpl

boolean canOverrideImpl(MethodInstance mi,
                      boolean quiet)
                        throws SemanticException

Return true if this method can override mi. This method should not be called except by TypeSystem and by subclasses. If quiet is true and this method cannot override mi, then false is returned; otherwise, if quiet is false and this method cannot override mi, then a SemanticException is thrown.

Parameters:

quiet - If true, then no Semantic Exceptions will be thrown, and the return value will be true or false. Otherwise, if the method cannot override, then a SemanticException will be thrown, else the method will return true.

Throws:

SemanticException

implementedImpl

java.util.List<MethodInstance> implementedImpl(ReferenceType rt)

Get the set of methods in rt and its superinterfaces that this method implements. No ordering is specified.

Parameters:

rt - The point in the type hierarchy to begin looking for methods.

Returns:

List[MethodInstance]

isSameMethodImpl

boolean isSameMethodImpl(MethodInstance mi)

Return true if this method has the same signature as mi. This method should not be called except by TypeSystem and by subclasses.

methodCallValidImpl

boolean methodCallValidImpl(java.lang.String name,
                          java.util.List<? extends Type> actualTypes)

Return true if this method can be called with name name and actual parameters of types actualTypes. This method should not be called except by TypeSystem and by subclasses.