org.netbeans.api.debugger.jpda

Interface JPDAClassType

All Superinterfaces:

VariableType

All Known Subinterfaces:

JPDAArrayType

public interface JPDAClassType
extends VariableType

Represents type of an object (class, interface, array) in the debugged process.

 Since JDI interfaces evolve from one version to another, it's strongly recommended
 not to implement this interface in client code. New methods can be added to
 this interface at any time to keep up with the JDI functionality.

Since:

2.7

Method Summary

Modifier and Type	Method and Description
ClassVariable	classObject() Returns the class object variable, that corresponds to this type in the target VM.
List<JPDAClassType>	getAllInterfaces() Get all interfaces that are directly or indirectly implemented by this class, or extended by this interface.
ObjectVariable	getClassLoader() Gets the classloader object which loaded the class corresponding to this type.
List<JPDAClassType>	getDirectInterfaces() Get the interfaces that are directly implemented by this class, or directly extended by this interface.
long	getInstanceCount() Retrieves the number of instances this class.
List<ObjectVariable>	getInstances(long maxInstances) Returns instances of this class type.
String	getSourceName() Get the source name of this type.
List<JPDAClassType>	getSubClasses() Get the currently loaded subclasses, when this type represents a class, or loaded subinterfaces and implementors of this interface, if this type represents an interface.
Super	getSuperClass() Gets the superclass of this class.
Variable	invokeMethod(String methodName, String signature, Variable[] arguments) Calls given static method in debugged JVM on this class and returns its value.
boolean	isInstanceOf(String className) Check if this type in an instance of a given class name.
List<Field>	staticFields() Provide a list of static fields declared in this type.

Methods inherited from interface org.netbeans.api.debugger.jpda.VariableType

getName

Method Detail

getSourceName

String getSourceName()
              throws com.sun.jdi.AbsentInformationException

Get the source name of this type.

Returns:

the source file name of this type.

Throws:

com.sun.jdi.AbsentInformationException

classObject

ClassVariable classObject()

Returns the class object variable, that corresponds to this type in the target VM.

Returns:

the class object variable.

Throws:

UnsupportedOperationException - when not supported by target VM.

getClassLoader

ObjectVariable getClassLoader()

Gets the classloader object which loaded the class corresponding to this type.

Returns:

an object variable representing the classloader, or null if the class was loaded through the bootstrap class loader.

getSuperClass

Super getSuperClass()

Gets the superclass of this class.

Returns:

the superclass of this class in the debuggee, or null if no such class exists.

getSubClasses

List<JPDAClassType> getSubClasses()

Get the currently loaded subclasses, when this type represents a class, or loaded subinterfaces and implementors of this interface, if this type represents an interface.

Returns:

a list of direct classes and interfaces, that extend this type. Returns an empty array when there are no such types.

Since:

3.2

getAllInterfaces

List<JPDAClassType> getAllInterfaces()

Get all interfaces that are directly or indirectly implemented by this class, or extended by this interface.

Returns:

a list of all implemented or extended interfaces. Returns an empty array when there are no such interfaces.

Since:

3.2

getDirectInterfaces

List<JPDAClassType> getDirectInterfaces()

Get the interfaces that are directly implemented by this class, or directly extended by this interface.

Returns:

a list of all implemented or extended interfaces. Returns an empty array when there are no such interfaces.

Since:

3.2

isInstanceOf

boolean isInstanceOf(String className)

Check if this type in an instance of a given class name.

Parameters:

className - the class name

Returns:

true when this type is an instance of the given class name, false otherwise.

Since:

3.2

staticFields

List<Field> staticFields()

Provide a list of static fields declared in this type.

Returns:

the list of Field objects representing static fields.

invokeMethod

Variable invokeMethod(String methodName,
                      String signature,
                      Variable[] arguments)
               throws NoSuchMethodException,
                      InvalidExpressionException

Calls given static method in debugged JVM on this class and returns its value.

Parameters:

methodName - a name of method to be called

signature - a signature of method to be called

arguments - arguments to be used

Returns:

value of given method call on this instance

Throws:

NoSuchMethodException - when the method does not exist

InvalidExpressionException - in case of execution problems

Since:

2.47

getInstanceCount

long getInstanceCount()
               throws UnsupportedOperationException

Retrieves the number of instances this class. Use JPDADebugger.canGetInstanceInfo() to determine if this operation is supported.

Returns:

the number of instances.

Throws:

UnsupportedOperationException

getInstances

List<ObjectVariable> getInstances(long maxInstances)
                           throws UnsupportedOperationException

Returns instances of this class type. Only instances that are reachable for the purposes of garbage collection are returned. Use JPDADebugger.canGetInstanceInfo() to determine if this operation is supported.

Parameters:

maxInstances - the maximum number of instances to return. Must be non-negative. If zero, all instances are returned.

Returns:

a List of object variables.

Throws:

UnsupportedOperationException