Field
class Field : AccessibleObject, Member
kotlin.Any | ||
↳ | java.lang.reflect.AccessibleObject | |
↳ | java.lang.reflect.Field |
A Field
provides information about, and dynamic access to, a single field of a class or an interface. The reflected field may be a class (static) field or an instance field.
A Field
permits widening conversions to occur during a get or set access operation, but throws an IllegalArgumentException
if a narrowing conversion would occur.
Summary
Inherited constants | |
---|---|
Public methods | |
---|---|
Boolean |
Compares this |
Any? |
Returns the value of the field represented by this |
T? |
getAnnotation(annotationClass: Class<T>) |
Array<T>! |
getAnnotationsByType(annotationClass: Class<T>) Returns annotations that are associated with this element. |
Boolean |
getBoolean(obj: Any?) Gets the value of a static or instance |
Byte |
Gets the value of a static or instance |
Char |
Gets the value of a static or instance field of type |
Array<Annotation!> |
Returns annotations that are directly present on this element. |
Class<*> |
Returns the |
Double |
Gets the value of a static or instance field of type |
Float |
Gets the value of a static or instance field of type |
Type |
Returns a |
Int |
Gets the value of a static or instance field of type |
Long |
Gets the value of a static or instance field of type |
Int |
Returns the Java language modifiers for the field represented by this |
String |
getName() Returns the name of the field represented by this |
Short |
Gets the value of a static or instance field of type |
Class<*> |
getType() Returns a |
Int |
hashCode() Returns a hashcode for this |
Boolean |
isAnnotationPresent(annotationType: Class<out Annotation!>) |
Boolean |
Returns |
Boolean |
Returns |
Unit |
Sets the field represented by this |
Unit |
setBoolean(obj: Any?, z: Boolean) Sets the value of a field as a |
Unit |
Sets the value of a field as a |
Unit |
Sets the value of a field as a |
Unit |
Sets the value of a field as a |
Unit |
Sets the value of a field as a |
Unit |
Sets the value of a field as an |
Unit |
Sets the value of a field as a |
Unit |
Sets the value of a field as a |
String |
Returns a string describing this |
String |
toString() Returns a string describing this |
Inherited functions | |
---|---|
Public methods
equals
fun equals(other: Any?): Boolean
Compares this Field
against the specified object. Returns true if the objects are the same. Two Field
objects are the same if they were declared by the same class and have the same name and type.
Parameters | |
---|---|
obj |
the reference object with which to compare. |
Return | |
---|---|
Boolean |
true if this object is the same as the obj argument; false otherwise. |
get
fun get(obj: Any?): Any?
Returns the value of the field represented by this Field
, on the specified object. The value is automatically wrapped in an object if it has a primitive type.
The underlying field's value is obtained as follows:
If the underlying field is a static field, the obj
argument is ignored; it may be null.
Otherwise, the underlying field is an instance field. If the specified obj
argument is null, the method throws a NullPointerException
. If the specified object is not an instance of the class or interface declaring the underlying field, the method throws an IllegalArgumentException
.
If this Field
object is enforcing Java language access control, and the underlying field is inaccessible, the method throws an IllegalAccessException
. If the underlying field is static, the class that declared the field is initialized if it has not already been initialized.
Otherwise, the value is retrieved from the underlying instance or static field. If the field has a primitive type, the value is wrapped in an object before being returned, otherwise it is returned as is.
If the field is hidden in the type of obj
, the field's value is obtained according to the preceding rules.
Parameters | |
---|---|
obj |
Any?: object from which the represented field's value is to be extracted |
Return | |
---|---|
Any? |
the value of the represented field in object obj ; primitive values are wrapped in an appropriate object before being returned |
Exceptions | |
---|---|
java.lang.IllegalAccessException |
if this Field object is enforcing Java language access control and the underlying field is inaccessible. |
java.lang.IllegalArgumentException |
if the specified object is not an instance of the class or interface declaring the underlying field (or a subclass or implementor thereof). |
java.lang.NullPointerException |
if the specified object is null and the field is an instance field. |
java.lang.ExceptionInInitializerError |
if the initialization provoked by this method fails. |
getAnnotation
fun <T : Annotation!> getAnnotation(annotationClass: Class<T>): T?
Parameters | |
---|---|
<T> |
the type of the annotation to query for and return if present |
annotationClass |
Class<T>: the Class object corresponding to the annotation type |
Return | |
---|---|
T? |
this element's annotation for the specified annotation type if present on this element, else null |
Exceptions | |
---|---|
java.lang.NullPointerException |
if the given annotation class is null |
getAnnotationsByType
fun <T : Annotation!> getAnnotationsByType(annotationClass: Class<T>): Array<T>!
Returns annotations that are associated with this element. If there are no annotations associated with this element, the return value is an array of length 0. The difference between this method and getAnnotation(java.lang.Class)
is that this method detects if its argument is a repeatable annotation type (JLS 9.6), and if so, attempts to find one or more annotations of that type by "looking through" a container annotation. The caller of this method is free to modify the returned array; it will have no effect on the arrays returned to other callers.
Parameters | |
---|---|
<T> |
the type of the annotation to query for and return if present |
annotationClass |
Class<T>: the Class object corresponding to the annotation type |
Return | |
---|---|
Array<T>! |
all this element's annotations for the specified annotation type if associated with this element, else an array of length zero |
Exceptions | |
---|---|
java.lang.NullPointerException |
if the given annotation class is null |
getBoolean
fun getBoolean(obj: Any?): Boolean
Gets the value of a static or instance boolean
field.
Parameters | |
---|---|
obj |
Any?: the object to extract the boolean value from |
Return | |
---|---|
Boolean |
the value of the boolean field |
Exceptions | |
---|---|
java.lang.IllegalAccessException |
if this Field object is enforcing Java language access control and the underlying field is inaccessible. |
java.lang.IllegalArgumentException |
if the specified object is not an instance of the class or interface declaring the underlying field (or a subclass or implementor thereof), or if the field value cannot be converted to the type boolean by a widening conversion. |
java.lang.NullPointerException |
if the specified object is null and the field is an instance field. |
java.lang.ExceptionInInitializerError |
if the initialization provoked by this method fails. |
See Also
getByte
fun getByte(obj: Any?): Byte
Gets the value of a static or instance byte
field.
Parameters | |
---|---|
obj |
Any?: the object to extract the byte value from |
Return | |
---|---|
Byte |
the value of the byte field |
Exceptions | |
---|---|
java.lang.IllegalAccessException |
if this Field object is enforcing Java language access control and the underlying field is inaccessible. |
java.lang.IllegalArgumentException |
if the specified object is not an instance of the class or interface declaring the underlying field (or a subclass or implementor thereof), or if the field value cannot be converted to the type byte by a widening conversion. |
java.lang.NullPointerException |
if the specified object is null and the field is an instance field. |
java.lang.ExceptionInInitializerError |
if the initialization provoked by this method fails. |
See Also
getChar
fun getChar(obj: Any?): Char
Gets the value of a static or instance field of type char
or of another primitive type convertible to type char
via a widening conversion.
Parameters | |
---|---|
obj |
Any?: the object to extract the char value from |
Return | |
---|---|
Char |
the value of the field converted to type char |
Exceptions | |
---|---|
java.lang.IllegalAccessException |
if this Field object is enforcing Java language access control and the underlying field is inaccessible. |
java.lang.IllegalArgumentException |
if the specified object is not an instance of the class or interface declaring the underlying field (or a subclass or implementor thereof), or if the field value cannot be converted to the type char by a widening conversion. |
java.lang.NullPointerException |
if the specified object is null and the field is an instance field. |
java.lang.ExceptionInInitializerError |
if the initialization provoked by this method fails. |
See Also
getDeclaredAnnotations
fun getDeclaredAnnotations(): Array<Annotation!>
Returns annotations that are directly present on this element. This method ignores inherited annotations. If there are no annotations directly present on this element, the return value is an array of length 0. The caller of this method is free to modify the returned array; it will have no effect on the arrays returned to other callers.
Return | |
---|---|
Array<Annotation!> |
annotations directly present on this element |
getDeclaringClass
fun getDeclaringClass(): Class<*>
Returns the Class
object representing the class or interface that declares the field represented by this Field
object.
Return | |
---|---|
Class<*> |
an object representing the declaring class of the underlying member |
getDouble
fun getDouble(obj: Any?): Double
Gets the value of a static or instance field of type double
or of another primitive type convertible to type double
via a widening conversion.
Parameters | |
---|---|
obj |
Any?: the object to extract the double value from |
Return | |
---|---|
Double |
the value of the field converted to type double |
Exceptions | |
---|---|
java.lang.IllegalAccessException |
if this Field object is enforcing Java language access control and the underlying field is inaccessible. |
java.lang.IllegalArgumentException |
if the specified object is not an instance of the class or interface declaring the underlying field (or a subclass or implementor thereof), or if the field value cannot be converted to the type double by a widening conversion. |
java.lang.NullPointerException |
if the specified object is null and the field is an instance field. |
java.lang.ExceptionInInitializerError |
if the initialization provoked by this method fails. |
See Also
getFloat
fun getFloat(obj: Any?): Float
Gets the value of a static or instance field of type float
or of another primitive type convertible to type float
via a widening conversion.
Parameters | |
---|---|
obj |
Any?: the object to extract the float value from |
Return | |
---|---|
Float |
the value of the field converted to type float |
Exceptions | |
---|---|
java.lang.IllegalAccessException |
if this Field object is enforcing Java language access control and the underlying field is inaccessible. |
java.lang.IllegalArgumentException |
if the specified object is not an instance of the class or interface declaring the underlying field (or a subclass or implementor thereof), or if the field value cannot be converted to the type float by a widening conversion. |
java.lang.NullPointerException |
if the specified object is null and the field is an instance field. |
java.lang.ExceptionInInitializerError |
if the initialization provoked by this method fails. |
See Also
getGenericType
fun getGenericType(): Type
Returns a Type
object that represents the declared type for the field represented by this Field
object.
If the Type
is a parameterized type, the Type
object returned must accurately reflect the actual type parameters used in the source code.
If the type of the underlying field is a type variable or a parameterized type, it is created. Otherwise, it is resolved.
Return | |
---|---|
Type |
a Type object that represents the declared type for the field represented by this Field object |
Exceptions | |
---|---|
java.lang.reflect.GenericSignatureFormatError |
if the generic field signature does not conform to the format specified in The Java™ Virtual Machine Specification |
java.lang.TypeNotPresentException |
if the generic type signature of the underlying field refers to a non-existent type declaration |
java.lang.reflect.MalformedParameterizedTypeException |
if the generic signature of the underlying field refers to a parameterized type that cannot be instantiated for any reason |
getInt
fun getInt(obj: Any?): Int
Gets the value of a static or instance field of type int
or of another primitive type convertible to type int
via a widening conversion.
Parameters | |
---|---|
obj |
Any?: the object to extract the int value from |
Return | |
---|---|
Int |
the value of the field converted to type int |
Exceptions | |
---|---|
java.lang.IllegalAccessException |
if this Field object is enforcing Java language access control and the underlying field is inaccessible. |
java.lang.IllegalArgumentException |
if the specified object is not an instance of the class or interface declaring the underlying field (or a subclass or implementor thereof), or if the field value cannot be converted to the type int by a widening conversion. |
java.lang.NullPointerException |
if the specified object is null and the field is an instance field. |
java.lang.ExceptionInInitializerError |
if the initialization provoked by this method fails. |
See Also
getLong
fun getLong(obj: Any?): Long
Gets the value of a static or instance field of type long
or of another primitive type convertible to type long
via a widening conversion.
Parameters | |
---|---|
obj |
Any?: the object to extract the long value from |
Return | |
---|---|
Long |
the value of the field converted to type long |
Exceptions | |
---|---|
java.lang.IllegalAccessException |
if this Field object is enforcing Java language access control and the underlying field is inaccessible. |
java.lang.IllegalArgumentException |
if the specified object is not an instance of the class or interface declaring the underlying field (or a subclass or implementor thereof), or if the field value cannot be converted to the type long by a widening conversion. |
java.lang.NullPointerException |
if the specified object is null and the field is an instance field. |
java.lang.ExceptionInInitializerError |
if the initialization provoked by this method fails. |
See Also
getModifiers
fun getModifiers(): Int
Returns the Java language modifiers for the field represented by this Field
object, as an integer. The Modifier
class should be used to decode the modifiers.
Return | |
---|---|
Int |
the Java language modifiers for the underlying member |
See Also
getName
fun getName(): String
Returns the name of the field represented by this Field
object.
Return | |
---|---|
String |
the simple name of the underlying member |
getShort
fun getShort(obj: Any?): Short
Gets the value of a static or instance field of type short
or of another primitive type convertible to type short
via a widening conversion.
Parameters | |
---|---|
obj |
Any?: the object to extract the short value from |
Return | |
---|---|
Short |
the value of the field converted to type short |
Exceptions | |
---|---|
java.lang.IllegalAccessException |
if this Field object is enforcing Java language access control and the underlying field is inaccessible. |
java.lang.IllegalArgumentException |
if the specified object is not an instance of the class or interface declaring the underlying field (or a subclass or implementor thereof), or if the field value cannot be converted to the type short by a widening conversion. |
java.lang.NullPointerException |
if the specified object is null and the field is an instance field. |
java.lang.ExceptionInInitializerError |
if the initialization provoked by this method fails. |
See Also
getType
fun getType(): Class<*>
Returns a Class
object that identifies the declared type for the field represented by this Field
object.
Return | |
---|---|
Class<*> |
a Class object identifying the declared type of the field represented by this object |
hashCode
fun hashCode(): Int
Returns a hashcode for this Field
. This is computed as the exclusive-or of the hashcodes for the underlying field's declaring class name and its name.
Return | |
---|---|
Int |
a hash code value for this object. |
isAnnotationPresent
fun isAnnotationPresent(annotationType: Class<out Annotation!>): Boolean
Parameters | |
---|---|
annotationClass |
the Class object corresponding to the annotation type |
Return | |
---|---|
Boolean |
true if an annotation for the specified annotation type is present on this element, else false |
Exceptions | |
---|---|
java.lang.NullPointerException |
if the given annotation class is null |
isEnumConstant
fun isEnumConstant(): Boolean
Returns true
if this field represents an element of an enumerated type; returns false
otherwise.
Return | |
---|---|
Boolean |
true if and only if this field represents an element of an enumerated type. |
isSynthetic
fun isSynthetic(): Boolean
Returns true
if this field is a synthetic field; returns false
otherwise.
Return | |
---|---|
Boolean |
true if and only if this field is a synthetic field as defined by the Java Language Specification. |
set
fun set(
obj: Any?,
value: Any?
): Unit
Sets the field represented by this Field
object on the specified object argument to the specified new value. The new value is automatically unwrapped if the underlying field has a primitive type.
The operation proceeds as follows:
If the underlying field is static, the obj
argument is ignored; it may be null.
Otherwise the underlying field is an instance field. If the specified object argument is null, the method throws a NullPointerException
. If the specified object argument is not an instance of the class or interface declaring the underlying field, the method throws an IllegalArgumentException
.
If this Field
object is enforcing Java language access control, and the underlying field is inaccessible, the method throws an IllegalAccessException
.
If the underlying field is final, this Field
object has write access if and only if the following conditions are met:
setAccessible(true)
has succeeded for thisField
object;- the field is non-static; and
- the field's declaring class is not a record class.
IllegalAccessException
.
Setting a final field in this way is meaningful only during deserialization or reconstruction of instances of classes with blank final fields, before they are made available for access by other parts of a program. Use in any other context may have unpredictable effects, including cases in which other parts of a program continue to use the original value of this field.
If the underlying field is of a primitive type, an unwrapping conversion is attempted to convert the new value to a value of a primitive type. If this attempt fails, the method throws an IllegalArgumentException
.
If, after possible unwrapping, the new value cannot be converted to the type of the underlying field by an identity or widening conversion, the method throws an IllegalArgumentException
.
If the underlying field is static, the class that declared the field is initialized if it has not already been initialized.
The field is set to the possibly unwrapped and widened new value.
If the field is hidden in the type of obj
, the field's value is set according to the preceding rules.
Parameters | |
---|---|
obj |
Any?: the object whose field should be modified |
value |
Any?: the new value for the field of obj being modified |
Exceptions | |
---|---|
java.lang.IllegalAccessException |
if this Field object is enforcing Java language access control and the underlying field is either inaccessible or final. |
java.lang.IllegalArgumentException |
if the specified object is not an instance of the class or interface declaring the underlying field (or a subclass or implementor thereof), or if an unwrapping conversion fails. |
java.lang.NullPointerException |
if the specified object is null and the field is an instance field. |
java.lang.ExceptionInInitializerError |
if the initialization provoked by this method fails. |
setBoolean
fun setBoolean(
obj: Any?,
z: Boolean
): Unit
Sets the value of a field as a boolean
on the specified object. This method is equivalent to set(obj, zObj)
, where zObj
is a Boolean
object and zObj.booleanValue() == z
.
Parameters | |
---|---|
obj |
Any?: the object whose field should be modified |
z |
Boolean: the new value for the field of obj being modified |
Exceptions | |
---|---|
java.lang.IllegalAccessException |
if this Field object is enforcing Java language access control and the underlying field is either inaccessible or final. |
java.lang.IllegalArgumentException |
if the specified object is not an instance of the class or interface declaring the underlying field (or a subclass or implementor thereof), or if an unwrapping conversion fails. |
java.lang.NullPointerException |
if the specified object is null and the field is an instance field. |
java.lang.ExceptionInInitializerError |
if the initialization provoked by this method fails. |
See Also
setByte
fun setByte(
obj: Any?,
b: Byte
): Unit
Sets the value of a field as a byte
on the specified object. This method is equivalent to set(obj, bObj)
, where bObj
is a Byte
object and bObj.byteValue() == b
.
Parameters | |
---|---|
obj |
Any?: the object whose field should be modified |
b |
Byte: the new value for the field of obj being modified |
Exceptions | |
---|---|
java.lang.IllegalAccessException |
if this Field object is enforcing Java language access control and the underlying field is either inaccessible or final. |
java.lang.IllegalArgumentException |
if the specified object is not an instance of the class or interface declaring the underlying field (or a subclass or implementor thereof), or if an unwrapping conversion fails. |
java.lang.NullPointerException |
if the specified object is null and the field is an instance field. |
java.lang.ExceptionInInitializerError |
if the initialization provoked by this method fails. |
See Also
setChar
fun setChar(
obj: Any?,
c: Char
): Unit
Sets the value of a field as a char
on the specified object. This method is equivalent to set(obj, cObj)
, where cObj
is a Character
object and cObj.charValue() == c
.
Parameters | |
---|---|
obj |
Any?: the object whose field should be modified |
c |
Char: the new value for the field of obj being modified |
Exceptions | |
---|---|
java.lang.IllegalAccessException |
if this Field object is enforcing Java language access control and the underlying field is either inaccessible or final. |
java.lang.IllegalArgumentException |
if the specified object is not an instance of the class or interface declaring the underlying field (or a subclass or implementor thereof), or if an unwrapping conversion fails. |
java.lang.NullPointerException |
if the specified object is null and the field is an instance field. |
java.lang.ExceptionInInitializerError |
if the initialization provoked by this method fails. |
See Also
setDouble
fun setDouble(
obj: Any?,
d: Double
): Unit
Sets the value of a field as a double
on the specified object. This method is equivalent to set(obj, dObj)
, where dObj
is a Double
object and dObj.doubleValue() == d
.
Parameters | |
---|---|
obj |
Any?: the object whose field should be modified |
d |
Double: the new value for the field of obj being modified |
Exceptions | |
---|---|
java.lang.IllegalAccessException |
if this Field object is enforcing Java language access control and the underlying field is either inaccessible or final. |
java.lang.IllegalArgumentException |
if the specified object is not an instance of the class or interface declaring the underlying field (or a subclass or implementor thereof), or if an unwrapping conversion fails. |
java.lang.NullPointerException |
if the specified object is null and the field is an instance field. |
java.lang.ExceptionInInitializerError |
if the initialization provoked by this method fails. |
See Also
setFloat
fun setFloat(
obj: Any?,
f: Float
): Unit
Sets the value of a field as a float
on the specified object. This method is equivalent to set(obj, fObj)
, where fObj
is a Float
object and fObj.floatValue() == f
.
Parameters | |
---|---|
obj |
Any?: the object whose field should be modified |
f |
Float: the new value for the field of obj being modified |
Exceptions | |
---|---|
java.lang.IllegalAccessException |
if this Field object is enforcing Java language access control and the underlying field is either inaccessible or final. |
java.lang.IllegalArgumentException |
if the specified object is not an instance of the class or interface declaring the underlying field (or a subclass or implementor thereof), or if an unwrapping conversion fails. |
java.lang.NullPointerException |
if the specified object is null and the field is an instance field. |
java.lang.ExceptionInInitializerError |
if the initialization provoked by this method fails. |
See Also
setInt
fun setInt(
obj: Any?,
i: Int
): Unit
Sets the value of a field as an int
on the specified object. This method is equivalent to set(obj, iObj)
, where iObj
is a Integer
object and iObj.intValue() == i
.
Parameters | |
---|---|
obj |
Any?: the object whose field should be modified |
i |
Int: the new value for the field of obj being modified |
Exceptions | |
---|---|
java.lang.IllegalAccessException |
if this Field object is enforcing Java language access control and the underlying field is either inaccessible or final. |
java.lang.IllegalArgumentException |
if the specified object is not an instance of the class or interface declaring the underlying field (or a subclass or implementor thereof), or if an unwrapping conversion fails. |
java.lang.NullPointerException |
if the specified object is null and the field is an instance field. |
java.lang.ExceptionInInitializerError |
if the initialization provoked by this method fails. |
See Also
setLong
fun setLong(
obj: Any?,
l: Long
): Unit
Sets the value of a field as a long
on the specified object. This method is equivalent to set(obj, lObj)
, where lObj
is a Long
object and lObj.longValue() == l
.
Parameters | |
---|---|
obj |
Any?: the object whose field should be modified |
l |
Long: the new value for the field of obj being modified |
Exceptions | |
---|---|
java.lang.IllegalAccessException |
if this Field object is enforcing Java language access control and the underlying field is either inaccessible or final. |
java.lang.IllegalArgumentException |
if the specified object is not an instance of the class or interface declaring the underlying field (or a subclass or implementor thereof), or if an unwrapping conversion fails. |
java.lang.NullPointerException |
if the specified object is null and the field is an instance field. |
java.lang.ExceptionInInitializerError |
if the initialization provoked by this method fails. |
See Also
setShort
fun setShort(
obj: Any?,
s: Short
): Unit
Sets the value of a field as a short
on the specified object. This method is equivalent to set(obj, sObj)
, where sObj
is a Short
object and sObj.shortValue() == s
.
Parameters | |
---|---|
obj |
Any?: the object whose field should be modified |
s |
Short: the new value for the field of obj being modified |
Exceptions | |
---|---|
java.lang.IllegalAccessException |
if this Field object is enforcing Java language access control and the underlying field is either inaccessible or final. |
java.lang.IllegalArgumentException |
if the specified object is not an instance of the class or interface declaring the underlying field (or a subclass or implementor thereof), or if an unwrapping conversion fails. |
java.lang.NullPointerException |
if the specified object is null and the field is an instance field. |
java.lang.ExceptionInInitializerError |
if the initialization provoked by this method fails. |
See Also
toGenericString
fun toGenericString(): String
Returns a string describing this Field
, including its generic type. The format is the access modifiers for the field, if any, followed by the generic field type, followed by a space, followed by the fully-qualified name of the class declaring the field, followed by a period, followed by the name of the field.
The modifiers are placed in canonical order as specified by "The Java Language Specification". This is public
, protected
or private
first, and then other modifiers in the following order: static
, final
, transient
, volatile
.
Return | |
---|---|
String |
a string describing this Field , including its generic type |
toString
fun toString(): String
Returns a string describing this Field
. The format is the access modifiers for the field, if any, followed by the field type, followed by a space, followed by the fully-qualified name of the class declaring the field, followed by a period, followed by the name of the field. For example:
public static final int java.lang.Thread.MIN_PRIORITY private int java.io.FileDescriptor.fd
The modifiers are placed in canonical order as specified by "The Java Language Specification". This is public
, protected
or private
first, and then other modifiers in the following order: static
, final
, transient
, volatile
.
Return | |
---|---|
String |
a string describing this Field |