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

Method Summary

Modifier and Type	Method and Description
public boolean	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). equals(Object obj) Compares the specified Object with this field for equality.
public int	Returns: the integer hash code. hashCode() Returns the hash code value for this Field.
public boolean	Returns: `true` if this field represents an enum constant; `false` otherwise. isEnumConstant() Determine if this is a field that represents an enum constant.
public boolean	Returns: `true` if this field is transient; `false` otherwise. isTransient() Determine if this is a transient field.
public boolean	Returns: `true` if this field is volatile; `false` otherwise. isVolatile() Determine if this is a volatile field.
public Type	Returns: the `Type` of this field. type() Returns the type of this field.
public String	Returns: a String representing the type of this field. typeName() Returns a text representation of the type of this field.

Inherited from com.sun.jdi.TypeComponent:: declaringType genericSignature isFinal isStatic isSynthetic name signature
Inherited from java.lang.Comparable:: compareTo

Method Detail

equals back to summary

equals	back to summary
public boolean equals(Object obj) Compares the specified Object with this field for equality. Returns:boolean `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 boolean equals(Object obj)

Compares the specified Object with this field for equality.

Returns:boolean: 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).

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

hashCode

back to summary

public int hashCode()

Returns the hash code value for this Field.

Returns:int: the integer hash code.

isEnumConstant back to summary

isEnumConstant	back to summary
public boolean isEnumConstant() Determine if this is a field that represents an enum constant. Returns:boolean `true` if this field represents an enum constant; `false` otherwise.

public boolean isEnumConstant()

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

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

isTransient back to summary

isTransient	back to summary
public boolean isTransient() Determine if this is a transient field. Returns:boolean `true` if this field is transient; `false` otherwise.

public boolean isTransient()

Determine if this is a transient field.

Returns:boolean: true if this field is transient; false otherwise.

isVolatile back to summary

isVolatile	back to summary
public boolean isVolatile() Determine if this is a volatile field. Returns:boolean `true` if this field is volatile; `false` otherwise.

public boolean isVolatile()

Determine if this is a volatile field.

Returns:boolean: true if this field is volatile; false otherwise.

type back to summary

type	back to summary
public Type type() throws ClassNotLoadedException 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 `ReferenceType#isPrepared()` to determine if a reference type is prepared. Returns:Type the `Type` of this field. Exceptions ClassNotLoadedException: if the type has not yet been loaded or created through the appropriate class loader. See Also `Type`

public Type type() throws ClassNotLoadedException

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 ReferenceType#isPrepared() to determine if a reference type is prepared.

Returns:Type

the Type of this field.

Exceptions

ClassNotLoadedException:: if the type has not yet been loaded or created through the appropriate class loader.

See Also

Type

typeName	back to summary
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:String a String representing the type of this field.

typeName

back to summary

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

public Interface Field

Method Summary

Method Detail