public abstract class

TypeComponentImpl

extends Object
implements Mirror TypeComponent
java.lang.Object
   ↳ com.sun.tools.jdi.TypeComponentImpl
Known Direct Subclasses
Known Indirect Subclasses

Summary

Fields
protected final ReferenceTypeImpl declaringType
protected final String genericSignature
protected final String name
protected final long ref
protected final String signature
protected VirtualMachineImpl vm
Public Methods
ReferenceType declaringType()
Returns the type in which this component was declared.
boolean equals(Object obj)
Indicates whether some other object is "equal to" this one.
String genericSignature()
Gets the generic signature for this TypeComponent if there is one.
int hashCode()
Returns a hash code value for the object.
boolean isFinal()
Determines if this TypeComponent is final.
boolean isPackagePrivate()
Determines if this object mirrors a package private item.
boolean isPrivate()
Determines if this object mirrors a private item.
boolean isProtected()
Determines if this object mirrors a protected item.
boolean isPublic()
Determines if this object mirrors a public item.
boolean isStatic()
Determines if this TypeComponent is static.
boolean isSynthetic()
Determines if this TypeComponent is synthetic.
int modifiers()
Returns the JavaTM programming language modifiers, encoded in an integer.
String name()
Gets the name of this type component.
String signature()
Gets the JNI-style signature for this type component.
VirtualMachine virtualMachine()
Gets the VirtualMachine to which this Mirror belongs.
[Expand]
Inherited Methods
From class java.lang.Object
From interface com.sun.jdi.Accessible
From interface com.sun.jdi.Mirror
From interface com.sun.jdi.TypeComponent

Fields

protected final ReferenceTypeImpl declaringType

protected final String genericSignature

protected final String name

protected final long ref

protected final String signature

protected VirtualMachineImpl vm

Public Methods

public ReferenceType declaringType ()

Returns the type in which this component was declared. The returned ReferenceType mirrors either a class or an interface in the target VM.

Returns

public boolean equals (Object obj)

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any non-null reference values x and y, this method returns true if and only if x and y refer to the same object (x == y has the value true).

Note that it is generally necessary to override the hashCode method whenever this method is overridden, so as to maintain the general contract for the hashCode method, which states that equal objects must have equal hash codes.

Parameters
obj the reference object with which to compare.
Returns
  • true if this object is the same as the obj argument; false otherwise.

public String genericSignature ()

Gets the generic signature for this TypeComponent if there is one. Generic signatures are described in the "JavaTM Virtual Machine Specification, 3rd Edition.

Returns
  • a string containing the generic signature, or null if there is no generic signature.

public int hashCode ()

Returns a hash code value for the object. This method is supported for the benefit of hashtables such as those provided by java.util.Hashtable.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals(Object) method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals(java.lang.Object) method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hashtables.

As much as is reasonably practical, the hashCode method defined by class Object does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the JavaTM programming language.)

Returns
  • a hash code value for this object.

public boolean isFinal ()

Determines if this TypeComponent is final. Return value is undefined for constructors and static initializers.

Returns
  • true if this type component was declared final; false otherwise.

public boolean isPackagePrivate ()

Determines if this object mirrors a package private item. A package private item is declared with no access specifier. For ArrayType, the return value depends on the array component type. For primitive arrays the return value is always false. For object arrays, the return value is the same as would be returned for the component type. For primitive classes, such as TYPE, the return value is always false.

Returns
  • true for items with package private access; false otherwise.

public boolean isPrivate ()

Determines if this object mirrors a private item. For ArrayType, the return value depends on the array component type. For primitive arrays the return value is always false. For object arrays, the return value is the same as would be returned for the component type. For primitive classes, such as TYPE, the return value is always false.

Returns
  • true for items with private access; false otherwise.

public boolean isProtected ()

Determines if this object mirrors a protected item. For ArrayType, the return value depends on the array component type. For primitive arrays the return value is always false. For object arrays, the return value is the same as would be returned for the component type. For primitive classes, such as TYPE, the return value is always false.

Returns
  • true for items with private access; false otherwise.

public boolean isPublic ()

Determines if this object mirrors a public item. For ArrayType, the return value depends on the array component type. For primitive arrays the return value is always true. For object arrays, the return value is the same as would be returned for the component type. For primitive classes, such as TYPE, the return value is always true.

Returns
  • true for items with public access; false otherwise.

public boolean isStatic ()

Determines if this TypeComponent is static. Return value is undefined for constructors and static initializers.

Returns
  • true if this type component was declared static; false otherwise.

public boolean isSynthetic ()

Determines if this TypeComponent is synthetic. Synthetic members are generated by the compiler and are not present in the source code for the containing class.

Not all target VMs support this query. See canGetSyntheticAttribute() to determine if the operation is supported.

Returns
  • true if this type component is synthetic; false otherwise.

public int modifiers ()

Returns the JavaTM programming language modifiers, encoded in an integer.

The modifier encodings are defined in the Java Virtual Machine Specification, in the access_flag tables for classes, fields, and methods.

public String name ()

Gets the name of this type component.

Note: for fields, this is the field name; for methods, this is the method name; for constructors, this is <init>; for static initializers, this is <clinit>.

Returns
  • a string containing the name.

public String signature ()

Gets the JNI-style signature for this type component. The signature is encoded type information as defined in the JNI documentation. It is a convenient, compact format for for manipulating type information internally, not necessarily for display to an end user. See typeName() and returnTypeName() for ways to help get a more readable representation of the type.

Returns
  • a string containing the signature

public VirtualMachine virtualMachine ()

Gets the VirtualMachine to which this Mirror belongs. A Mirror must be associated with a VirtualMachine to have any meaning.

Returns