Class AbstractReflection

java.lang.Object

org.apache.commons.lang3.builder.AbstractReflection

Direct Known Subclasses:

CompareToBuilder, EqualsBuilder, HashCodeBuilder, ReflectionDiffBuilder, ToStringBuilder

public abstract class AbstractReflection
extends Object

Abstracts reflection access for reflection-based classes in this package.

See AbstractReflection.AbstractBuilder.setForceAccessible(boolean) for details.

Since:

3.21.0

See Also:

• AbstractReflection.AbstractBuilder.setForceAccessible(boolean)
• AccessibleObject.setAccessible(boolean)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AbstractReflection.AbstractBuilder<B extends AbstractReflection.AbstractBuilder<B>>	Builds an instance of a subclass of AbstractReflection.

Method Summary

Modifier and Type	Method	Description
static boolean	getForceAccessible()	Gets whether the system property "AbstractReflection.forceAccessible" is set to true.
protected boolean	isForceAccessible()	Tests whether fields should be made accessible with AccessibleObject.setAccessible(boolean).
static boolean	setAccessible(boolean forceAccessible, AccessibleObject accessibleObject)	Sets accessibleObject to be accessible if forceAccessible is true and the object is not already accessible.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

getForceAccessible

public static boolean getForceAccessible()

Gets whether the system property "AbstractReflection.forceAccessible" is set to true.

The parsing rules are defined by Boolean.parseBoolean(String).

If the property is not set, return true.

Returns:

whether the system property "AbstractReflection.forceAccessible" is set to true with true as the default.

Since:

3.21.0

See Also:

• Boolean.parseBoolean(String)

setAccessible

public static boolean setAccessible(boolean forceAccessible,
 AccessibleObject accessibleObject)

Sets accessibleObject to be accessible if forceAccessible is true and the object is not already accessible. Calls AccessibleObject#setAccessible(true).

Parameters:

forceAccessible - Whether to call AccessibleObject.setAccessible(boolean) if the object is not already accessible.

accessibleObject - The accessible object to set; may be null.

Returns:

true if accessibleObject is non-null and accessible after this call; false otherwise (including when accessibleObject is null, or when it is inaccessible and forceAccessible is false).

Throws:

SecurityException - Thrown if forceAccessible is true and the request is denied.

See Also:

• AccessibleObject.setAccessible(boolean)
• SecurityManager.checkPermission(Permission)

isForceAccessible

protected boolean isForceAccessible()

Tests whether fields should be made accessible with AccessibleObject.setAccessible(boolean).

Returns:

whether fields should be made accessible with AccessibleObject.setAccessible(boolean).