org.assertj.assertions.generator.description

Class FieldDescription

java.lang.Object

org.assertj.assertions.generator.description.DataDescription

org.assertj.assertions.generator.description.FieldDescription

All Implemented Interfaces:

Comparable<FieldDescription>

public class FieldDescription
extends DataDescription
implements Comparable<FieldDescription>

Stores the information needed to generate an assertion for a field.

Let's say we have the following method in class Person :

 public int age
 

To generate PersonAssert hasAge(int expectedAge) assertion in PersonAssert, we need to know :

• the field name, here "age"
• the field valueType
• its visibility to determine how to access the field value

This class is immutable.

Author:

Joel Costigliola

Field Summary

Fields inherited from class org.assertj.assertions.generator.description.DataDescription

visibility

Constructor Summary

Constructors

Constructor and Description
FieldDescription(Field field, com.google.common.reflect.TypeToken<?> owningType)
FieldDescription(Field field, Visibility visibility, com.google.common.reflect.TypeToken<?> owningType)

Method Summary

Modifier and Type	Method and Description
int	compareTo(FieldDescription other)
String	getNegativePredicate()
Field	getOriginalMember()
String	getPredicate()
boolean	isPredicate()
String	toString()

Methods inherited from class org.assertj.assertions.generator.description.DataDescription

equals, getAssertTypeName, getElementAssertTypeName, getElementTypeName, getFullyQualifiedTypeName, getName, getNegativePredicateForErrorMessagePart1, getNegativePredicateForErrorMessagePart2, getNegativePredicateForJavadoc, getPredicateForErrorMessagePart1, getPredicateForErrorMessagePart2, getPredicateForJavadoc, getTypeName, hashCode, isArrayType, isCharType, isIterableType, isPrimitiveType, isPrimitiveWrapperType, isPublic, isRealNumberType, isWholeNumberType

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

FieldDescription

public FieldDescription(Field field,
                        com.google.common.reflect.TypeToken<?> owningType)

FieldDescription

public FieldDescription(Field field,
                        Visibility visibility,
                        com.google.common.reflect.TypeToken<?> owningType)

Method Detail

compareTo

public int compareTo(FieldDescription other)

Specified by:

compareTo in interface Comparable<FieldDescription>

getOriginalMember

public Field getOriginalMember()

Overrides:

getOriginalMember in class DataDescription

toString

public String toString()

Overrides:

toString in class DataDescription

isPredicate

public boolean isPredicate()

Specified by:

isPredicate in class DataDescription

getPredicate

public String getPredicate()

Overrides:

getPredicate in class DataDescription

getNegativePredicate

public String getNegativePredicate()

Overrides:

getNegativePredicate in class DataDescription