public void setAccessible(boolean flag)

Set the accessible flag for this reflected object to the indicated boolean value. A value of true indicates that the reflected object should suppress checks for Java language access control when it is used. A value of false indicates 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 C to enable access to a member of declaring class D if any of the following hold:

• C and D are in the same module.
• The member is public and D is public in a package that the module containing D exports to at least the module containing C.
• The member is protected static, D is public in a package that the module containing D exports to at least the module containing C, and C is a subclass of D.
• D is in a package that the module containing D opens to at least the module containing C. All packages in unnamed and open modules are open to all modules and so this method always succeeds when D is 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 member of declaring class D if and only if:

• The member is public and D is public in a package that the module containing D exports unconditionally.

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 accessible flag when true suppresses Java language access control checks to only enable read access to these non-modifiable final fields.

If there is a security manager, its checkPermission method is first called with a ReflectPermission("suppressAccessChecks") permission.

public Class<?> getDeclaringClass()

Returns the Class object representing the class or interface that declares the field represented by this Field object.

public String getName()

Returns the name of the field represented by this Field object.

public int getModifiers()

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.

public Set<AccessFlag> accessFlags()

Returns an unmodifiable set of the access flags for this field, possibly empty.

public boolean isEnumConstant()

Returns true if this field represents an element of an enumerated class; returns false otherwise.

public boolean isSynthetic()

Returns true if this field is a synthetic field; returns false otherwise.

public Class<?> getType()

Returns a Class object that identifies the declared type for the field represented by this Field object.

public Type getGenericType()

Returns a Type object that represents the declared type for the field represented by this Field object.

If the declared type of the field is a parameterized type, the Type object 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.

public boolean equals(Object obj)

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.

public int hashCode()

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.

public String toString()

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.

public String toGenericString()

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.

public Object get(Object obj) throws IllegalArgumentException, IllegalAccessException

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.

public boolean getBoolean(Object obj) throws IllegalArgumentException, IllegalAccessException

Gets the value of a static or instance boolean field.

public byte getByte(Object obj) throws IllegalArgumentException, IllegalAccessException

Gets the value of a static or instance byte field.

public char getChar(Object obj) throws IllegalArgumentException, IllegalAccessException

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.

public short getShort(Object obj) throws IllegalArgumentException, IllegalAccessException

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.

public int getInt(Object obj) throws IllegalArgumentException, IllegalAccessException

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.

public long getLong(Object obj) throws IllegalArgumentException, IllegalAccessException

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.

public float getFloat(Object obj) throws IllegalArgumentException, IllegalAccessException

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.

public double getDouble(Object obj) throws IllegalArgumentException, IllegalAccessException

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.

public void set(Object obj, Object value) throws IllegalArgumentException, IllegalAccessException

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 this Field object;
• 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.

If any of the above checks is not met, this method throws an 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.

public void setBoolean(Object obj, boolean z) throws IllegalArgumentException, IllegalAccessException

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.

public void setByte(Object obj, byte b) throws IllegalArgumentException, IllegalAccessException

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.

public void setChar(Object obj, char c) throws IllegalArgumentException, IllegalAccessException

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.

public void setShort(Object obj, short s) throws IllegalArgumentException, IllegalAccessException

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.

public void setInt(Object obj, int i) throws IllegalArgumentException, IllegalAccessException

Sets the value of a field as an int on the specified object. This method is equivalent to set(obj, iObj), where iObj is an Integer object and iObj.intValue() == i.

public void setLong(Object obj, long l) throws IllegalArgumentException, IllegalAccessException

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.

public void setFloat(Object obj, float f) throws IllegalArgumentException, IllegalAccessException

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.

public void setDouble(Object obj, double d) throws IllegalArgumentException, IllegalAccessException

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.

public <T extends Annotation> T getAnnotation(Class<T> annotationClass)

Returns 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.

public <T extends Annotation> T[] getAnnotationsByType(Class<T> annotationClass)

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 AnnotatedElement.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.

public AnnotatedType getAnnotatedType()

Returns an AnnotatedType object that represents the use of a type to specify the declared type of the field represented by this Field.