|
Java Debug Interface | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
A static or instance method in the target VM. See TypeComponent
for general information about Field and Method mirrors.
ObjectReference
,
ReferenceType
Method Summary | |
List |
allLineLocations()
Returns a list containing a Location object for
each executable source line in this method. |
List |
allLineLocations(String stratum,
String sourceName)
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(Object obj)
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 |
isConstructor()
Determine if this method is a constructor. |
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. |
Location |
location()
Returns the Location of this method, if there
is executable code associated with it. |
Location |
locationOfCodeIndex(long codeIndex)
Returns a Location for the given code index. |
List |
locationsOfLine(int lineNumber)
Returns a List containing all Location objects
that map to the given line number. |
List |
locationsOfLine(String stratum,
String sourceName,
int lineNumber)
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(String name)
Returns a list containing each LocalVariable of a
given name in this method. |
Methods inherited from interface com.sun.jdi.TypeComponent |
declaringType, isFinal, isStatic, isSynthetic, name, signature |
Methods inherited from interface com.sun.jdi.Mirror |
toString, virtualMachine |
Methods inherited from interface com.sun.jdi.Accessible |
isPackagePrivate, isPrivate, isProtected, isPublic, modifiers |
Methods inherited from interface java.lang.Comparable |
compareTo |
Method Detail |
public String returnTypeName()
This type name is always available even if the type has not yet been created or loaded.
public 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.Type
,
Field.type() - for usage examples
public List argumentTypeNames()
This list is always available even if the types have not yet been created or loaded.
List
of String
,
one List element for each parameter of this method.
Each element represents the type of a formal parameter
as specified at compile-time.public List 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.
ClassNotLoadedException
- if the type has not yet been loaded
through the appropriate class loader.Type
public boolean isAbstract()
true
if the method is declared abstract;
false otherwise.public boolean isSynchronized()
true
if the method is declared synchronized;
false otherwise.public boolean isNative()
true
if the method is declared native;
false otherwise.public boolean isConstructor()
true
if the method is a constructor;
false otherwise.public boolean isStaticInitializer()
true
if the method is a static initializer;
false otherwise.public boolean isObsolete()
true
if this method has been replaced by
a non-equivalent method using
VirtualMachine.redefineClasses(java.util.Map)
.public List 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.public List 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.public List 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 number
Location
objects that map to
the given line number.
AbsentInformationException
- if there is no line
number information for this method.public List 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 number
Location
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.public 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).public List 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.
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.public List 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.public List arguments() throws AbsentInformationException
LocalVariable
that is
declared as an argument of this method.
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.public 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.public Location location()
Location
of this method, if there
is executable code associated with it.
location
in interface Locatable
Location
of this mirror, or null if
this is an abstract method; native methods will return a
Location object whose codeIndex is -1.public boolean equals(Object obj)
public int hashCode()
|
Java Debug Interface | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |