public class

FieldImpl

extends TypeComponentImpl
implements Field
java.lang.Object
   ↳ com.sun.tools.jdi.TypeComponentImpl
     ↳ com.sun.tools.jdi.FieldImpl

Summary

[Expand]
Inherited Fields
From class com.sun.tools.jdi.TypeComponentImpl
Public Methods
int compareTo(Field field)
boolean equals(Object obj)
Indicates whether some other object is "equal to" this one.
Type findType(String signature)
int hashCode()
Returns a hash code value for the object.
boolean isEnumConstant()
Determine if this is a field that represents an enum constant.
boolean isTransient()
Determine if this is a transient field.
boolean isVolatile()
Determine if this is a volatile field.
abstract String signature()
Gets the JNI-style signature for this type component.
String toString()
Returns a string representation of the object.
Type type()
Returns the type of this field.
String typeName()
Returns a text representation of the type of this field.
[Expand]
Inherited Methods
From class com.sun.tools.jdi.TypeComponentImpl
From class java.lang.Object
From interface com.sun.jdi.Accessible
From interface com.sun.jdi.Field
From interface com.sun.jdi.Mirror
From interface com.sun.jdi.TypeComponent
From interface java.lang.Comparable

Public Methods

public int compareTo (Field field)

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 Type findType (String 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 isEnumConstant ()

Determine if this is a field that represents an enum constant.

Returns
  • true if this field represents an enum constant; false otherwise.

public boolean isTransient ()

Determine if this is a transient field.

Returns
  • true if this field is transient; false otherwise.

public boolean isVolatile ()

Determine if this is a volatile field.

Returns
  • true if this field is volatile; false otherwise.

public abstract 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 String toString ()

Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.

The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:

 getClass().getName() + '@' + Integer.toHexString(hashCode())
 

Returns
  • a string representation of the object.

public Type type ()

Returns the type of this field. Where the type is the type specified in the declaration of this field.

For example, if a target class defines:

    short s;
    Date d;
    byte[] ba;
And the JDI client defines these Field objects:
    Field sField = targetClass.fieldByName("s");
    Field dField = targetClass.fieldByName("d");
    Field baField = targetClass.fieldByName("ba");
to mirror the corresponding fields, then sField.type() is a ShortType, dField.type() is the ReferenceType for java.util.Date and ((ArrayType)(baField.type())).componentType() is a ByteType.

Note: if the type of this field 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 isPrepared() to determine if a reference type is prepared.

Returns
  • the Type of this field.

public String typeName ()

Returns a text representation of the type of this field. Where the type is the type specified in the declaration of this field.

This type name is always available even if the type has not yet been created or loaded.

Returns
  • a text representation of the declared type of this field.