public interface

Field

implements TypeComponent Comparable<T>
com.sun.jdi.Field
Known Indirect Subclasses

Class Overview

A class or instance variable in the target VM. See TypeComponent for general information about Field and Method mirrors.

See Also

Summary

Public Methods
abstract boolean equals(Object obj)
Compares the specified Object with this field for equality.
abstract int hashCode()
Returns the hash code value for this Field.
abstract boolean isEnumConstant()
Determine if this is a field that represents an enum constant.
abstract boolean isTransient()
Determine if this is a transient field.
abstract boolean isVolatile()
Determine if this is a volatile field.
abstract Type type()
Returns the type of this field.
abstract String typeName()
Returns a text representation of the type of this field.
[Expand]
Inherited Methods
From interface com.sun.jdi.Accessible
From interface com.sun.jdi.Mirror
From interface com.sun.jdi.TypeComponent
From interface java.lang.Comparable

Public Methods

public abstract boolean equals (Object obj)

Compares the specified Object with this field for equality.

Parameters
obj the reference object with which to compare.
Returns
  • true if the Object is a Field and if both mirror the same field (declared in the same class or interface, in the same VM).

public abstract int hashCode ()

Returns the hash code value for this Field.

Returns
  • the integer hash code

public abstract 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 abstract boolean isTransient ()

Determine if this is a transient field.

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

public abstract boolean isVolatile ()

Determine if this is a volatile field.

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

public abstract 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.
Throws
ClassNotLoadedException if the type has not yet been loaded or created through the appropriate class loader.
See Also

public abstract 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 String representing the type of this field.