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

Method Summary

Modifier and Type	Method and Description
public List<Field>	Returns: a List of `Field` objects; the list has length 0 if no fields exist. allFields() Returns a list containing each `Field` declared in this type, and its superclasses, implemented interfaces, and/or superinterfaces.
public List<Location>	allLineLocations() Returns a list containing a `Location` object for each executable source line in this reference type.
public List<Location>	Returns: a List of all source line `Location` objects. allLineLocations(String The stratum to retrieve information from or `null` for the `defaultStratum()`. stratum, String Return locations only within this source file or `null` to return locations. sourceName) Returns a list containing a `Location` object for each executable source line in this reference type.
public List<Method>	Returns: a List of `Method` objects; the list has length 0 if no methods exist. allMethods() Returns a list containing each `Method` declared in this type, and its superclasses, implemented interfaces, and/or superinterfaces.
public List<String>	Returns: List of `java.lang.String`, each representing a stratum availableStrata() Return the available strata for this reference type.
public ClassLoaderReference	Returns: a `ClassLoaderReference` which mirrors the classloader, or `null` if the class was loaded through the bootstrap class loader. classLoader() Gets the classloader object which loaded the class corresponding to this type.
public ClassObjectReference	Returns: the `ClassObjectReference` for this reference type in the target VM. classObject() Returns the class object that corresponds to this type in the target VM.
public byte[]	Returns: the raw bytes of constant pool. constantPool() Returns the raw bytes of the constant pool in the format of the constant_pool item of the Class File Format in the Java Virtual Machine Specification.
public int	Returns: total number of constant pool entries for a class plus one. constantPoolCount() Returns the number of entries in the constant pool plus one.
public String	defaultStratum() Returns the default stratum for this reference type.
public boolean	Returns: true if the Object is a `ReferenceType`, if the ReferenceTypes belong to the same VM, and if they mirror classes which correspond to the same instance of java.lang.Class in that VM. equals(Object obj) Compares the specified Object with this ReferenceType for equality.
public boolean	Returns: `true` if initialization was attempted and failed; false otherwise. failedToInitialize() Determines if initialization failed for this class.
public Field	Returns: a `Field` object which mirrors the found field, or null if there is no field with the given name or if the given name is ambiguous. fieldByName(String a String containing the name of desired field. fieldName) Finds the visible `Field` with the given non-ambiguous name.
public List<Field>	Returns: a list `Field` objects; the list has length 0 if no fields exist. fields() Returns a list containing each `Field` declared in this type.
public String	Returns: a string containing the generic signature, or `null` if there is no generic signature. genericSignature() Gets the generic signature for this type if there is one.
public Value	Returns: the `Value` of the instance field. getValue(Field the field containing the requested value field) Gets the `Value` of a given static `Field` in this type.
public Map<Field, Value>	Returns: a Map of the requested `Field` objects with their `Value`. getValues(List<? extends Field> a list of `Field` objects containing the requested values. fields) Returns a map containing the `Value` of each static `Field` in the given list.
public int	Returns: the integer hash code hashCode() Returns the hash code value for this ObjectReference.
public List<ObjectReference>	Returns: a List of `ObjectReference` objects. If there are no instances of this ReferenceType, a zero-length list is returned. instances(long the maximum number of instances to return. Must be non-negative. If zero, all instances are returned. maxInstances) Returns instances of this ReferenceType.
public boolean	Returns: `true` if this type is abstract; false otherwise. isAbstract() Determines if this type was declared abstract.
public boolean	Returns: `true` if this type is final; false otherwise. isFinal() Determines if this type was declared final.
public boolean	Returns: `true` if this type is initialized; false otherwise. isInitialized() Determines if this type has been initialized.
public boolean	Returns: `true` if this type is prepared; false otherwise. isPrepared() Determines if this type has been prepared.
public boolean	Returns: `true` if this type is static; false otherwise. isStatic() Determines if this type was declared static.
public boolean	Returns: `true` if this type is verified; false otherwise. isVerified() Determines if this type has been verified.
public List<Location>	Returns: a List of all `Location` objects that map to the given line. locationsOfLine(int the line number lineNumber) Returns a List containing all `Location` objects that map to the given line number.
public List<Location>	Returns: a List of all `Location` objects that map to the given line. locationsOfLine(String the stratum to use for comparing line number and source name, or `null` to use the `defaultStratum()`. stratum, String the source name containing the line number, or `null` to match all source names sourceName, int the line number lineNumber) Returns a List containing all `Location` objects that map to the given line number.
public int	Returns: the major version number of the class. majorVersion() Returns the class major version number, as defined in the class file format of the Java Virtual Machine Specification.
public List<Method>	Returns: a list `Method` objects; the list has length 0 if no methods exist. methods() Returns a list containing each `Method` declared directly in this type.
public List<Method>	Returns: a List of `Method` objects that match the given name; the list has length 0 if no matching methods are found. methodsByName(String the name of the method to find. name) Returns a List containing each visible `Method` that has the given name.
public List<Method>	Returns: a List of `Method` objects that match the given name and signature; the list has length 0 if no matching methods are found. methodsByName(String the name of the method to find. name, String the signature of the method to find signature) Returns a List containing each visible `Method` that has the given name and signature.
public int	Returns: the minor version number of the class. minorVersion() Returns the class minor version number, as defined in the class file format of the Java Virtual Machine Specification.
public default ModuleReference	Returns: a `ModuleReference` which mirrors the module in the target VM. module() Gets the module object which contains the class corresponding to this type.
public String	Returns: a string containing the type name. name() Redeclares com.sun.jdi.Type.name. Returns the name of this `ReferenceType` object.
public List<ReferenceType>	Returns: a List of nested `ReferenceType` objects; the list has 0 length if there are no nested types. nestedTypes() Returns a List containing `ReferenceType` objects that are declared within this type and are currently loaded into the Virtual Machine.
public String	Returns: as a string the source debug extension attribute sourceDebugExtension() Get the source debug extension of this type.
public String	Returns: the string source file name sourceName() Gets an identifying name for the source corresponding to the declaration of this type.
public List<String>	Returns: a List of String objects each representing a source name sourceNames(String The stratum to retrieve information from or `null` for the declaring type's default stratum. stratum) Gets the identifying names for all the source corresponding to the declaration of this type.
public List<String>	Returns: a List of String objects each representing a source path sourcePaths(String The stratum to retrieve information from or `null` for the declaring type's default stratum. stratum) Gets the paths to the source corresponding to the declaration of this type.
public List<Field>	Returns: a List of `Field` objects; the list has length 0 if no visible fields exist. visibleFields() Returns a list containing each unhidden and unambiguous `Field` in this type.
public List<Method>	Returns: a List of `Method` objects; the list has length 0 if no visible methods exist. visibleMethods() Returns a list containing each `Method` declared or inherited by this type.

Inherited from com.sun.jdi.Accessible:: isPackagePrivate isPrivate isProtected isPublic modifiers
Inherited from com.sun.jdi.Type:: signature
Inherited from java.lang.Comparable:: compareTo

Method Detail

allFields back to summary

allFields	back to summary
public List<Field> allFields() Returns a list containing each `Field` declared in this type, and its superclasses, implemented interfaces, and/or superinterfaces. All declared and inherited fields are included, regardless of whether they are hidden or multiply inherited. For arrays (`ArrayType`) and primitive classes, the returned list is always empty. Returns:List<Field> a List of `Field` objects; the list has length 0 if no fields exist. Exceptions ClassNotPreparedException: if this class not yet been prepared.

public List<Field> allFields()

Returns a list containing each Field declared in this type, and its superclasses, implemented interfaces, and/or superinterfaces. All declared and inherited fields are included, regardless of whether they are hidden or multiply inherited.

For arrays (ArrayType) and primitive classes, the returned list is always empty.

Returns:List<Field>

a List of Field objects; the list has length 0 if no fields exist.

Exceptions

ClassNotPreparedException:: if this class not yet been prepared.

allLineLocations back to summary

allLineLocations	back to summary
public List<Location> allLineLocations() throws AbsentInformationException Returns a list containing a `Location` object for each executable source line in this reference type. 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 class and there are non-native, non-abstract executable members of this class. ClassNotPreparedException: if this class not yet been prepared.

public List<Location> allLineLocations() throws AbsentInformationException

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

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 class and there are non-native, non-abstract executable members of this class.
ClassNotPreparedException:: if this class not yet been prepared.

allLineLocations back to summary

allLineLocations	back to summary
public List<Location> allLineLocations(String stratum, String sourceName) throws AbsentInformationException Returns a list containing a `Location` object for each executable source line in this reference type. 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 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. Note that it is possible for the same source line to represent different code index ranges in different methods. For arrays (`ArrayType`) and primitive classes, the returned list is always empty. For interfaces (`InterfaceType`), the returned list will be non-empty only if the interface has executable code in its class initialization. Returned list is for the specified stratum (see `Location` for a description of strata). Parameters stratum:String The stratum to retrieve information from or `null` for the `defaultStratum()`. sourceName:String Return locations only within this source file or `null` to return locations. Returns:List<Location> a List of all source line `Location` objects. Exceptions AbsentInformationException: if there is no line number information for this class and there are non-native, non-abstract executable members of this class. Or if sourceName is non-`null` and source name information is not present. ClassNotPreparedException: if this class not yet been prepared. Since 1.4

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

Returns a list containing a Location object for each executable source line in this reference type. 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 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. Note that it is possible for the same source line to represent different code index ranges in different methods.

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

Parameters

stratum:String: The stratum to retrieve information from or null for the defaultStratum().
sourceName:String: Return locations only within this source file or null to return locations.

Returns:List<Location>

a List of all source line Location objects.

Exceptions

AbsentInformationException:: if there is no line number information for this class and there are non-native, non-abstract executable members of this class. Or if sourceName is non-null and source name information is not present.
ClassNotPreparedException:: if this class not yet been prepared.

Since

1.4

allMethods back to summary

allMethods	back to summary
public List<Method> allMethods() Returns a list containing each `Method` declared in this type, and its superclasses, implemented interfaces, and/or superinterfaces. All declared and inherited methods are included, regardless of whether they are hidden or overridden. For arrays (`ArrayType`) and primitive classes, the returned list is always empty. Returns:List<Method> a List of `Method` objects; the list has length 0 if no methods exist. Exceptions ClassNotPreparedException: if this class not yet been prepared.

public List<Method> allMethods()

Returns a list containing each Method declared in this type, and its superclasses, implemented interfaces, and/or superinterfaces. All declared and inherited methods are included, regardless of whether they are hidden or overridden.

For arrays (ArrayType) and primitive classes, the returned list is always empty.

Returns:List<Method>

a List of Method objects; the list has length 0 if no methods exist.

Exceptions

ClassNotPreparedException:: if this class not yet been prepared.

availableStrata back to summary

availableStrata	back to summary
public List<String> availableStrata() Return the available strata for this reference type. See the `Location` for a description of strata. Returns:List<String> List of `java.lang.String`, each representing a stratum Since 1.4

public List<String> availableStrata()

Return the available strata for this reference type.

See the Location for a description of strata.

Returns:List<String>: List of java.lang.String, each representing a stratum
Since: 1.4

classLoader back to summary

classLoader	back to summary
public ClassLoaderReference classLoader() Gets the classloader object which loaded the class corresponding to this type. Returns:ClassLoaderReference a `ClassLoaderReference` which mirrors the classloader, or `null` if the class was loaded through the bootstrap class loader.

public ClassLoaderReference classLoader()

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

Returns:ClassLoaderReference: a ClassLoaderReference which mirrors the classloader, or null if the class was loaded through the bootstrap class loader.

classObject back to summary

classObject	back to summary
public ClassObjectReference classObject() Returns the class object that corresponds to this type in the target VM. The VM creates class objects for every kind of ReferenceType: classes, interfaces, and array types. Returns:ClassObjectReference the `ClassObjectReference` for this reference type in the target VM.

public ClassObjectReference classObject()

Returns the class object that corresponds to this type in the target VM. The VM creates class objects for every kind of ReferenceType: classes, interfaces, and array types.

Returns:ClassObjectReference: the ClassObjectReference for this reference type in the target VM.

constantPool back to summary

constantPool	back to summary
public byte[] constantPool() Returns the raw bytes of the constant pool in the format of the constant_pool item of the Class File Format in the Java Virtual Machine Specification. The format of the constant pool may differ between versions of the Class File Format, so, the minor and major class version numbers should be checked for compatibility. For arrays (`ArrayType`) and primitive classes, a zero length byte array is returned. Not all target virtual machines support this operation. Use `VirtualMachine#canGetConstantPool()` to determine if the operation is supported. Returns:byte[] the raw bytes of constant pool. Exceptions UnsupportedOperationException: if the target virtual machine does not support this operation - see `canGetConstantPool()` Since 1.6 See Also `constantPoolCount()`

public byte[] constantPool()

Returns the raw bytes of the constant pool in the format of the constant_pool item of the Class File Format in the Java Virtual Machine Specification. The format of the constant pool may differ between versions of the Class File Format, so, the minor and major class version numbers should be checked for compatibility. For arrays (ArrayType) and primitive classes, a zero length byte array is returned. Not all target virtual machines support this operation. Use VirtualMachine#canGetConstantPool() to determine if the operation is supported.

Returns:byte[]

the raw bytes of constant pool.

Exceptions

UnsupportedOperationException:: if the target virtual machine does not support this operation - see canGetConstantPool()

Since

1.6

See Also

constantPoolCount()

constantPoolCount back to summary

constantPoolCount	back to summary
public int constantPoolCount() Returns the number of entries in the constant pool plus one. This corresponds to the constant_pool_count item of the Class File Format in the Java Virtual Machine Specification. For arrays (`ArrayType`) and primitive classes, the returned constant pool count value is zero. Not all target virtual machines support this operation. Use `VirtualMachine#canGetConstantPool()` to determine if the operation is supported. Returns:int total number of constant pool entries for a class plus one. Exceptions UnsupportedOperationException: if the target virtual machine does not support this operation - see `canGetConstantPool()` Since 1.6 See Also `constantPool()`

public int constantPoolCount()

Returns the number of entries in the constant pool plus one. This corresponds to the constant_pool_count item of the Class File Format in the Java Virtual Machine Specification. For arrays (ArrayType) and primitive classes, the returned constant pool count value is zero. Not all target virtual machines support this operation. Use VirtualMachine#canGetConstantPool() to determine if the operation is supported.

Returns:int

total number of constant pool entries for a class plus one.

Exceptions

UnsupportedOperationException:: if the target virtual machine does not support this operation - see canGetConstantPool()

Since

1.6

See Also

constantPool()

defaultStratum back to summary

defaultStratum	back to summary
public String defaultStratum() Returns the default stratum for this reference type. This value is specified in the class file and cannot be set by the user. If the class file does not specify a default stratum the base stratum (`"Java"`) will be returned. See the `Location` for a description of strata. Since 1.4

public String defaultStratum()

Returns the default stratum for this reference type. This value is specified in the class file and cannot be set by the user. If the class file does not specify a default stratum the base stratum ("Java") will be returned.

See the Location for a description of strata.

Since: 1.4

equals back to summary

equals	back to summary
public boolean equals(Object obj) Compares the specified Object with this ReferenceType for equality. Returns:boolean true if the Object is a `ReferenceType`, if the ReferenceTypes belong to the same VM, and if they mirror classes which correspond to the same instance of java.lang.Class in that VM.

public boolean equals(Object obj)

Compares the specified Object with this ReferenceType for equality.

Returns:boolean: true if the Object is a ReferenceType, if the ReferenceTypes belong to the same VM, and if they mirror classes which correspond to the same instance of java.lang.Class in that VM.

failedToInitialize back to summary

failedToInitialize	back to summary
public boolean failedToInitialize() Determines if initialization failed for this class. See the JVM specification for details on class initialization. For arrays (`ArrayType`) and primitive classes, the return value is undefined. Returns:boolean `true` if initialization was attempted and failed; false otherwise.

public boolean failedToInitialize()

Determines if initialization failed for this class. See the JVM specification for details on class initialization.

For arrays (ArrayType) and primitive classes, the return value is undefined.

Returns:boolean: true if initialization was attempted and failed; false otherwise.

fieldByName back to summary

fieldByName	back to summary
public Field fieldByName(String fieldName) Finds the visible `Field` with the given non-ambiguous name. This method follows the inheritance rules specified in the JLS (8.3.3) to determine visibility. For arrays (`ArrayType`) and primitive classes, the returned value is always null. Parameters fieldName:String a String containing the name of desired field. Returns:Field a `Field` object which mirrors the found field, or null if there is no field with the given name or if the given name is ambiguous. Exceptions ClassNotPreparedException: if this class not yet been prepared.

public Field fieldByName(String fieldName)

Finds the visible Field with the given non-ambiguous name. This method follows the inheritance rules specified in the JLS (8.3.3) to determine visibility.

For arrays (ArrayType) and primitive classes, the returned value is always null.

Parameters

fieldName:String: a String containing the name of desired field.

Returns:Field

a Field object which mirrors the found field, or null if there is no field with the given name or if the given name is ambiguous.

Exceptions

ClassNotPreparedException:: if this class not yet been prepared.

fields back to summary

fields	back to summary
public List<Field> fields() Returns a list containing each `Field` declared in this type. Inherited fields are not included. Any synthetic fields created by the compiler are included in the list. For arrays (`ArrayType`) and primitive classes, the returned list is always empty. Returns:List<Field> a list `Field` objects; the list has length 0 if no fields exist. Exceptions ClassNotPreparedException: if this class not yet been prepared.

public List<Field> fields()

Returns a list containing each Field declared in this type. Inherited fields are not included. Any synthetic fields created by the compiler are included in the list.

For arrays (ArrayType) and primitive classes, the returned list is always empty.

Returns:List<Field>

a list Field objects; the list has length 0 if no fields exist.

Exceptions

ClassNotPreparedException:: if this class not yet been prepared.

genericSignature back to summary

genericSignature	back to summary
public String genericSignature() Gets the generic signature for this type if there is one. Generic signatures are described in the The Java Virtual Machine Specification. Returns:String a string containing the generic signature, or `null` if there is no generic signature. Since 1.5

public String genericSignature()

Gets the generic signature for this type if there is one. Generic signatures are described in the The Java Virtual Machine Specification.

Returns:String: a string containing the generic signature, or null if there is no generic signature.
Since: 1.5

getValue back to summary

getValue	back to summary
public Value getValue(Field field) Gets the `Value` of a given static `Field` in this type. The Field must be valid for this type; that is, it must be declared in this type, a superclass, a superinterface, or an implemented interface. Parameters field:Field the field containing the requested value Returns:Value the `Value` of the instance field. Exceptions IllegalArgumentException: if the field is not valid for this object's class.

public Value getValue(Field field)

Gets the Value of a given static Field in this type. The Field must be valid for this type; that is, it must be declared in this type, a superclass, a superinterface, or an implemented interface.

Parameters

field:Field: the field containing the requested value

Returns:Value

the Value of the instance field.

Exceptions

IllegalArgumentException:: if the field is not valid for this object's class.

getValues back to summary

getValues	back to summary
public Map<Field, Value> getValues(List<? extends Field> fields) Returns a map containing the `Value` of each static `Field` in the given list. The Fields must be valid for this type; that is, they must be declared in this type, a superclass, a superinterface, or an implemented interface. Parameters fields:List<? extends Field> a list of `Field` objects containing the requested values. Returns:Map<Field, Value> a Map of the requested `Field` objects with their `Value`. Exceptions IllegalArgumentException: if any field is not valid for this object's class. VMMismatchException: if a `Mirror` argument and this mirror do not belong to the same `VirtualMachine`.

public Map<Field, Value> getValues(List<? extends Field> fields)

Returns a map containing the Value of each static Field in the given list. The Fields must be valid for this type; that is, they must be declared in this type, a superclass, a superinterface, or an implemented interface.

Parameters

fields:List<? extends Field>: a list of Field objects containing the requested values.

Returns:Map<Field, Value>

a Map of the requested Field objects with their Value.

Exceptions

IllegalArgumentException:: if any field is not valid for this object's class.
VMMismatchException:: if a Mirror argument and this mirror do not belong to the same VirtualMachine.

hashCode	back to summary
public int hashCode() Returns the hash code value for this ObjectReference. Returns:int the integer hash code

hashCode

back to summary

public int hashCode()

Returns the hash code value for this ObjectReference.

Returns:int: the integer hash code

instances back to summary

instances	back to summary
public List<ObjectReference> instances(long maxInstances) Returns instances of this ReferenceType. Only instances that are reachable for the purposes of garbage collection are returned. Not all target virtual machines support this operation. Use `VirtualMachine#canGetInstanceInfo()` to determine if the operation is supported. Parameters maxInstances:long the maximum number of instances to return. Must be non-negative. If zero, all instances are returned. Returns:List<ObjectReference> a List of `ObjectReference` objects. If there are no instances of this ReferenceType, a zero-length list is returned. Exceptions UnsupportedOperationException: if the target virtual machine does not support this operation - see `canGetInstanceInfo()` IllegalArgumentException: if maxInstances is less than zero. Since 1.6 See Also `VirtualMachine#instanceCounts(List)`, `ObjectReference#referringObjects(long)`

public List<ObjectReference> instances(long maxInstances)

Returns instances of this ReferenceType. Only instances that are reachable for the purposes of garbage collection are returned.

Not all target virtual machines support this operation. Use VirtualMachine#canGetInstanceInfo() to determine if the operation is supported.

Parameters

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

Returns:List<ObjectReference>

a List of ObjectReference objects. If there are no instances of this ReferenceType, a zero-length list is returned.

Exceptions

UnsupportedOperationException:: if the target virtual machine does not support this operation - see canGetInstanceInfo()
IllegalArgumentException:: if maxInstances is less than zero.

Since

1.6

isAbstract back to summary

isAbstract	back to summary
public boolean isAbstract() Determines if this type was declared abstract. For arrays (`ArrayType`) and primitive classes, the return value is undefined. Returns:boolean `true` if this type is abstract; false otherwise.

public boolean isAbstract()

Determines if this type was declared abstract.

For arrays (ArrayType) and primitive classes, the return value is undefined.

Returns:boolean: true if this type is abstract; false otherwise.

isFinal back to summary

isFinal	back to summary
public boolean isFinal() Determines if this type was declared final. For arrays (`ArrayType`) and primitive classes, the return value is always true. Returns:boolean `true` if this type is final; false otherwise.

public boolean isFinal()

Determines if this type was declared final.

For arrays (ArrayType) and primitive classes, the return value is always true.

Returns:boolean: true if this type is final; false otherwise.

isInitialized back to summary

isInitialized	back to summary
public boolean isInitialized() Determines if this type has been initialized. See the JVM specification for a definition of class verification. For `InterfaceType`, this method always returns the same value as `isPrepared()`. For arrays (`ArrayType`) and primitive classes, the return value is undefined. Returns:boolean `true` if this type is initialized; false otherwise.

public boolean isInitialized()

Determines if this type has been initialized. See the JVM specification for a definition of class verification. For InterfaceType, this method always returns the same value as isPrepared().

For arrays (ArrayType) and primitive classes, the return value is undefined.

Returns:boolean: true if this type is initialized; false otherwise.

isPrepared back to summary

isPrepared	back to summary
public boolean isPrepared() Determines if this type has been prepared. See the JVM specification for a definition of class preparation. For arrays (`ArrayType`) and primitive classes, the return value is undefined. Returns:boolean `true` if this type is prepared; false otherwise.

public boolean isPrepared()

Determines if this type has been prepared. See the JVM specification for a definition of class preparation.

For arrays (ArrayType) and primitive classes, the return value is undefined.

Returns:boolean: true if this type is prepared; false otherwise.

isStatic back to summary

isStatic	back to summary
public boolean isStatic() Determines if this type was declared static. Only nested types, can be declared static, so `false` is returned for any package-level type, array type, or primitive class. Returns:boolean `true` if this type is static; false otherwise.

public boolean isStatic()

Determines if this type was declared static. Only nested types, can be declared static, so false is returned for any package-level type, array type, or primitive class.

Returns:boolean: true if this type is static; false otherwise.

isVerified back to summary

isVerified	back to summary
public boolean isVerified() Determines if this type has been verified. See the JVM specification for a definition of class verification. For arrays (`ArrayType`) and primitive classes, the return value is undefined. Returns:boolean `true` if this type is verified; false otherwise.

public boolean isVerified()

Determines if this type has been verified. See the JVM specification for a definition of class verification.

For arrays (ArrayType) and primitive classes, the return value is undefined.

Returns:boolean: true if this type is verified; false otherwise.

locationsOfLine back to summary

locationsOfLine	back to summary
public List<Location> locationsOfLine(int lineNumber) throws AbsentInformationException 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. Parameters lineNumber:int the line number Returns:List<Location> a List of all `Location` objects that map to the given line. Exceptions AbsentInformationException: if there is no line number information for this class. ClassNotPreparedException: if this class not yet been prepared. See Also `VirtualMachine#getDefaultStratum()`

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

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.

Parameters

lineNumber:int: the line number

Returns:List<Location>

a List of all Location objects that map to the given line.

Exceptions

AbsentInformationException:: if there is no line number information for this class.
ClassNotPreparedException:: if this class not yet been prepared.

See Also

VirtualMachine#getDefaultStratum()

locationsOfLine back to summary

locationsOfLine	back to summary
public List<Location> locationsOfLine(String stratum, String sourceName, int lineNumber) throws AbsentInformationException Returns a List containing all `Location` objects that map to the given line number. For arrays (`ArrayType`) and primitive classes, the returned list is always empty. For interfaces (`InterfaceType`), the returned list will be non-empty only if the interface has executable code in its class initialization at the specified line number. An empty list will be returned if there is no executable code at the specified line number. Returned list is for the specified stratum (see `Location` for a description of strata). Parameters stratum:String the stratum to use for comparing line number and source name, or `null` to use the `defaultStratum()`. sourceName:String the source name containing the line number, or `null` to match all source names lineNumber:int the line number Returns:List<Location> a List of all `Location` objects that map to the given line. Exceptions AbsentInformationException: if there is no line number information for this class. Or if sourceName is non-`null` and source name information is not present. ClassNotPreparedException: if this class not yet been prepared. Since 1.4

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

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

For arrays (ArrayType) and primitive classes, the returned list is always empty. For interfaces (InterfaceType), the returned list will be non-empty only if the interface has executable code in its class initialization at the specified line number. An empty list will be returned if there is no executable code at the specified line number.

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

Parameters

stratum:String: the stratum to use for comparing line number and source name, or null to use the defaultStratum().
sourceName:String: the source name containing the line number, or null to match all source names
lineNumber:int: the line number

Returns:List<Location>

a List of all Location objects that map to the given line.

Exceptions

AbsentInformationException:: if there is no line number information for this class. Or if sourceName is non-null and source name information is not present.
ClassNotPreparedException:: if this class not yet been prepared.

Since

1.4

majorVersion back to summary

majorVersion	back to summary
public int majorVersion() Returns the class major version number, as defined in the class file format of the Java Virtual Machine Specification. For arrays (`ArrayType`) and primitive classes, the returned major version number value is zero. Not all target virtual machines support this operation. Use `VirtualMachine#canGetClassFileVersion()` to determine if the operation is supported. Returns:int the major version number of the class. Exceptions UnsupportedOperationException: if the target virtual machine does not support this operation - see `canGetClassFileVersion()` Since 1.6

public int majorVersion()

Returns the class major version number, as defined in the class file format of the Java Virtual Machine Specification. For arrays (ArrayType) and primitive classes, the returned major version number value is zero. Not all target virtual machines support this operation. Use VirtualMachine#canGetClassFileVersion() to determine if the operation is supported.

Returns:int

the major version number of the class.

Exceptions

UnsupportedOperationException:: if the target virtual machine does not support this operation - see canGetClassFileVersion()

Since

1.6

methods back to summary

methods	back to summary
public List<Method> methods() Returns a list containing each `Method` declared directly in this type. Inherited methods are not included. Constructors, the initialization method if any, and any synthetic methods created by the compiler are included in the list. For arrays (`ArrayType`) and primitive classes, the returned list is always empty. Returns:List<Method> a list `Method` objects; the list has length 0 if no methods exist. Exceptions ClassNotPreparedException: if this class not yet been prepared.

public List<Method> methods()

Returns a list containing each Method declared directly in this type. Inherited methods are not included. Constructors, the initialization method if any, and any synthetic methods created by the compiler are included in the list.

For arrays (ArrayType) and primitive classes, the returned list is always empty.

Returns:List<Method>

a list Method objects; the list has length 0 if no methods exist.

Exceptions

ClassNotPreparedException:: if this class not yet been prepared.

methodsByName back to summary

methodsByName	back to summary
public List<Method> methodsByName(String name) Returns a List containing each visible `Method` that has the given name. This is most commonly used to find overloaded methods. Overridden and hidden methods are not included. See JLS (8.4.8) for details. For arrays (`ArrayType`) and primitive classes, the returned list is always empty. Parameters name:String the name of the method to find. Returns:List<Method> a List of `Method` objects that match the given name; the list has length 0 if no matching methods are found. Exceptions ClassNotPreparedException: if this class not yet been prepared.

public List<Method> methodsByName(String name)

Returns a List containing each visible Method that has the given name. This is most commonly used to find overloaded methods.

Overridden and hidden methods are not included. See JLS (8.4.8) for details.

For arrays (ArrayType) and primitive classes, the returned list is always empty.

Parameters

name:String: the name of the method to find.

Returns:List<Method>

a List of Method objects that match the given name; the list has length 0 if no matching methods are found.

Exceptions

ClassNotPreparedException:: if this class not yet been prepared.

methodsByName back to summary

methodsByName	back to summary
public List<Method> methodsByName(String name, String signature) Returns a List containing each visible `Method` that has the given name and signature. The signature string is the JNI signature for the target method: `()V` `([Ljava/lang/String;)V` `(IIII)Z` This method follows the inheritance rules specified in the JLS (8.4.8) to determine visibility. At most one method in the list is a concrete method and a component of `ClassType`; any other methods in the list are abstract. Use `ClassType#concreteMethodByName` to retrieve only the matching concrete method. For arrays (`ArrayType`) and primitive classes, the returned list is always empty. Parameters name:String the name of the method to find. signature:String the signature of the method to find Returns:List<Method> a List of `Method` objects that match the given name and signature; the list has length 0 if no matching methods are found. Exceptions ClassNotPreparedException: if this class not yet been prepared.

public List<Method> methodsByName(String name, String signature)

Returns a List containing each visible Method that has the given name and signature. The signature string is the JNI signature for the target method:

()V
([Ljava/lang/String;)V
(IIII)Z

This method follows the inheritance rules specified in the JLS (8.4.8) to determine visibility.

At most one method in the list is a concrete method and a component of ClassType; any other methods in the list are abstract. Use ClassType#concreteMethodByName to retrieve only the matching concrete method.

For arrays (ArrayType) and primitive classes, the returned list is always empty.

Parameters

name:String: the name of the method to find.
signature:String: the signature of the method to find

Returns:List<Method>

a List of Method objects that match the given name and signature; the list has length 0 if no matching methods are found.

Exceptions

ClassNotPreparedException:: if this class not yet been prepared.

minorVersion back to summary

minorVersion	back to summary
public int minorVersion() Returns the class minor version number, as defined in the class file format of the Java Virtual Machine Specification. For arrays (`ArrayType`) and primitive classes, the returned minor version number value is zero. Not all target virtual machines support this operation. Use `VirtualMachine#canGetClassFileVersion()` to determine if the operation is supported. Returns:int the minor version number of the class. Exceptions UnsupportedOperationException: if the target virtual machine does not support this operation - see `canGetClassFileVersion()` Since 1.6

public int minorVersion()

Returns the class minor version number, as defined in the class file format of the Java Virtual Machine Specification. For arrays (ArrayType) and primitive classes, the returned minor version number value is zero. Not all target virtual machines support this operation. Use VirtualMachine#canGetClassFileVersion() to determine if the operation is supported.

Returns:int

the minor version number of the class.

Exceptions

UnsupportedOperationException:: if the target virtual machine does not support this operation - see canGetClassFileVersion()

Since

1.6

module back to summary

module	back to summary
public default ModuleReference module() Gets the module object which contains the class corresponding to this type. Not all target virtual machines support this operation. Use `VirtualMachine#canGetModuleInfo()` to determine if the operation is supported. Implementation Specification The default implementation throws `UnsupportedOperationException`. Returns:ModuleReference a `ModuleReference` which mirrors the module in the target VM. Exceptions UnsupportedOperationException: if the target virtual machine does not support this operation. Since 9

public default ModuleReference module()

Gets the module object which contains the class corresponding to this type. Not all target virtual machines support this operation. Use VirtualMachine#canGetModuleInfo() to determine if the operation is supported.

Implementation Specification

The default implementation throws UnsupportedOperationException.

Returns:ModuleReference

a ModuleReference which mirrors the module in the target VM.

Exceptions

UnsupportedOperationException:: if the target virtual machine does not support this operation.

Since

name back to summary

name	back to summary
public String name() Redeclares com.sun.jdi.Type.name. Returns the name of this `ReferenceType` object. The returned name is of the same form as the name returned by `Class#getName()`. Returns:String a string containing the type name. See Also `Class#getName()`

public String name()

Redeclares com.sun.jdi.Type.name.

Returns the name of this ReferenceType object. The returned name is of the same form as the name returned by Class#getName().

Returns:String: a string containing the type name.
See Also: Class#getName()

nestedTypes back to summary

nestedTypes	back to summary
public List<ReferenceType> nestedTypes() Returns a List containing `ReferenceType` objects that are declared within this type and are currently loaded into the Virtual Machine. Both static nested types and non-static nested types (that is, inner types) are included. Local inner types (declared within a code block somewhere in this reference type) are also included in the returned list. For arrays (`ArrayType`) and primitive classes, the returned list is always empty. Returns:List<ReferenceType> a List of nested `ReferenceType` objects; the list has 0 length if there are no nested types.

public List<ReferenceType> nestedTypes()

Returns a List containing ReferenceType objects that are declared within this type and are currently loaded into the Virtual Machine. Both static nested types and non-static nested types (that is, inner types) are included. Local inner types (declared within a code block somewhere in this reference type) are also included in the returned list.

For arrays (ArrayType) and primitive classes, the returned list is always empty.

Returns:List<ReferenceType>: a List of nested ReferenceType objects; the list has 0 length if there are no nested types.

sourceDebugExtension back to summary

sourceDebugExtension	back to summary
public String sourceDebugExtension() throws AbsentInformationException Get the source debug extension of this type. Not all target virtual machines support this operation. Use `canGetSourceDebugExtension()` to determine if the operation is supported. Returns:String as a string the source debug extension attribute Exceptions AbsentInformationException: if the extension is not specified UnsupportedOperationException: if the target virtual machine does not support this operation - see `canGetSourceDebugExtension()`,

public String sourceDebugExtension() throws AbsentInformationException

Get the source debug extension of this type.

Not all target virtual machines support this operation. Use canGetSourceDebugExtension() to determine if the operation is supported.

Returns:String

as a string the source debug extension attribute

Exceptions

AbsentInformationException:: if the extension is not specified
UnsupportedOperationException:: if the target virtual machine does not support this operation - see canGetSourceDebugExtension(),

sourceName back to summary

sourceName	back to summary
public String sourceName() throws AbsentInformationException Gets an identifying name for the source corresponding to the declaration of this type. Interpretation of this string is the responsibility of the source repository mechanism. The returned name is dependent on VM's default stratum (`VirtualMachine#getDefaultStratum()`). In the reference implementation, when using the base stratum, the returned string is the unqualified name of the source file containing the declaration of this type. In other strata the returned source name is the first source name for that stratum. Since other languages may have more than one source name for a reference type, the use of `Location#sourceName()` or `sourceNames(String)` is preferred. For arrays (`ArrayType`) and primitive classes, AbsentInformationException is always thrown. Returns:String the string source file name Exceptions AbsentInformationException: if the source name is not known

public String sourceName() throws AbsentInformationException

Gets an identifying name for the source corresponding to the declaration of this type. Interpretation of this string is the responsibility of the source repository mechanism.

The returned name is dependent on VM's default stratum (VirtualMachine#getDefaultStratum()). In the reference implementation, when using the base stratum, the returned string is the unqualified name of the source file containing the declaration of this type. In other strata the returned source name is the first source name for that stratum. Since other languages may have more than one source name for a reference type, the use of Location#sourceName() or sourceNames(String) is preferred.

For arrays (ArrayType) and primitive classes, AbsentInformationException is always thrown.

Returns:String

the string source file name

Exceptions

AbsentInformationException:: if the source name is not known

sourceNames back to summary

sourceNames	back to summary
public List<String> sourceNames(String stratum) throws AbsentInformationException Gets the identifying names for all the source corresponding to the declaration of this type. Interpretation of these names is the responsibility of the source repository mechanism. The returned names are for the specified stratum (see `Location` for a description of strata). In the reference implementation, when using the Java programming language stratum, the returned List contains one element: a String which is the unqualified name of the source file containing the declaration of this type. In other strata the returned source names are all the source names defined for that stratum. Parameters stratum:String The stratum to retrieve information from or `null` for the declaring type's default stratum. Returns:List<String> a List of String objects each representing a source name Exceptions AbsentInformationException: if the source names are not known. For arrays (`ArrayType`) and primitive classes, AbsentInformationException is always thrown. Since 1.4

public List<String> sourceNames(String stratum) throws AbsentInformationException

Gets the identifying names for all the source corresponding to the declaration of this type. Interpretation of these names is the responsibility of the source repository mechanism.

The returned names are for the specified stratum (see Location for a description of strata). In the reference implementation, when using the Java programming language stratum, the returned List contains one element: a String which is the unqualified name of the source file containing the declaration of this type. In other strata the returned source names are all the source names defined for that stratum.

Parameters

stratum:String: The stratum to retrieve information from or null for the declaring type's default stratum.

Returns:List<String>

a List of String objects each representing a source name

Exceptions

AbsentInformationException:: if the source names are not known.
For arrays (ArrayType) and primitive classes, AbsentInformationException is always thrown.

Since

1.4

sourcePaths back to summary

sourcePaths	back to summary
public List<String> sourcePaths(String stratum) throws AbsentInformationException Gets the paths to the source corresponding to the declaration of this type. Interpretation of these paths is the responsibility of the source repository mechanism. The returned paths are for the specified stratum (see `Location` for a description of strata). In the reference implementation, for strata which do not explicitly specify source path (the Java programming language stratum never does), the returned strings are the `sourceNames(String)` prefixed by the package name of this ReferenceType converted to a platform dependent path. For example, on a Windows platform, `java.lang.Thread` would return a List containing one element: `"java\lang\Thread.java"`. Parameters stratum:String The stratum to retrieve information from or `null` for the declaring type's default stratum. Returns:List<String> a List of String objects each representing a source path Exceptions AbsentInformationException: if the source names are not known. For arrays (`ArrayType`) and primitive classes, AbsentInformationException is always thrown. Since 1.4

public List<String> sourcePaths(String stratum) throws AbsentInformationException

Gets the paths to the source corresponding to the declaration of this type. Interpretation of these paths is the responsibility of the source repository mechanism.

The returned paths are for the specified stratum (see Location for a description of strata). In the reference implementation, for strata which do not explicitly specify source path (the Java programming language stratum never does), the returned strings are the sourceNames(String) prefixed by the package name of this ReferenceType converted to a platform dependent path. For example, on a Windows platform, java.lang.Thread would return a List containing one element: "java\lang\Thread.java".

Parameters

stratum:String: The stratum to retrieve information from or null for the declaring type's default stratum.

Returns:List<String>

a List of String objects each representing a source path

Exceptions

AbsentInformationException:: if the source names are not known.
For arrays (ArrayType) and primitive classes, AbsentInformationException is always thrown.

Since

1.4

visibleFields back to summary

visibleFields	back to summary
public List<Field> visibleFields() Returns a list containing each unhidden and unambiguous `Field` in this type. Each field that can be accessed from the class or its instances with its simple name is included. Fields that are ambiguously multiply inherited or fields that are hidden by fields with the same name in a more recently inherited class cannot be accessed by their simple names and are not included in the returned list. All other inherited fields are included. See JLS section 8.3 for details. For arrays (`ArrayType`) and primitive classes, the returned list is always empty. Returns:List<Field> a List of `Field` objects; the list has length 0 if no visible fields exist. Exceptions ClassNotPreparedException: if this class not yet been prepared.

public List<Field> visibleFields()

Returns a list containing each unhidden and unambiguous Field in this type. Each field that can be accessed from the class or its instances with its simple name is included. Fields that are ambiguously multiply inherited or fields that are hidden by fields with the same name in a more recently inherited class cannot be accessed by their simple names and are not included in the returned list. All other inherited fields are included. See JLS section 8.3 for details.

For arrays (ArrayType) and primitive classes, the returned list is always empty.

Returns:List<Field>

a List of Field objects; the list has length 0 if no visible fields exist.

Exceptions

ClassNotPreparedException:: if this class not yet been prepared.

visibleMethods back to summary

visibleMethods	back to summary
public List<Method> visibleMethods() Returns a list containing each `Method` declared or inherited by this type. Methods from superclasses or superinterfaces that have been hidden or overridden are not included. Note that despite this exclusion, multiple inherited methods with the same signature can be present in the returned list, but at most one can be a member of a `ClassType`. See JLS section 8.4.8 for details. For arrays (`ArrayType`) and primitive classes, the returned list is always empty. Returns:List<Method> a List of `Method` objects; the list has length 0 if no visible methods exist. Exceptions ClassNotPreparedException: if this class not yet been prepared.

public List<Method> visibleMethods()

Returns a list containing each Method declared or inherited by this type. Methods from superclasses or superinterfaces that have been hidden or overridden are not included.

Note that despite this exclusion, multiple inherited methods with the same signature can be present in the returned list, but at most one can be a member of a ClassType. See JLS section 8.4.8 for details.

For arrays (ArrayType) and primitive classes, the returned list is always empty.

Returns:List<Method>

a List of Method objects; the list has length 0 if no visible methods exist.

Exceptions

ClassNotPreparedException:: if this class not yet been prepared.

public Interface ReferenceType

Method Summary

Method Detail