Uses of Annotation Interface
nl.jqno.equalsverifier.CheckReturnValue

Packages that use CheckReturnValue

Package	Description
nl.jqno.equalsverifier
nl.jqno.equalsverifier.api

Uses of CheckReturnValue in nl.jqno.equalsverifier

Methods in nl.jqno.equalsverifier with annotations of type CheckReturnValue

Modifier and Type	Method	Description
static ConfiguredEqualsVerifier	EqualsVerifier.configure()	Creates a configuration object that can be reused with EqualsVerifier for multiple classes.
static <T> SingleTypeEqualsVerifierApi<T>	EqualsVerifier.forClass(Class<T> type)	Factory method.
static MultipleTypeEqualsVerifierApi	EqualsVerifier.forClasses(Class<?> first, Class<?> second, Class<?>... more)	Factory method.
static MultipleTypeEqualsVerifierApi	EqualsVerifier.forClasses(Iterable<Class<?>> classes)	Factory method.
static <T> SingleTypeEqualsVerifierApi<T>	EqualsVerifier.forExamples(T red, T blue)	Factory method.
static MultipleTypeEqualsVerifierApi	EqualsVerifier.forPackage(String packageName, ScanOption... options)	Factory method.
static <T> RelaxedEqualsVerifierApi<T>	EqualsVerifier.forRelaxedEqualExamples(T first, T second, T... more)	Factory method.
static ConfiguredEqualsVerifier	EqualsVerifier.simple()	Creates a configuration object that is pre-configured so that it can be used with most IDE-generated equals and hashCode methods without any further configuration.

Uses of CheckReturnValue in nl.jqno.equalsverifier.api

Methods in nl.jqno.equalsverifier.api with annotations of type CheckReturnValue

Modifier and Type	Method	Description
SingleTypeEqualsVerifierApi<T>	RelaxedEqualsVerifierApi.andUnequalExample(T example)	Asks for an unequal instance of T and subsequently returns a fully constructed instance of EqualsVerifier.
final SingleTypeEqualsVerifierApi<T>	RelaxedEqualsVerifierApi.andUnequalExamples(T first, T... more)	Asks for a list of unequal instances of T and subsequently returns a fully constructed instance of EqualsVerifier.
ConfiguredEqualsVerifier	ConfiguredEqualsVerifier.copy()	Returns a copy of the configuration.
<T> SingleTypeEqualsVerifierApi<T>	ConfiguredEqualsVerifier.forClass(Class<T> type)	Factory method.
MultipleTypeEqualsVerifierApi	ConfiguredEqualsVerifier.forClasses(Class<?> first, Class<?> second, Class<?>... more)	Factory method.
MultipleTypeEqualsVerifierApi	ConfiguredEqualsVerifier.forClasses(Iterable<Class<?>> classes)	Factory method.
<T> SingleTypeEqualsVerifierApi<T>	ConfiguredEqualsVerifier.forExamples(T red, T blue)	Factory method.
MultipleTypeEqualsVerifierApi	ConfiguredEqualsVerifier.forPackage(String packageName, ScanOption... options)	Factory method.
MultipleTypeEqualsVerifierApi	MultipleTypeEqualsVerifierApi.set(Mode... modes)	Sets modes that influence how EqualsVerifier operates.
SingleTypeEqualsVerifierApi<T>	SingleTypeEqualsVerifierApi.set(Mode... modes)	Sets modes that influence how EqualsVerifier operates.
ConfiguredEqualsVerifier	ConfiguredEqualsVerifier.suppress(Warning... warnings)	Suppresses warnings given by EqualsVerifier.
MultipleTypeEqualsVerifierApi	MultipleTypeEqualsVerifierApi.suppress(Warning... warnings)	Suppresses warnings given by EqualsVerifier.
SingleTypeEqualsVerifierApi<T>	SingleTypeEqualsVerifierApi.suppress(Warning... warnings)	Suppresses warnings given by EqualsVerifier.
ConfiguredEqualsVerifier	ConfiguredEqualsVerifier.usingGetClass()	Signals that getClass is used in the implementation of the equals method, instead of an instanceof check.
MultipleTypeEqualsVerifierApi	MultipleTypeEqualsVerifierApi.usingGetClass()	Signals that getClass is used in the implementation of the equals method, instead of an instanceof check.
SingleTypeEqualsVerifierApi<T>	SingleTypeEqualsVerifierApi.usingGetClass()	Signals that getClass is used in the implementation of the equals method, instead of an instanceof check.
SingleTypeEqualsVerifierApi<T>	SingleTypeEqualsVerifierApi.withCachedHashCode(String cachedHashCodeField, String calculateHashCodeMethod, T example)	Signals that T caches its hashCode, instead of re-calculating it each time the hashCode() method is called.
SingleTypeEqualsVerifierApi<T>	SingleTypeEqualsVerifierApi.withFactory(InstanceFactory<T> factory)	Provides a factory for the class under test, in case EqualsVerifier is unable to instantiate it without help.
ConfiguredEqualsVerifier	ConfiguredEqualsVerifier.withFieldnameToGetterConverter(Function<String,String> converter)
MultipleTypeEqualsVerifierApi	MultipleTypeEqualsVerifierApi.withFieldnameToGetterConverter(Function<String,String> converter)	Determines how a getter name can be derived from a field name.
SingleTypeEqualsVerifierApi<T>	SingleTypeEqualsVerifierApi.withFieldnameToGetterConverter(Function<String,String> converter)	Determines how a getter name can be derived from a field name.
<S> ConfiguredEqualsVerifier	ConfiguredEqualsVerifier.withGenericPrefabValues(Class<S> otherType, Func.Func1<?,S> factory)	Adds a factory to generate prefabricated values for instance fields of classes with 1 generic type parameter that EqualsVerifier cannot instantiate by itself.
<S> ConfiguredEqualsVerifier	ConfiguredEqualsVerifier.withGenericPrefabValues(Class<S> otherType, Func.Func2<?,?,S> factory)	Adds a factory to generate prefabricated values for instance fields of classes with 2 generic type parameters that EqualsVerifier cannot instantiate by itself.
<S> MultipleTypeEqualsVerifierApi	MultipleTypeEqualsVerifierApi.withGenericPrefabValues(Class<S> otherType, Func.Func1<?,S> factory)	Adds a factory to generate prefabricated values for instance fields of classes with 1 generic type parameter that EqualsVerifier cannot instantiate by itself.
<S> MultipleTypeEqualsVerifierApi	MultipleTypeEqualsVerifierApi.withGenericPrefabValues(Class<S> otherType, Func.Func2<?,?,S> factory)	Adds a factory to generate prefabricated values for instance fields of classes with 2 generic type parameters that EqualsVerifier cannot instantiate by itself.
<S> SingleTypeEqualsVerifierApi<T>	SingleTypeEqualsVerifierApi.withGenericPrefabValues(Class<S> otherType, Func.Func1<?,S> factory)	Adds a factory to generate prefabricated values for instance fields of classes with 1 generic type parameter that EqualsVerifier cannot instantiate by itself.
<S> SingleTypeEqualsVerifierApi<T>	SingleTypeEqualsVerifierApi.withGenericPrefabValues(Class<S> otherType, Func.Func2<?,?,S> factory)	Adds a factory to generate prefabricated values for instance fields of classes with 2 generic type parameters that EqualsVerifier cannot instantiate by itself.
SingleTypeEqualsVerifierApi<T>	SingleTypeEqualsVerifierApi.withIgnoredAnnotations(Class<?>... annotations)	Signals that all given annotations are to be ignored by EqualsVerifier.
SingleTypeEqualsVerifierApi<T>	SingleTypeEqualsVerifierApi.withIgnoredFields(String... fields)	Signals that all given fields are not relevant for the equals contract.
SingleTypeEqualsVerifierApi<T>	SingleTypeEqualsVerifierApi.withLombokCachedHashCode(T example)	Signals that T uses Lombok to cache its hashCode, instead of re-calculating it each time the hashCode() method is called.
SingleTypeEqualsVerifierApi<T>	SingleTypeEqualsVerifierApi.withNonnullFields(String... fields)	Signals that all given fields can never be null, and EqualsVerifier therefore doesn't have to verify that proper null checks are in place for these fields.
SingleTypeEqualsVerifierApi<T>	SingleTypeEqualsVerifierApi.withOnlyTheseFields(String... fields)	Signals that all given fields, and only the given fields, are relevant for the equals contract.
<S> ConfiguredEqualsVerifier	ConfiguredEqualsVerifier.withPrefabValues(Class<S> otherType, S red, S blue)	Adds prefabricated values for instance fields of classes that EqualsVerifier cannot instantiate by itself.
<S> ConfiguredEqualsVerifier	ConfiguredEqualsVerifier.withPrefabValues(Class<S> otherType, S red, S blue, S redCopy)	Adds prefabricated values for instance fields of classes that EqualsVerifier cannot instantiate by itself.
<S> MultipleTypeEqualsVerifierApi	MultipleTypeEqualsVerifierApi.withPrefabValues(Class<S> otherType, S red, S blue)	Adds prefabricated values for instance fields of classes that EqualsVerifier cannot instantiate by itself.
<S> MultipleTypeEqualsVerifierApi	MultipleTypeEqualsVerifierApi.withPrefabValues(Class<S> otherType, S red, S blue, S redCopy)	Adds prefabricated values for instance fields of classes that EqualsVerifier cannot instantiate by itself.
<S> SingleTypeEqualsVerifierApi<T>	SingleTypeEqualsVerifierApi.withPrefabValues(Class<S> otherType, S red, S blue)	Adds prefabricated values for instance fields of classes that EqualsVerifier cannot instantiate by itself.
<S> SingleTypeEqualsVerifierApi<T>	SingleTypeEqualsVerifierApi.withPrefabValues(Class<S> otherType, S red, S blue, S redCopy)	Adds prefabricated values for instance fields of classes that EqualsVerifier cannot instantiate by itself.
<S> SingleTypeEqualsVerifierApi<T>	SingleTypeEqualsVerifierApi.withPrefabValuesForField(String fieldName, S red, S blue)	Adds prefabricated values for instance fields with a given name (and only the fields with the given name) that EqualsVerifier cannot instantiate by itself.
<S> SingleTypeEqualsVerifierApi<T>	SingleTypeEqualsVerifierApi.withPrefabValuesForField(String fieldName, S red, S blue, S redCopy)	Adds prefabricated values for instance fields with a given name (and only the fields with the given name) that EqualsVerifier cannot instantiate by itself.
SingleTypeEqualsVerifierApi<T>	SingleTypeEqualsVerifierApi.withRedefinedSubclass(Class<? extends T> subclass)	Supplies a reference to a subclass of T in which equals is overridden.
SingleTypeEqualsVerifierApi<T>	SingleTypeEqualsVerifierApi.withRedefinedSubclass(InstanceFactory<? extends T> subclassFactory)	Supplies a factory for a subclass of T in which equals is overridden.
SingleTypeEqualsVerifierApi<T>	SingleTypeEqualsVerifierApi.withRedefinedSuperclass()	Signals that T is part of an inheritance hierarchy where equals is overridden.
SingleTypeEqualsVerifierApi<T>	SingleTypeEqualsVerifierApi.withRedefinedSuperclass(InstanceFactory<?> superclassFactory)	Signals that T is part of an inheritance hierarchy where equals is overridden.
<S> ConfiguredEqualsVerifier	ConfiguredEqualsVerifier.withResettablePrefabValues(Class<S> otherType, Supplier<S> red, Supplier<S> blue)	Adds Suppliers for resettable prefabricated values for instance fields of classes that EqualsVerifier cannot instantiate by itself.
<S> MultipleTypeEqualsVerifierApi	MultipleTypeEqualsVerifierApi.withResettablePrefabValues(Class<S> otherType, Supplier<S> red, Supplier<S> blue)	Adds Suppliers for resettable prefabricated values for instance fields of classes that EqualsVerifier cannot instantiate by itself.
<S> SingleTypeEqualsVerifierApi<T>	SingleTypeEqualsVerifierApi.withResettablePrefabValues(Class<S> otherType, Supplier<S> red, Supplier<S> blue)	Adds Suppliers for resettable prefabricated values for instance fields of classes that EqualsVerifier cannot instantiate by itself.