Enum FieldSupport
- java.lang.Object
-
- java.lang.Enum<FieldSupport>
-
- org.assertj.core.util.introspection.FieldSupport
-
- All Implemented Interfaces:
Serializable
,Comparable<FieldSupport>
public enum FieldSupport extends Enum<FieldSupport>
Utility methods for fields access.- Author:
- Joel Costigliola
-
-
Enum Constant Summary
Enum Constants Enum Constant Description COMPARISON
EXTRACTION
EXTRACTION_OF_PUBLIC_FIELD_ONLY
-
Field Summary
Fields Modifier and Type Field Description private boolean
allowUsingPrivateFields
private static String
BOOLEAN
private static String
BYTE
private static String
CHAR
private static String
DOUBLE
private static String
FLOAT
private static String
INT
private static String
LONG
private static String
SEPARATOR
private static String
SHORT
-
Constructor Summary
Constructors Modifier Constructor Description private
FieldSupport(boolean allowUsingPrivateFields)
Build a newFieldSupport
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static FieldSupport
comparison()
Returns the instance dedicated to comparison of fields.static FieldSupport
extraction()
Returns the instance dedicated to extraction of fields.<T> T
fieldValue(String fieldName, Class<T> fieldClass, Object target)
Return the value of field from a target object.<T> List<T>
fieldValues(String fieldName, Class<T> fieldClass, Iterable<?> target)
<T> List<T>
fieldValues(String fieldName, Class<T> fieldClass, Object[] target)
List<Object>
fieldValues(String fieldName, Iterable<?> target)
boolean
isAllowedToRead(Field field)
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)
void
setAllowUsingPrivateFields(boolean allowUsingPrivateFields)
Sets whether the use of private fields is allowed.private <T> List<T>
simpleFieldValues(String fieldName, Class<T> clazz, Iterable<?> target)
static FieldSupport
valueOf(String name)
Returns the enum constant of this type with the specified name.static FieldSupport[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
EXTRACTION
public static final FieldSupport EXTRACTION
-
EXTRACTION_OF_PUBLIC_FIELD_ONLY
public static final FieldSupport EXTRACTION_OF_PUBLIC_FIELD_ONLY
-
COMPARISON
public static final FieldSupport COMPARISON
-
-
Field Detail
-
CHAR
private static final String CHAR
- See Also:
- Constant Field Values
-
BOOLEAN
private static final String BOOLEAN
- See Also:
- Constant Field Values
-
DOUBLE
private static final String DOUBLE
- See Also:
- Constant Field Values
-
FLOAT
private static final String FLOAT
- See Also:
- Constant Field Values
-
LONG
private static final String LONG
- See Also:
- Constant Field Values
-
INT
private static final String INT
- See Also:
- Constant Field Values
-
SHORT
private static final String SHORT
- See Also:
- Constant Field Values
-
BYTE
private static final String BYTE
- See Also:
- Constant Field Values
-
SEPARATOR
private static final String SEPARATOR
- See Also:
- Constant Field Values
-
allowUsingPrivateFields
private boolean allowUsingPrivateFields
-
-
Constructor Detail
-
FieldSupport
private FieldSupport(boolean allowUsingPrivateFields)
Build a newFieldSupport
- Parameters:
allowUsingPrivateFields
- whether to read private fields or not.
-
-
Method Detail
-
values
public static FieldSupport[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:for (FieldSupport c : FieldSupport.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static FieldSupport valueOf(String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)- Parameters:
name
- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException
- if this enum type has no constant with the specified nameNullPointerException
- if the argument is null
-
extraction
public static FieldSupport extraction()
Returns the instance dedicated to extraction of fields.- Returns:
- the instance dedicated to extraction of fields.
-
comparison
public static FieldSupport comparison()
Returns the instance dedicated to comparison of fields.- Returns:
- the instance dedicated to comparison of fields.
-
isAllowedToUsePrivateFields
public boolean isAllowedToUsePrivateFields()
-
setAllowUsingPrivateFields
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
- allow private fields extraction and comparison. Defaulttrue
.
-
fieldValues
public <T> List<T> fieldValues(String fieldName, Class<T> fieldClass, Iterable<?> target)
Returns a
containing the values of the given field name, from the elements of the givenList
. If the givenIterable
Iterable
is empty ornull
, this method will return an emptyList
. This method supports nested fields (e.g. "address.street.number").- Type Parameters:
T
- the type of the extracted elements.- Parameters:
fieldName
- the name of the field. It may be a nested field. It is left to the clients to validate fornull
or empty.fieldClass
- the expected type of the given field.target
- the givenIterable
.- Returns:
- an
Iterable
containing the values of the given field name, from the elements of the givenIterable
. - Throws:
IntrospectionError
- if an element in the givenIterable
does not have a field with a matching name.
-
fieldValues
public <T> List<T> fieldValues(String fieldName, Class<T> fieldClass, Object[] target)
Returns a
containing the values of the given field name, from the elements of the givenList
. If the givenIterable
Iterable
is empty ornull
, this method will return an emptyList
. This method supports nested fields (e.g. "address.street.number").- Type Parameters:
T
- the type of the extracted elements.- Parameters:
fieldName
- the name of the field. It may be a nested field. It is left to the clients to validate fornull
or empty.fieldClass
- the expected type of the given field.target
- the givenIterable
.- Returns:
- an
Iterable
containing the values of the given field name, from the elements of the givenIterable
. - Throws:
IntrospectionError
- if an element in the givenIterable
does not have a field with a matching name.
-
simpleFieldValues
private <T> List<T> simpleFieldValues(String fieldName, Class<T> clazz, Iterable<?> target)
-
isNestedField
private boolean isNestedField(String fieldName)
-
fieldValue
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
- Type Parameters:
T
- the type of the extracted value.- Parameters:
fieldName
- the name of the field. It may be a nested field. It is left to the clients to validate fornull
or empty.target
- the given objectfieldClass
- type of field- Returns:
- the value of the given field name
- Throws:
IntrospectionError
- if the given target does not have a field with a matching name.
-
isAllowedToRead
public boolean isAllowedToRead(Field field)
-
-