Accessible, Comparable<Method>, Locatable, Mirror, TypeComponent
public interface Method extends TypeComponent, Locatable, Comparable<Method>
TypeComponent for general information about Field and Method mirrors.| Modifier and Type | Method | Description |
|---|---|---|
List |
allLineLocations() |
Returns a list containing a Location object for each executable source line in this method. |
List |
allLineLocations |
Returns a list containing a Location object for each executable source line in this method. |
List |
arguments() |
Returns a list containing each LocalVariable that is declared as an argument of this method. |
List |
argumentTypeNames() |
Returns a list containing a text representation of the type of each formal parameter of this method. |
List |
argumentTypes() |
Returns a list containing the type of each formal parameter of this method. |
byte[] |
bytecodes() |
Returns an array containing the bytecodes for this method. |
boolean |
equals |
Compares the specified Object with this method for equality. |
int |
hashCode() |
Returns the hash code value for this Method. |
boolean |
isAbstract() |
Determine if this method is abstract. |
boolean |
isBridge() |
Determine if this method is a bridge method. |
boolean |
isConstructor() |
Determine if this method is a constructor. |
default boolean |
isDefault() |
Determine if this method is a default method |
boolean |
isNative() |
Determine if this method is native. |
boolean |
isObsolete() |
Determine if this method is obsolete. |
boolean |
isStaticInitializer() |
Determine if this method is a static initializer. |
boolean |
isSynchronized() |
Determine if this method is synchronized. |
boolean |
isVarArgs() |
Determine if this method accepts a variable number of arguments. |
Location |
location() |
Returns the Location of this method, if there is executable code associated with it. |
Location |
locationOfCodeIndex |
Returns a Location for the given code index. |
List |
locationsOfLine |
Returns a List containing all Location objects that map to the given line number. |
List |
locationsOfLine |
Returns a List containing all Location objects that map to the given line number and source name. |
Type |
returnType() |
Returns the return type, as specified in the declaration of this method. |
String |
returnTypeName() |
Returns a text representation of the return type, as specified in the declaration of this method. |
List |
variables() |
Returns a list containing each LocalVariable declared in this method. |
List |
variablesByName |
Returns a list containing each LocalVariable of a given name in this method. |
isPackagePrivate, isPrivate, isProtected, isPublic, modifiers
compareTo
toString, virtualMachine
declaringType, genericSignature, isFinal, isStatic, isSynthetic, name, signature
String returnTypeName()
This type name is always available even if the type has not yet been created or loaded.
String containing the return type name.Type returnType() throws ClassNotLoadedException
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.
Type of this method.ClassNotLoadedException - if the type has not yet been created or loaded through the appropriate class loader.List<String> argumentTypeNames()
This list is always available even if the types have not yet been created or loaded.
List<Type> argumentTypes() throws ClassNotLoadedException
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.
List of Type, one List element for each parameter of this method. Each element represents the type of a formal parameter as specified at compile-time. If the formal parameter was declared with an ellipsis, then it is represented as an array of the type before the ellipsis.ClassNotLoadedException - if the type has not yet been loaded through the appropriate class loader.boolean isAbstract()
true if the method is declared abstract; false otherwise.default boolean isDefault()
true if the method is declared default; false otherwise.boolean isSynchronized()
true if the method is declared synchronized; false otherwise.boolean isNative()
true if the method is declared native; false otherwise.boolean isVarArgs()
true if the method accepts a variable number of arguments, false otherwise.boolean isBridge()
true if the method is a bridge method, false otherwise.boolean isConstructor()
true if the method is a constructor; false otherwise.boolean isStaticInitializer()
true if the method is a static initializer; false otherwise.boolean isObsolete()
true if this method has been made obsolete by a VirtualMachine.redefineClasses(java.util.Map<? extends com.sun.jdi.ReferenceType, byte[]>) operation.List<Location> allLineLocations() throws AbsentInformationException
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.
Location objects.AbsentInformationException - if there is no line number information for this (non-native, non-abstract) method.List<Location> allLineLocations(String stratum, String sourceName) throws AbsentInformationException
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).
stratum - The stratum to retrieve information from or null for the ReferenceType.defaultStratum()
sourceName - Return locations only within this source file or null to return locations.Location objects.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.List<Location> locationsOfLine(int lineNumber) throws AbsentInformationException
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.
lineNumber - the line numberLocation objects that map to the given line number.AbsentInformationException - if there is no line number information for this method.List<Location> locationsOfLine(String stratum, String sourceName, int lineNumber) throws AbsentInformationException
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).
stratum - the stratum to use for comparing line number and source name, or null to use the default stratumsourceName - the source name containing the line number, or null to match all source nameslineNumber - the line numberLocation objects that map to the given line number.AbsentInformationException - if there is no line number information for this method. Or if sourceName is non-null and source name information is not present.Location locationOfCodeIndex(long codeIndex)
Location for the given code index.Location corresponding to the given code index or null if the specified code index is not a valid code index for this method (native and abstract methods will always return null).List<LocalVariable> variables() throws AbsentInformationException
LocalVariable declared in this method. The list includes any variable declared in any scope within the method. It may contain multiple variables of the same name declared within disjoint scopes. Arguments are considered local variables and will be present in the returned list. If local variable information is not available, values of actual arguments to method invocations can be obtained by using the method StackFrame.getArgumentValues()
LocalVariable objects which mirror local variables declared in this method in the target VM. If there are no local variables, a zero-length list is returned.AbsentInformationException - if there is no variable information for this method. Generally, local variable information is not available for native or abstract methods (that is, their argument name information is not available), thus they will throw this exception.List<LocalVariable> variablesByName(String name) throws AbsentInformationException
LocalVariable of a given name in this method. Multiple variables can be returned if the same variable name is used in disjoint scopes within the method.LocalVariable objects of the given name. If there are no matching local variables, a zero-length list is returned.AbsentInformationException - if there is no variable information for this method. Generally, local variable information is not available for native or abstract methods (that is, their argument name information is not available), thus they will throw this exception.List<LocalVariable> arguments() throws AbsentInformationException
LocalVariable that is declared as an argument of this method. If local variable information is not available, values of actual arguments to method invocations can be obtained by using the method StackFrame.getArgumentValues()
LocalVariable arguments. If there are no arguments, a zero-length list is returned.AbsentInformationException - if there is no variable information for this method. Generally, local variable information is not available for native or abstract methods (that is, their argument name information is not available), thus they will throw this exception.byte[] bytecodes()
Not all target virtual machines support this operation. Use VirtualMachine.canGetBytecodes() to determine if the operation is supported.
UnsupportedOperationException - if the target virtual machine does not support the retrieval of bytecodes.Location location()
Location of this method, if there is executable code associated with it.boolean equals(Object obj)
int hashCode()
© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/jdk.jdi/com/sun/jdi/Method.html