org.assertj.core.util.introspection

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 and Description
COMPARISON
EXTRACTION
EXTRACTION_OF_PUBLIC_FIELD_ONLY

Method Summary

Methods

Modifier and Type	Method and 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) Returns a List containing the values of the given field name, from the elements of the given Iterable.
<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.
List<Object>	fieldValues(String fieldName, Iterable<?> target)
boolean	isAllowedToRead(Field field)
boolean	isAllowedToUsePrivateFields()
void	setAllowUsingPrivateFields(boolean allowUsingPrivateFields) Sets whether the use of private fields is allowed.
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.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

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 name

NullPointerException - 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. Default true.

fieldValues

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:

fieldName - the name of the field. It may be a nested field. It is left to the clients to validate for null or empty.

fieldClass - the expected type of the given field.

target - the given Iterable.

Returns:

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

Throws:

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

fieldValues

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

fieldValues

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:

fieldName - the name of the field. It may be a nested field. It is left to the clients to validate for null or empty.

fieldClass - the expected type of the given field.

target - the given Iterable.

Returns:

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

Throws:

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

fieldValue

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

Return the value of field from a target object.

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:

fieldName - the name of the field. It may be a nested field. It is left to the clients to validate for null or empty.

target - the given object

fieldClass - 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)