OpenJDK 27 · com.sun.tools.jdi.MethodImpl · APIdia, the JavaDoc alternative

Modifier and Type	Class and Description
pack-priv class	MethodImpl.ArgumentContainer
pack-priv class	MethodImpl.ReturnContainer

Modifier and Type	Field and Description
pack-priv MethodImpl.ReturnContainer	retValContainer
private JNITypeParser	signatureParser

Access	Constructor and Description
pack-priv	MethodImpl(VirtualMachine vm, ReferenceTypeImpl declaringType, long ref, String name, String signature, String genericSignature, int modifiers)

Method Summary

Modifier and Type	Method and Description
pack-priv abstract List<Location>	allLineLocations(SDE.Stratum stratum, String sourceName)
public final List<Location>	allLineLocations() Implements com.sun.jdi.Method.allLineLocations. Returns a list containing a `Location` object for each executable source line in this method.
public List<Location>	allLineLocations(String stratumID, String sourceName) Implements com.sun.jdi.Method.allLineLocations. Returns a list containing a `Location` object for each executable source line in this method.
pack-priv abstract int	argSlotCount()
public List<String>	argumentSignatures()
pack-priv Type	argumentType(int index)
public List<String>	argumentTypeNames() Implements com.sun.jdi.Method.argumentTypeNames. Returns a list containing a text representation of the type of each formal parameter of this method.
public List<Type>	argumentTypes() Implements com.sun.jdi.Method.argumentTypes. Returns a list containing the type of each formal parameter of this method.
pack-priv LineInfo	codeIndexToLineInfo(SDE.Stratum stratum, long codeIndex)
public int	compareTo(Method method) Implements java.lang.Comparable.compareTo. Compares this object with the specified object for order.
pack-priv static MethodImpl	createMethodImpl(VirtualMachine vm, ReferenceTypeImpl declaringType, long ref, String name, String signature, String genericSignature, int modifiers)
public boolean	equals(Object obj) Overrides com.sun.tools.jdi.MirrorImpl.equals. Implements com.sun.jdi.Method.equals. Compares the specified Object with this method for equality.
public Type	findType(String signature)
pack-priv MethodImpl.ReturnContainer	getReturnValueContainer()
pack-priv void	handleVarArgs(List<Value> arguments)
public int	hashCode() Overrides com.sun.tools.jdi.MirrorImpl.hashCode. Implements com.sun.jdi.Method.hashCode. Returns the hash code value for this Method.
public boolean	isAbstract() Implements com.sun.jdi.Method.isAbstract. Determine if this method is abstract.
public boolean	isBridge() Implements com.sun.jdi.Method.isBridge. Determine if this method is a bridge method.
public boolean	isConstructor() Implements com.sun.jdi.Method.isConstructor. Determine if this method is a constructor.
public boolean	isDefault() Overrides default com.sun.jdi.Method.isDefault. Determine if this method is a default method
public boolean	isNative() Implements com.sun.jdi.Method.isNative. Determine if this method is native.
public boolean	isObsolete() Implements com.sun.jdi.Method.isObsolete. Determine if this method is obsolete.
public boolean	isStaticInitializer() Implements com.sun.jdi.Method.isStaticInitializer. Determine if this method is a static initializer.
public boolean	isSynchronized() Implements com.sun.jdi.Method.isSynchronized. Determine if this method is synchronized.
public boolean	isVarArgs() Implements com.sun.jdi.Method.isVarArgs. Determine if this method accepts a variable number of arguments.
pack-priv abstract List<Location>	locationsOfLine(SDE.Stratum stratum, String sourceName, int lineNumber)
public final List<Location>	locationsOfLine(int lineNumber) Implements com.sun.jdi.Method.locationsOfLine. Returns a List containing all `Location` objects that map to the given line number.
public List<Location>	locationsOfLine(String stratumID, String sourceName, int lineNumber) Implements com.sun.jdi.Method.locationsOfLine. Returns a List containing all `Location` objects that map to the given line number and source name.
private String	returnSignature()
public Type	returnType() Implements com.sun.jdi.Method.returnType. Returns the return type, as specified in the declaration of this method.
public String	Returns: a text representation of the declared return type of this method. returnTypeName() Implements com.sun.jdi.Method.returnTypeName. Returns a text representation of the return type, as specified in the declaration of this method.
public String	toString() Overrides java.lang.Object.toString. Implements com.sun.jdi.Mirror.toString. Returns a String describing this mirror
pack-priv List<Value>	validateAndPrepareArgumentsForInvoke(List<? extends Value> origArguments)

Inherited from com.sun.tools.jdi.TypeComponentImpl:: declaringType genericSignature isFinal isModifierSet isPackagePrivate isPrivate isProtected isPublic isStatic isSynthetic modifiers name ref signature

retValContainer	back to summary
pack-priv MethodImpl.ReturnContainer retValContainer

signatureParser	back to summary
private JNITypeParser signatureParser

MethodImpl	back to summary
pack-priv MethodImpl(VirtualMachine vm, ReferenceTypeImpl declaringType, long ref, String name, String signature, String genericSignature, int modifiers)

Method Detail

allLineLocations	back to summary
pack-priv abstract List<Location> allLineLocations(SDE.Stratum stratum, String sourceName) throws AbsentInformationException

allLineLocations back to summary

allLineLocations	back to summary
public final List<Location> allLineLocations() throws AbsentInformationException Implements com.sun.jdi.Method.allLineLocations. Doc from com.sun.jdi.Method.allLineLocations. Returns a list containing a `Location` object for each executable source line in this method. This method is equivalent to `allLineLocations(vm.getDefaultStratum(),null)` - see `allLineLocations(String, String)` for more information. Exceptions AbsentInformationException: if there is no line number information for this (non-native, non-abstract) method.

public final List<Location> allLineLocations() throws AbsentInformationException

Implements com.sun.jdi.Method.allLineLocations.

Doc from com.sun.jdi.Method.allLineLocations.

Returns a list containing a Location object for each executable source line in this method.

This method is equivalent to allLineLocations(vm.getDefaultStratum(),null) - see allLineLocations(String, String) for more information.

Exceptions

AbsentInformationException:: if there is no line number information for this (non-native, non-abstract) method.

allLineLocations back to summary

allLineLocations	back to summary
public List<Location> allLineLocations(String stratumID, String sourceName) throws AbsentInformationException Implements com.sun.jdi.Method.allLineLocations. Doc from com.sun.jdi.Method.allLineLocations. Returns a list containing a `Location` object for each executable source line in this method. Each location maps a source line to a range of code indices. The beginning of the range can be determined through `Location#codeIndex`. The returned list is ordered by code index (from low to high). The returned list may contain multiple locations for a particular line number, if the compiler and/or VM has mapped that line to two or more disjoint code index ranges. If the method is native or abstract, an empty list is returned. Returned list is for the specified stratum (see `Location` for a description of strata). Exceptions AbsentInformationException: if there is no line number information for this (non-native, non-abstract) method. Or if sourceName is non-`null` and source name information is not present.

public List<Location> allLineLocations(String stratumID, String sourceName) throws AbsentInformationException

Implements com.sun.jdi.Method.allLineLocations.

Doc from com.sun.jdi.Method.allLineLocations.

Returns a list containing a Location object for each executable source line in this method.

Each location maps a source line to a range of code indices. The beginning of the range can be determined through Location#codeIndex. The returned list is ordered by code index (from low to high).

The returned list may contain multiple locations for a particular line number, if the compiler and/or VM has mapped that line to two or more disjoint code index ranges.

If the method is native or abstract, an empty list is returned.

Returned list is for the specified stratum (see Location for a description of strata).

Exceptions

AbsentInformationException:: if there is no line number information for this (non-native, non-abstract) method. Or if sourceName is non-null and source name information is not present.

argSlotCount	back to summary
pack-priv abstract int argSlotCount() throws AbsentInformationException

argumentSignatures	back to summary
public List<String> argumentSignatures()

argumentType	back to summary
pack-priv Type argumentType(int index) throws ClassNotLoadedException

argumentTypeNames	back to summary
public List<String> argumentTypeNames() Implements com.sun.jdi.Method.argumentTypeNames. Doc from com.sun.jdi.Method.argumentTypeNames. Returns a list containing a text representation of the type of each formal parameter of this method. This list is always available even if the types have not yet been created or loaded.

argumentTypeNames

back to summary

public List<String> argumentTypeNames()

Implements com.sun.jdi.Method.argumentTypeNames.

Doc from com.sun.jdi.Method.argumentTypeNames.

Returns a list containing a text representation of the type of each formal parameter of this method.

This list is always available even if the types have not yet been created or loaded.

argumentTypes back to summary

argumentTypes	back to summary
public List<Type> argumentTypes() throws ClassNotLoadedException Implements com.sun.jdi.Method.argumentTypes. Doc from com.sun.jdi.Method.argumentTypes. Returns a list containing the type of each formal parameter of this method. Note if there is any parameter whose type is a reference type (class, interface, or array) and it has not been created or loaded by the declaring type's class loader - that is, `declaringType()` `.classLoader()`, then ClassNotLoadedException will be thrown. Also, a reference type may have been loaded but not yet prepared, in which case the list will be returned but attempts to perform some operations on the type (e.g. `fields()`) will throw a `ClassNotPreparedException`. Use `ReferenceType#isPrepared()` to determine if a reference type is prepared. Exceptions ClassNotLoadedException: if the type has not yet been loaded through the appropriate class loader.

public List<Type> argumentTypes() throws ClassNotLoadedException

Implements com.sun.jdi.Method.argumentTypes.

Doc from com.sun.jdi.Method.argumentTypes.

Returns a list containing the type of each formal parameter of this method.

Note

if there is any parameter whose type is a reference type (class, interface, or array) and it has not been created or loaded by the declaring type's class loader - that is, declaringType() .classLoader(), then ClassNotLoadedException will be thrown. Also, a reference type may have been loaded but not yet prepared, in which case the list will be returned but attempts to perform some operations on the type (e.g. fields()) will throw a ClassNotPreparedException. Use ReferenceType#isPrepared() to determine if a reference type is prepared.

Exceptions

ClassNotLoadedException:: if the type has not yet been loaded through the appropriate class loader.

codeIndexToLineInfo	back to summary
pack-priv LineInfo codeIndexToLineInfo(SDE.Stratum stratum, long codeIndex)

compareTo back to summary

compareTo	back to summary
public int compareTo(Method method) Implements java.lang.Comparable.compareTo. Doc from java.lang.Comparable.compareTo. Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object. The implementor must ensure `signum(x.compareTo(y)) == -signum(y.compareTo(x))` for all `x` and `y`. (This implies that `x.compareTo(y)` must throw an exception if and only if `y.compareTo(x)` throws an exception.) The implementor must also ensure that the relation is transitive: `(x.compareTo(y) > 0 && y.compareTo(z) > 0)` implies `x.compareTo(z) > 0`. Finally, the implementor must ensure that `x.compareTo(y)==0` implies that `signum(x.compareTo(z)) == signum(y.compareTo(z))`, for all `z`.

public int compareTo(Method method)

Implements java.lang.Comparable.compareTo.

Doc from java.lang.Comparable.compareTo.

Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

The implementor must ensure signum(x.compareTo(y)) == -signum(y.compareTo(x)) for all x and y. (This implies that x.compareTo(y) must throw an exception if and only if y.compareTo(x) throws an exception.)

The implementor must also ensure that the relation is transitive: (x.compareTo(y) > 0 && y.compareTo(z) > 0) implies x.compareTo(z) > 0.

Finally, the implementor must ensure that x.compareTo(y)==0 implies that signum(x.compareTo(z)) == signum(y.compareTo(z)), for all z.

createMethodImpl	back to summary
pack-priv static MethodImpl createMethodImpl(VirtualMachine vm, ReferenceTypeImpl declaringType, long ref, String name, String signature, String genericSignature, int modifiers)

equals	back to summary
public boolean equals(Object obj) Overrides com.sun.tools.jdi.MirrorImpl.equals. Implements com.sun.jdi.Method.equals. Doc from com.sun.jdi.Method.equals. Compares the specified Object with this method for equality.

equals

back to summary

public boolean equals(Object obj)

Overrides com.sun.tools.jdi.MirrorImpl.equals.

Implements com.sun.jdi.Method.equals.

Doc from com.sun.jdi.Method.equals.

Compares the specified Object with this method for equality.

findType	back to summary
public Type findType(String signature) throws ClassNotLoadedException

getReturnValueContainer	back to summary
pack-priv MethodImpl.ReturnContainer getReturnValueContainer()

handleVarArgs	back to summary
pack-priv void handleVarArgs(List<Value> arguments) throws ClassNotLoadedException, InvalidTypeException

hashCode	back to summary
public int hashCode() Overrides com.sun.tools.jdi.MirrorImpl.hashCode. Implements com.sun.jdi.Method.hashCode. Doc from com.sun.jdi.Method.hashCode. Returns the hash code value for this Method. Annotations @Override

hashCode

back to summary

public int hashCode()

Overrides com.sun.tools.jdi.MirrorImpl.hashCode.

Implements com.sun.jdi.Method.hashCode.

Doc from com.sun.jdi.Method.hashCode.

Returns the hash code value for this Method.

Annotations

@Override

isAbstract	back to summary
public boolean isAbstract() Implements com.sun.jdi.Method.isAbstract. Doc from com.sun.jdi.Method.isAbstract. Determine if this method is abstract.

isAbstract

back to summary

public boolean isAbstract()

Implements com.sun.jdi.Method.isAbstract.

Doc from com.sun.jdi.Method.isAbstract.

Determine if this method is abstract.

isBridge	back to summary
public boolean isBridge() Implements com.sun.jdi.Method.isBridge. Doc from com.sun.jdi.Method.isBridge. Determine if this method is a bridge method. Bridge methods are defined in The Java Language Specification.

isBridge

back to summary

public boolean isBridge()

Implements com.sun.jdi.Method.isBridge.

Doc from com.sun.jdi.Method.isBridge.

Determine if this method is a bridge method. Bridge methods are defined in The Java Language Specification.

isConstructor	back to summary
public boolean isConstructor() Implements com.sun.jdi.Method.isConstructor. Doc from com.sun.jdi.Method.isConstructor. Determine if this method is a constructor.

isConstructor

back to summary

public boolean isConstructor()

Implements com.sun.jdi.Method.isConstructor.

Doc from com.sun.jdi.Method.isConstructor.

Determine if this method is a constructor.

isDefault	back to summary
public boolean isDefault() Overrides default com.sun.jdi.Method.isDefault. Doc from com.sun.jdi.Method.isDefault. Determine if this method is a default method

isDefault

back to summary

public boolean isDefault()

Overrides default com.sun.jdi.Method.isDefault.

Doc from com.sun.jdi.Method.isDefault.

Determine if this method is a default method

isNative	back to summary
public boolean isNative() Implements com.sun.jdi.Method.isNative. Doc from com.sun.jdi.Method.isNative. Determine if this method is native.

isNative

back to summary

public boolean isNative()

Implements com.sun.jdi.Method.isNative.

Doc from com.sun.jdi.Method.isNative.

Determine if this method is native.

isObsolete	back to summary
public boolean isObsolete() Implements com.sun.jdi.Method.isObsolete. Doc from com.sun.jdi.Method.isObsolete. Determine if this method is obsolete.

isObsolete

back to summary

public boolean isObsolete()

Implements com.sun.jdi.Method.isObsolete.

Doc from com.sun.jdi.Method.isObsolete.

Determine if this method is obsolete.

isStaticInitializer	back to summary
public boolean isStaticInitializer() Implements com.sun.jdi.Method.isStaticInitializer. Doc from com.sun.jdi.Method.isStaticInitializer. Determine if this method is a static initializer.

isStaticInitializer

back to summary

public boolean isStaticInitializer()

Implements com.sun.jdi.Method.isStaticInitializer.

Doc from com.sun.jdi.Method.isStaticInitializer.

Determine if this method is a static initializer.

isSynchronized	back to summary
public boolean isSynchronized() Implements com.sun.jdi.Method.isSynchronized. Doc from com.sun.jdi.Method.isSynchronized. Determine if this method is synchronized.

isSynchronized

back to summary

public boolean isSynchronized()

Implements com.sun.jdi.Method.isSynchronized.

Doc from com.sun.jdi.Method.isSynchronized.

Determine if this method is synchronized.

isVarArgs	back to summary
public boolean isVarArgs() Implements com.sun.jdi.Method.isVarArgs. Doc from com.sun.jdi.Method.isVarArgs. Determine if this method accepts a variable number of arguments.

isVarArgs

back to summary

public boolean isVarArgs()

Implements com.sun.jdi.Method.isVarArgs.

Doc from com.sun.jdi.Method.isVarArgs.

Determine if this method accepts a variable number of arguments.

locationsOfLine	back to summary
pack-priv abstract List<Location> locationsOfLine(SDE.Stratum stratum, String sourceName, int lineNumber) throws AbsentInformationException

locationsOfLine back to summary

locationsOfLine	back to summary
public final List<Location> locationsOfLine(int lineNumber) throws AbsentInformationException Implements com.sun.jdi.Method.locationsOfLine. Doc from com.sun.jdi.Method.locationsOfLine. Returns a List containing all `Location` objects that map to the given line number. This method is equivalent to `locationsOfLine(vm.getDefaultStratum(), null, lineNumber)` - see `locationsOfLine(java.lang.String, java.lang.String, int)` for more information. Exceptions AbsentInformationException: if there is no line number information for this method.

public final List<Location> locationsOfLine(int lineNumber) throws AbsentInformationException

Implements com.sun.jdi.Method.locationsOfLine.

Doc from com.sun.jdi.Method.locationsOfLine.

Returns a List containing all Location objects that map to the given line number.

This method is equivalent to locationsOfLine(vm.getDefaultStratum(), null, lineNumber) - see locationsOfLine(java.lang.String, java.lang.String, int) for more information.

Exceptions

AbsentInformationException:: if there is no line number information for this method.

locationsOfLine back to summary

locationsOfLine	back to summary
public List<Location> locationsOfLine(String stratumID, String sourceName, int lineNumber) throws AbsentInformationException Implements com.sun.jdi.Method.locationsOfLine. Doc from com.sun.jdi.Method.locationsOfLine. Returns a List containing all `Location` objects that map to the given line number and source name. Returns a list containing each `Location` that maps to the given line. The returned list will contain a location for each disjoint range of code indices that have been assigned to the given line by the compiler and/or VM. Each returned location corresponds to the beginning of this range. An empty list will be returned if there is no executable code at the specified line number; specifically, native and abstract methods will always return an empty list. Returned list is for the specified stratum (see `Location` for a description of strata). Exceptions AbsentInformationException: if there is no line number information for this method. Or if sourceName is non-`null` and source name information is not present.

public List<Location> locationsOfLine(String stratumID, String sourceName, int lineNumber) throws AbsentInformationException

Implements com.sun.jdi.Method.locationsOfLine.

Doc from com.sun.jdi.Method.locationsOfLine.

Returns a List containing all Location objects that map to the given line number and source name.

Returns a list containing each Location that maps to the given line. The returned list will contain a location for each disjoint range of code indices that have been assigned to the given line by the compiler and/or VM. Each returned location corresponds to the beginning of this range. An empty list will be returned if there is no executable code at the specified line number; specifically, native and abstract methods will always return an empty list.

Returned list is for the specified stratum (see Location for a description of strata).

Exceptions

AbsentInformationException:: if there is no line number information for this method. Or if sourceName is non-null and source name information is not present.

returnSignature	back to summary
private String returnSignature()

returnType back to summary

returnType	back to summary
public Type returnType() throws ClassNotLoadedException Implements com.sun.jdi.Method.returnType. Doc from com.sun.jdi.Method.returnType. Returns the return type, as specified in the declaration of this method. Note if the return type of this method is a reference type (class, interface, or array) and it has not been created or loaded by the declaring type's class loader - that is, `declaringType()` `.classLoader()`, then ClassNotLoadedException will be thrown. Also, a reference type may have been loaded but not yet prepared, in which case the type will be returned but attempts to perform some operations on the returned type (e.g. `fields()`) will throw a `ClassNotPreparedException`. Use `ReferenceType#isPrepared()` to determine if a reference type is prepared. Exceptions ClassNotLoadedException: if the type has not yet been created or loaded through the appropriate class loader.

public Type returnType() throws ClassNotLoadedException

Implements com.sun.jdi.Method.returnType.

Doc from com.sun.jdi.Method.returnType.

Returns the return type, as specified in the declaration of this method.

Note

if the return type of this method is a reference type (class, interface, or array) and it has not been created or loaded by the declaring type's class loader - that is, declaringType() .classLoader(), then ClassNotLoadedException will be thrown. Also, a reference type may have been loaded but not yet prepared, in which case the type will be returned but attempts to perform some operations on the returned type (e.g. fields()) will throw a ClassNotPreparedException. Use ReferenceType#isPrepared() to determine if a reference type is prepared.

Exceptions

ClassNotLoadedException:: if the type has not yet been created or loaded through the appropriate class loader.

returnTypeName	back to summary
public String returnTypeName() Implements com.sun.jdi.Method.returnTypeName. Doc from com.sun.jdi.Method.returnTypeName. Returns a text representation of the return type, as specified in the declaration of this method. This type name is always available even if the type has not yet been created or loaded. Returns:String a text representation of the declared return type of this method.

returnTypeName

back to summary

public String returnTypeName()

Implements com.sun.jdi.Method.returnTypeName.

Doc from com.sun.jdi.Method.returnTypeName.

Returns a text representation of the return type, as specified in the declaration of this method.

This type name is always available even if the type has not yet been created or loaded.

Returns:String: a text representation of the declared return type of this method.

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Implements com.sun.jdi.Mirror.toString. Doc from com.sun.jdi.Mirror.toString. Returns a String describing this mirror

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Implements com.sun.jdi.Mirror.toString.

Doc from com.sun.jdi.Mirror.toString.

Returns a String describing this mirror

validateAndPrepareArgumentsForInvoke	back to summary
pack-priv List<Value> validateAndPrepareArgumentsForInvoke(List<? extends Value> origArguments) throws ClassNotLoadedException, InvalidTypeException

public abstract Class MethodImpl

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv Class MethodImpl.ArgumentContainer

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv Class MethodImpl.ReturnContainer

Constructor Summary

Method Summary

Constructor Detail

Method Detail

Modifier and Type	Method and Description
public Type	findType(String signature) Implements com.sun.tools.jdi.ValueContainer.findType.
public String	signature() Implements com.sun.tools.jdi.ValueContainer.signature.
public Type	type() Implements com.sun.tools.jdi.ValueContainer.type.
public String	typeName() Implements com.sun.tools.jdi.ValueContainer.typeName.