org.assertj.assertions.generator.description

Class GetterDescription

java.lang.Object

org.assertj.assertions.generator.description.DataDescription

org.assertj.assertions.generator.description.GetterDescription

All Implemented Interfaces:

Comparable<GetterDescription>

public class GetterDescription
extends DataDescription
implements Comparable<GetterDescription>

Stores the information needed to generate an assertion for a public getter method.

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

 public int getAge()
 

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

• the property name, here "age"
• property valueType

Note that Person doesn't need to have an age field, just the getAge method.

Author:

Joel Costigliola

Field Summary

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

visibility

Constructor Summary

Constructors

Constructor and Description
GetterDescription(String propertyName, com.google.common.reflect.TypeToken<?> owningType, Method method)

Method Summary

Modifier and Type	Method and Description
int	compareTo(GetterDescription other)
com.google.common.collect.ImmutableList<com.google.common.reflect.TypeToken<? extends Throwable>>	getExceptions()
Method	getOriginalMember()
boolean	isPredicate()

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

GetterDescription

public GetterDescription(String propertyName,
                         com.google.common.reflect.TypeToken<?> owningType,
                         Method method)

Method Detail

getOriginalMember

public Method getOriginalMember()

Overrides:

getOriginalMember in class DataDescription

compareTo

public int compareTo(GetterDescription other)

Specified by:

compareTo in interface Comparable<GetterDescription>

getExceptions

public com.google.common.collect.ImmutableList<com.google.common.reflect.TypeToken<? extends Throwable>> getExceptions()

isPredicate

public boolean isPredicate()

Specified by:

isPredicate in class DataDescription