Class Field
- All Implemented Interfaces:
- AnnotatedElement,- Member
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.
- Since:
- 1.1
- See Also:
- 
Field Summary
- 
Method SummaryModifier and TypeMethodDescriptionReturns an unmodifiable set of the access flags for this field, possibly empty.booleanCompares thisFieldagainst the specified object.Returns the value of the field represented by thisField, on the specified object.Returns an AnnotatedType object that represents the use of a type to specify the declared type of the field represented by this Field.<T extends Annotation>
 TgetAnnotation(Class<T> annotationClass) Returns this element's annotation for the specified type if such an annotation is present, else null.<T extends Annotation>
 T[]getAnnotationsByType(Class<T> annotationClass) Returns annotations that are associated with this element.booleangetBoolean(Object obj) Gets the value of a static or instancebooleanfield.byteGets the value of a static or instancebytefield.charGets the value of a static or instance field of typecharor of another primitive type convertible to typecharvia a widening conversion.Class<?> Returns theClassobject representing the class or interface that declares the field represented by thisFieldobject.doubleGets the value of a static or instance field of typedoubleor of another primitive type convertible to typedoublevia a widening conversion.floatGets the value of a static or instance field of typefloator of another primitive type convertible to typefloatvia a widening conversion.Returns aTypeobject that represents the declared type for the field represented by thisFieldobject.intGets the value of a static or instance field of typeintor of another primitive type convertible to typeintvia a widening conversion.longGets the value of a static or instance field of typelongor of another primitive type convertible to typelongvia a widening conversion.intReturns the Java language modifiers for the field represented by thisFieldobject, as an integer.getName()Returns the name of the field represented by thisFieldobject.shortGets the value of a static or instance field of typeshortor of another primitive type convertible to typeshortvia a widening conversion.Class<?> getType()Returns aClassobject that identifies the declared type for the field represented by thisFieldobject.inthashCode()Returns a hashcode for thisField.booleanReturnstrueif this field represents an element of an enumerated class; returnsfalseotherwise.booleanReturnstrueif this field is a synthetic field; returnsfalseotherwise.voidSets the field represented by thisFieldobject on the specified object argument to the specified new value.voidsetAccessible(boolean flag) Set theaccessibleflag for this reflected object to the indicated boolean value.voidsetBoolean(Object obj, boolean z) Sets the value of a field as abooleanon the specified object.voidSets the value of a field as abyteon the specified object.voidSets the value of a field as acharon the specified object.voidSets the value of a field as adoubleon the specified object.voidSets the value of a field as afloaton the specified object.voidSets the value of a field as aninton the specified object.voidSets the value of a field as alongon the specified object.voidSets the value of a field as ashorton the specified object.Returns a string describing thisField, including its generic type.toString()Returns a string describing thisField.Methods declared in class java.lang.reflect.AccessibleObjectcanAccess, getAnnotations, getDeclaredAnnotation, getDeclaredAnnotations, getDeclaredAnnotationsByType, isAccessible, isAnnotationPresent, setAccessible, trySetAccessible
- 
Method Details- 
setAccessiblepublic void setAccessible(boolean flag) Description copied from class:AccessibleObjectSet theaccessibleflag for this reflected object to the indicated boolean value. A value oftrueindicates that the reflected object should suppress checks for Java language access control when it is used. A value offalseindicates that the reflected object should enforce checks for Java language access control when it is used, with the variation noted in the class description.This method may be used by a caller in class Cto enable access to amemberofdeclaring classDif any of the following hold:-  CandDare in the same module.
-  The member is publicandDispublicin a package that the module containingDexportsto at least the module containingC.
-  The member is protectedstatic,Dispublicin a package that the module containingDexports to at least the module containingC, andCis a subclass ofD.
-  Dis in a package that the module containingDopensto at least the module containingC. All packages in unnamed and open modules are open to all modules and so this method always succeeds whenDis in an unnamed or open module.
 This method may be used by JNI code with no caller class on the stack to enable access to a memberofdeclaring classDif and only if:-  The member is publicandDispublicin a package that the module containingDexportsunconditionally.
 This method cannot be used to enable access to private members, members with default (package) access, protected instance members, or protected constructors when the declaring class is in a different module to the caller and the package containing the declaring class is not open to the caller's module. This method cannot be used to enable write access to a non-modifiable final field. The following fields are non-modifiable: - static final fields declared in any class or interface
- final fields declared in a hidden class
- final fields declared in a record
 The accessibleflag whentruesuppresses Java language access control checks to only enable read access to these non-modifiable final fields.- Overrides:
- setAccessiblein class- AccessibleObject
- Parameters:
- flag- the new value for the- accessibleflag
- Throws:
- InaccessibleObjectException- if access cannot be enabled
- External Specifications
- See Also:
 
-  
- 
getDeclaringClassReturns theClassobject representing the class or interface that declares the field represented by thisFieldobject.- Specified by:
- getDeclaringClassin interface- Member
- Returns:
- an object representing the declaring class of the underlying member
 
- 
getName
- 
getModifierspublic int getModifiers()Returns the Java language modifiers for the field represented by thisFieldobject, as an integer. TheModifierclass should be used to decode the modifiers.- Specified by:
- getModifiersin interface- Member
- Returns:
- the Java language modifiers for the underlying member
- See Java Language Specification:
- 
8.3 Field Declarations
 9.3 Field (Constant) Declarations
- See Also:
 
- 
accessFlagsReturns an unmodifiable set of the access flags for this field, possibly empty.- Specified by:
- accessFlagsin interface- Member
- Returns:
- an unmodifiable set of the access flags for this field, possibly empty
- See Java Virtual Machine Specification:
- 
4.5 Fields
- Since:
- 20
- See Also:
 
- 
isEnumConstantpublic boolean isEnumConstant()Returnstrueif this field represents an element of an enumerated class; returnsfalseotherwise.- Returns:
- trueif and only if this field represents an element of an enumerated class.
- See Java Language Specification:
- 
8.9.1 Enum Constants
- Since:
- 1.5
 
- 
isSyntheticpublic boolean isSynthetic()Returnstrueif this field is a synthetic field; returnsfalseotherwise.- Specified by:
- isSyntheticin interface- Member
- Returns:
- true if and only if this field is a synthetic field as defined by the Java Language Specification.
- Since:
- 1.5
- See Also:
 
- 
getTypeReturns aClassobject that identifies the declared type for the field represented by thisFieldobject.- Returns:
- a Classobject identifying the declared type of the field represented by this object
 
- 
getGenericTypeReturns aTypeobject that represents the declared type for the field represented by thisFieldobject.If the declared type of the field is a parameterized type, the Typeobject returned must accurately reflect the actual type arguments 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. - Returns:
- a Typeobject that represents the declared type for the field represented by thisFieldobject
- Throws:
- GenericSignatureFormatError- if the generic field signature does not conform to the format specified in The Java Virtual Machine Specification
- TypeNotPresentException- if the generic type signature of the underlying field refers to a non-existent class or interface declaration
- MalformedParameterizedTypeException- if the generic signature of the underlying field refers to a parameterized type that cannot be instantiated for any reason
- Since:
- 1.5
 
- 
equalsCompares thisFieldagainst the specified object. Returns true if the objects are the same. TwoFieldobjects are the same if they were declared by the same class and have the same name and type.
- 
hashCode
- 
toStringReturns a string describing thisField. 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.fdThe modifiers are placed in canonical order as specified by "The Java Language Specification". This is public,protectedorprivatefirst, and then other modifiers in the following order:static,final,transient,volatile.- Overrides:
- toStringin class- Object
- Returns:
- a string describing this Field
- See Java Language Specification:
- 
8.3.1 Field Modifiers
 
- 
toGenericStringReturns a string describing thisField, 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,protectedorprivatefirst, and then other modifiers in the following order:static,final,transient,volatile.- Returns:
- a string describing this Field, including its generic type
- See Java Language Specification:
- 
8.3.1 Field Modifiers
- Since:
- 1.5
 
- 
getReturns the value of the field represented by thisField, 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 objargument is ignored; it may be null.Otherwise, the underlying field is an instance field. If the specified objargument is null, the method throws aNullPointerException. If the specified object is not an instance of the class or interface declaring the underlying field, the method throws anIllegalArgumentException.If this Fieldobject is enforcing Java language access control, and the underlying field is inaccessible, the method throws anIllegalAccessException. 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- object from which the represented field's value is to be extracted
- Returns:
- the value of the represented field in object
 obj; primitive values are wrapped in an appropriate object before being returned
- Throws:
- IllegalAccessException- if this- Fieldobject is enforcing Java language access control and the underlying field is inaccessible.
- IllegalArgumentException- if the specified object is not an instance of the class or interface declaring the underlying field (or a subclass or implementor thereof).
- NullPointerException- if the specified object is null and the field is an instance field.
- ExceptionInInitializerError- if the initialization provoked by this method fails.
 
- 
getBooleanGets the value of a static or instancebooleanfield.- Parameters:
- obj- the object to extract the- booleanvalue from
- Returns:
- the value of the booleanfield
- Throws:
- IllegalAccessException- if this- Fieldobject is enforcing Java language access control and the underlying field is inaccessible.
- 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- booleanby a widening conversion.
- NullPointerException- if the specified object is null and the field is an instance field.
- ExceptionInInitializerError- if the initialization provoked by this method fails.
- See Also:
 
- 
getByteGets the value of a static or instancebytefield.- Parameters:
- obj- the object to extract the- bytevalue from
- Returns:
- the value of the bytefield
- Throws:
- IllegalAccessException- if this- Fieldobject is enforcing Java language access control and the underlying field is inaccessible.
- 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- byteby a widening conversion.
- NullPointerException- if the specified object is null and the field is an instance field.
- ExceptionInInitializerError- if the initialization provoked by this method fails.
- See Also:
 
- 
getCharGets the value of a static or instance field of typecharor of another primitive type convertible to typecharvia a widening conversion.- Parameters:
- obj- the object to extract the- charvalue from
- Returns:
- the value of the field converted to type char
- Throws:
- IllegalAccessException- if this- Fieldobject is enforcing Java language access control and the underlying field is inaccessible.
- 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- charby a widening conversion.
- NullPointerException- if the specified object is null and the field is an instance field.
- ExceptionInInitializerError- if the initialization provoked by this method fails.
- See Also:
 
- 
getShortGets the value of a static or instance field of typeshortor of another primitive type convertible to typeshortvia a widening conversion.- Parameters:
- obj- the object to extract the- shortvalue from
- Returns:
- the value of the field converted to type short
- Throws:
- IllegalAccessException- if this- Fieldobject is enforcing Java language access control and the underlying field is inaccessible.
- 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- shortby a widening conversion.
- NullPointerException- if the specified object is null and the field is an instance field.
- ExceptionInInitializerError- if the initialization provoked by this method fails.
- See Also:
 
- 
getIntGets the value of a static or instance field of typeintor of another primitive type convertible to typeintvia a widening conversion.- Parameters:
- obj- the object to extract the- intvalue from
- Returns:
- the value of the field converted to type int
- Throws:
- IllegalAccessException- if this- Fieldobject is enforcing Java language access control and the underlying field is inaccessible.
- 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- intby a widening conversion.
- NullPointerException- if the specified object is null and the field is an instance field.
- ExceptionInInitializerError- if the initialization provoked by this method fails.
- See Also:
 
- 
getLongGets the value of a static or instance field of typelongor of another primitive type convertible to typelongvia a widening conversion.- Parameters:
- obj- the object to extract the- longvalue from
- Returns:
- the value of the field converted to type long
- Throws:
- IllegalAccessException- if this- Fieldobject is enforcing Java language access control and the underlying field is inaccessible.
- 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- longby a widening conversion.
- NullPointerException- if the specified object is null and the field is an instance field.
- ExceptionInInitializerError- if the initialization provoked by this method fails.
- See Also:
 
- 
getFloatGets the value of a static or instance field of typefloator of another primitive type convertible to typefloatvia a widening conversion.- Parameters:
- obj- the object to extract the- floatvalue from
- Returns:
- the value of the field converted to type float
- Throws:
- IllegalAccessException- if this- Fieldobject is enforcing Java language access control and the underlying field is inaccessible.
- 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- floatby a widening conversion.
- NullPointerException- if the specified object is null and the field is an instance field.
- ExceptionInInitializerError- if the initialization provoked by this method fails.
- See Also:
 
- 
getDoubleGets the value of a static or instance field of typedoubleor of another primitive type convertible to typedoublevia a widening conversion.- Parameters:
- obj- the object to extract the- doublevalue from
- Returns:
- the value of the field converted to type double
- Throws:
- IllegalAccessException- if this- Fieldobject is enforcing Java language access control and the underlying field is inaccessible.
- 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- doubleby a widening conversion.
- NullPointerException- if the specified object is null and the field is an instance field.
- ExceptionInInitializerError- if the initialization provoked by this method fails.
- See Also:
 
- 
setSets the field represented by thisFieldobject 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 objargument 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 anIllegalArgumentException.If this Fieldobject is enforcing Java language access control, and the underlying field is inaccessible, the method throws anIllegalAccessException.If the underlying field is final, this Fieldobject has write access if and only if the following conditions are met:- setAccessible(true)has succeeded for this- Fieldobject;
- the field is non-static; and
- the field's declaring class is not a hidden class; 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- the object whose field should be modified
- value- the new value for the field of- objbeing modified
- Throws:
- IllegalAccessException- if this- Fieldobject is enforcing Java language access control and the underlying field is inaccessible or final; or if this- Fieldobject has no write access.
- 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.
- NullPointerException- if the specified object is null and the field is an instance field.
- ExceptionInInitializerError- if the initialization provoked by this method fails.
 
- 
setBooleanpublic void setBoolean(Object obj, boolean z) throws IllegalArgumentException, IllegalAccessException Sets the value of a field as abooleanon the specified object. This method is equivalent toset(obj, zObj), wherezObjis aBooleanobject andzObj.booleanValue() == z.- Parameters:
- obj- the object whose field should be modified
- z- the new value for the field of- objbeing modified
- Throws:
- IllegalAccessException- if this- Fieldobject is enforcing Java language access control and the underlying field is either inaccessible or final; or if this- Fieldobject has no write access.
- 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.
- NullPointerException- if the specified object is null and the field is an instance field.
- ExceptionInInitializerError- if the initialization provoked by this method fails.
- See Also:
 
- 
setByteSets the value of a field as abyteon the specified object. This method is equivalent toset(obj, bObj), wherebObjis aByteobject andbObj.byteValue() == b.- Parameters:
- obj- the object whose field should be modified
- b- the new value for the field of- objbeing modified
- Throws:
- IllegalAccessException- if this- Fieldobject is enforcing Java language access control and the underlying field is either inaccessible or final; or if this- Fieldobject has no write access.
- 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.
- NullPointerException- if the specified object is null and the field is an instance field.
- ExceptionInInitializerError- if the initialization provoked by this method fails.
- See Also:
 
- 
setCharSets the value of a field as acharon the specified object. This method is equivalent toset(obj, cObj), wherecObjis aCharacterobject andcObj.charValue() == c.- Parameters:
- obj- the object whose field should be modified
- c- the new value for the field of- objbeing modified
- Throws:
- IllegalAccessException- if this- Fieldobject is enforcing Java language access control and the underlying field is either inaccessible or final; or if this- Fieldobject has no write access.
- 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.
- NullPointerException- if the specified object is null and the field is an instance field.
- ExceptionInInitializerError- if the initialization provoked by this method fails.
- See Also:
 
- 
setShortSets the value of a field as ashorton the specified object. This method is equivalent toset(obj, sObj), wheresObjis aShortobject andsObj.shortValue() == s.- Parameters:
- obj- the object whose field should be modified
- s- the new value for the field of- objbeing modified
- Throws:
- IllegalAccessException- if this- Fieldobject is enforcing Java language access control and the underlying field is either inaccessible or final; or if this- Fieldobject has no write access.
- 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.
- NullPointerException- if the specified object is null and the field is an instance field.
- ExceptionInInitializerError- if the initialization provoked by this method fails.
- See Also:
 
- 
setIntSets the value of a field as aninton the specified object. This method is equivalent toset(obj, iObj), whereiObjis anIntegerobject andiObj.intValue() == i.- Parameters:
- obj- the object whose field should be modified
- i- the new value for the field of- objbeing modified
- Throws:
- IllegalAccessException- if this- Fieldobject is enforcing Java language access control and the underlying field is either inaccessible or final; or if this- Fieldobject has no write access.
- 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.
- NullPointerException- if the specified object is null and the field is an instance field.
- ExceptionInInitializerError- if the initialization provoked by this method fails.
- See Also:
 
- 
setLongSets the value of a field as alongon the specified object. This method is equivalent toset(obj, lObj), wherelObjis aLongobject andlObj.longValue() == l.- Parameters:
- obj- the object whose field should be modified
- l- the new value for the field of- objbeing modified
- Throws:
- IllegalAccessException- if this- Fieldobject is enforcing Java language access control and the underlying field is either inaccessible or final; or if this- Fieldobject has no write access.
- 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.
- NullPointerException- if the specified object is null and the field is an instance field.
- ExceptionInInitializerError- if the initialization provoked by this method fails.
- See Also:
 
- 
setFloatSets the value of a field as afloaton the specified object. This method is equivalent toset(obj, fObj), wherefObjis aFloatobject andfObj.floatValue() == f.- Parameters:
- obj- the object whose field should be modified
- f- the new value for the field of- objbeing modified
- Throws:
- IllegalAccessException- if this- Fieldobject is enforcing Java language access control and the underlying field is either inaccessible or final; or if this- Fieldobject has no write access.
- 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.
- NullPointerException- if the specified object is null and the field is an instance field.
- ExceptionInInitializerError- if the initialization provoked by this method fails.
- See Also:
 
- 
setDoubleSets the value of a field as adoubleon the specified object. This method is equivalent toset(obj, dObj), wheredObjis aDoubleobject anddObj.doubleValue() == d.- Parameters:
- obj- the object whose field should be modified
- d- the new value for the field of- objbeing modified
- Throws:
- IllegalAccessException- if this- Fieldobject is enforcing Java language access control and the underlying field is either inaccessible or final; or if this- Fieldobject has no write access.
- 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.
- NullPointerException- if the specified object is null and the field is an instance field.
- ExceptionInInitializerError- if the initialization provoked by this method fails.
- See Also:
 
- 
getAnnotationReturns this element's annotation for the specified type if such an annotation is present, else null.Note that any annotation returned by this method is a declaration annotation. - Specified by:
- getAnnotationin interface- AnnotatedElement
- Overrides:
- getAnnotationin class- AccessibleObject
- Type Parameters:
- T- the type of the annotation to query for and return if present
- Parameters:
- annotationClass- the Class object corresponding to the annotation type
- Returns:
- this element's annotation for the specified annotation type if present on this element, else null
- Throws:
- NullPointerException- if the given annotation class is null
- Since:
- 1.5
 
- 
getAnnotationsByTypeReturns 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 andAnnotatedElement.getAnnotation(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.Note that any annotations returned by this method are declaration annotations. - Specified by:
- getAnnotationsByTypein interface- AnnotatedElement
- Overrides:
- getAnnotationsByTypein class- AccessibleObject
- Type Parameters:
- T- the type of the annotation to query for and return if present
- Parameters:
- annotationClass- the Class object corresponding to the annotation type
- Returns:
- all this element's annotations for the specified annotation type if associated with this element, else an array of length zero
- Throws:
- NullPointerException- if the given annotation class is null
- Since:
- 1.8
 
- 
getAnnotatedTypeReturns an AnnotatedType object that represents the use of a type to specify the declared type of the field represented by this Field.- Returns:
- an object representing the declared type of the field represented by this Field
- Since:
- 1.8
 
 
-