AssertJ Core 3.26.0 · org.assertj.core.util.introspection.FieldSupport

Modifier and Type	Field and Description
private boolean	allowUsingPrivateFields
private static final String	BOOLEAN
private static final String	BYTE
private static final String	CHAR
public static final FieldSupport	COMPARISON
private static final String	DOUBLE
public static final FieldSupport	EXTRACTION
public static final FieldSupport	EXTRACTION_OF_PUBLIC_FIELD_ONLY
private static final String	FLOAT
private static final String	INT
private static final String	LONG
private static final String	SEPARATOR
private static final String	SHORT

Access	Constructor and Description
private	FieldSupport(boolean whether to read private fields or not. allowUsingPrivateFields) Build a new `FieldSupport`

Method Summary

Modifier and Type	Method and Description
public static FieldSupport	Returns: the instance dedicated to comparison of fields. comparison() Returns the instance dedicated to comparison of fields.
public static FieldSupport	Returns: the instance dedicated to extraction of fields. extraction() Returns the instance dedicated to extraction of fields.
public < the type of the extracted value. T> T	Returns: the value of the given field name fieldValue(String the name of the field. It may be a nested field. It is left to the clients to validate for `null` or empty. fieldName, Class<T> type of field fieldClass, Object the given object target) Return the value of field from a target object.
public < the type of the extracted elements. T> List<T>	Returns: an `Iterable` containing the values of the given field name, from the elements of the given `Iterable`. fieldValues(String the name of the field. It may be a nested field. It is left to the clients to validate for `null` or empty. fieldName, Class<T> the expected type of the given field. fieldClass, Iterable<?> the given `Iterable`. target) Returns a `List` containing the values of the given field name, from the elements of the given `Iterable`.
public List<Object>	fieldValues(String fieldName, Iterable<?> target)
public < the type of the extracted elements. T> List<T>	Returns: an `Iterable` containing the values of the given field name, from the elements of the given `Iterable`. fieldValues(String the name of the field. It may be a nested field. It is left to the clients to validate for `null` or empty. fieldName, Class<T> the expected type of the given field. fieldClass, Object[] the given `Iterable`. target) Returns a `List` containing the values of the given field name, from the elements of the given `Iterable`.
public boolean	isAllowedToRead(Field field)
public boolean	isAllowedToUsePrivateFields()
private boolean	isNestedField(String fieldName)
private String	nextFieldNameFrom(String fieldNameChain)
private String	popFieldNameFrom(String fieldNameChain)
private <T> T	readSimpleField(String fieldName, Class<T> clazz, Object target)
public void	setAllowUsingPrivateFields(boolean allow private fields extraction and comparison. Default `true`. allowUsingPrivateFields) Sets whether the use of private fields is allowed.
private <T> List<T>	simpleFieldValues(String fieldName, Class<T> clazz, Iterable<?> target)
public static FieldSupport	valueOf(String name)
public static FieldSupport[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

allowUsingPrivateFields	back to summary
private boolean allowUsingPrivateFields

BOOLEAN	back to summary
private static final String BOOLEAN

BYTE	back to summary
private static final String BYTE

CHAR	back to summary
private static final String CHAR

COMPARISON	back to summary
public static final FieldSupport COMPARISON

DOUBLE	back to summary
private static final String DOUBLE

EXTRACTION	back to summary
public static final FieldSupport EXTRACTION

EXTRACTION_OF_PUBLIC_FIELD_ONLY	back to summary
public static final FieldSupport EXTRACTION_OF_PUBLIC_FIELD_ONLY

FLOAT	back to summary
private static final String FLOAT

INT	back to summary
private static final String INT

LONG	back to summary
private static final String LONG

SEPARATOR	back to summary
private static final String SEPARATOR

SHORT	back to summary
private static final String SHORT

FieldSupport	back to summary
private FieldSupport(boolean allowUsingPrivateFields) Build a new `FieldSupport` Parameters allowUsingPrivateFields:boolean whether to read private fields or not.

Method Detail

comparison	back to summary
public static FieldSupport comparison() Returns the instance dedicated to comparison of fields. Returns:FieldSupport the instance dedicated to comparison of fields.

comparison

back to summary

public static FieldSupport comparison()

Returns the instance dedicated to comparison of fields.

Returns:FieldSupport: the instance dedicated to comparison of fields.

extraction	back to summary
public static FieldSupport extraction() Returns the instance dedicated to extraction of fields. Returns:FieldSupport the instance dedicated to extraction of fields.

extraction

back to summary

public static FieldSupport extraction()

Returns the instance dedicated to extraction of fields.

Returns:FieldSupport: the instance dedicated to extraction of fields.

fieldValue back to summary

fieldValue	back to summary
public <T> T fieldValue(String fieldName, Class<T> fieldClass, Object target) Return the value of field from a target object. The field must not be static or synthetic (since 3.19.0). Return null if field is nested and one of the nested value is null, ex : `fieldValue(race.name, String.class, frodo); // will return null if frodo.race is null` Parameters <T> the type of the extracted value. fieldName:String the name of the field. It may be a nested field. It is left to the clients to validate for `null` or empty. fieldClass:Class<T> type of field target:Object the given object Returns:T the value of the given field name Exceptions IntrospectionError: if the given target does not have a field with a matching name.

public <T> T fieldValue(String fieldName, Class<T> fieldClass, Object target)

Return the value of field from a target object. The field must not be static or synthetic (since 3.19.0).

Return null if field is nested and one of the nested value is null, ex :

 fieldValue(race.name, String.class, frodo); // will return null if frodo.race is null

Parameters

<T>: the type of the extracted value.
fieldName:String: the name of the field. It may be a nested field. It is left to the clients to validate for null or empty.
fieldClass:Class<T>: type of field
target:Object: the given object

Returns:T

the value of the given field name

Exceptions

IntrospectionError:: if the given target does not have a field with a matching name.

fieldValues back to summary

fieldValues	back to summary
public <T> List<T> fieldValues(String fieldName, Class<T> fieldClass, Iterable<?> target) Returns a `List` containing the values of the given field name, from the elements of the given `Iterable`. If the given `Iterable` is empty or `null`, this method will return an empty `List`. This method supports nested fields (e.g. "address.street.number"). Parameters <T> the type of the extracted elements. fieldName:String the name of the field. It may be a nested field. It is left to the clients to validate for `null` or empty. fieldClass:Class<T> the expected type of the given field. target:Iterable<?> the given `Iterable`. Returns:List<T> an `Iterable` containing the values of the given field name, from the elements of the given `Iterable`. Exceptions IntrospectionError: if an element in the given `Iterable` does not have a field with a matching name.

public <T> List<T> fieldValues(String fieldName, Class<T> fieldClass, Iterable<?> target)

Returns a List containing the values of the given field name, from the elements of the given Iterable. If the given Iterable is empty or null, this method will return an empty List. This method supports nested fields (e.g. "address.street.number").

Parameters

<T>: the type of the extracted elements.
fieldName:String: the name of the field. It may be a nested field. It is left to the clients to validate for null or empty.
fieldClass:Class<T>: the expected type of the given field.
target:Iterable<?>: the given Iterable.

Returns:List<T>

an Iterable containing the values of the given field name, from the elements of the given Iterable.

Exceptions

IntrospectionError:: if an element in the given Iterable does not have a field with a matching name.

fieldValues	back to summary
public List<Object> fieldValues(String fieldName, Iterable<?> target)

fieldValues back to summary

fieldValues	back to summary
public <T> List<T> fieldValues(String fieldName, Class<T> fieldClass, Object[] target) Returns a `List` containing the values of the given field name, from the elements of the given `Iterable`. If the given `Iterable` is empty or `null`, this method will return an empty `List`. This method supports nested fields (e.g. "address.street.number"). Parameters <T> the type of the extracted elements. fieldName:String the name of the field. It may be a nested field. It is left to the clients to validate for `null` or empty. fieldClass:Class<T> the expected type of the given field. target:Object[] the given `Iterable`. Returns:List<T> an `Iterable` containing the values of the given field name, from the elements of the given `Iterable`. Exceptions IntrospectionError: if an element in the given `Iterable` does not have a field with a matching name.

public <T> List<T> fieldValues(String fieldName, Class<T> fieldClass, Object[] target)

Parameters

<T>: the type of the extracted elements.
fieldName:String: the name of the field. It may be a nested field. It is left to the clients to validate for null or empty.
fieldClass:Class<T>: the expected type of the given field.
target:Object[]: the given Iterable.

Returns:List<T>

an Iterable containing the values of the given field name, from the elements of the given Iterable.

Exceptions

IntrospectionError:: if an element in the given Iterable does not have a field with a matching name.

isAllowedToRead	back to summary
public boolean isAllowedToRead(Field field)

isAllowedToUsePrivateFields	back to summary
public boolean isAllowedToUsePrivateFields() Annotations @VisibleForTesting

isNestedField	back to summary
private boolean isNestedField(String fieldName)

nextFieldNameFrom	back to summary
private String nextFieldNameFrom(String fieldNameChain)

popFieldNameFrom	back to summary
private String popFieldNameFrom(String fieldNameChain)

readSimpleField	back to summary
private <T> T readSimpleField(String fieldName, Class<T> clazz, Object target) Annotations @SuppressWarnings:unchecked

setAllowUsingPrivateFields back to summary

setAllowUsingPrivateFields	back to summary
public void setAllowUsingPrivateFields(boolean allowUsingPrivateFields) Sets whether the use of private fields is allowed. If a method tries to extract/compare private fields and is not allowed to, it will fail with an exception. Parameters allowUsingPrivateFields:boolean allow private fields extraction and comparison. Default `true`.

public void setAllowUsingPrivateFields(boolean allowUsingPrivateFields)

Sets whether the use of private fields is allowed. If a method tries to extract/compare private fields and is not allowed to, it will fail with an exception.

Parameters

allowUsingPrivateFields:boolean: allow private fields extraction and comparison. Default true.

simpleFieldValues	back to summary
private <T> List<T> simpleFieldValues(String fieldName, Class<T> clazz, Iterable<?> target)

valueOf	back to summary
public static FieldSupport valueOf(String name)

values	back to summary
public static FieldSupport[] values()

public final Enum FieldSupport

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail