com.jparams.verifier.tostring

Class ToStringVerifier

java.lang.Object

com.jparams.verifier.tostring.ToStringVerifier

public final class ToStringVerifier
extends java.lang.Object

ToStringVerifier can be used in unit tests to verify that the Object.toString() returns the desired results.

To get started, use ToStringVerifier as follows:

ToStringVerifier.forClass(MyClass.class).verify();

Method Summary

Modifier and Type	Method and Description
static ToStringVerifier	forClass(java.lang.Class<?> clazz) Create a verifier for the given class
static ToStringVerifier	forClasses(java.lang.Class<?>... classes) Create a verifier for the given classes
static ToStringVerifier	forClasses(java.util.Collection<java.lang.Class<?>> classes) Create a verifier for the given classes
static ToStringVerifier	forPackage(java.lang.String packageName, boolean scanRecursively) Create a verifier for a given package
static ToStringVerifier	forPackage(java.lang.String packageName, boolean scanRecursively, java.util.function.Predicate<java.lang.Class<?>> predicate) Create a verifier for a given package
void	verify() Perform verification
ToStringVerifier	withClassName(NameStyle nameStyle) If specified, this tester will assert that the Object.toString() output contains the name of the subject class in the NameStyle specified.
ToStringVerifier	withFailOnExcludedFields(boolean failOnExcludedFields) Define how the verifier should behave if the Object.toString() output contains a field that has been explicitly excluded by calling withIgnoredFields(String...) or implicitly excluded by calling withOnlyTheseFields(String...) or withMatchingFields(String).
<S> ToStringVerifier	withFormatter(java.lang.Class<S> clazz, Formatter<S> formatter) Define a value formatter for the given class type.
ToStringVerifier	withHashCode(boolean hashCode) If set to true, this tester will assert that the Object.toString() output contains the hash code as returned by Object.hashCode().
ToStringVerifier	withHashCodeProvider(HashCodeProvider hashCodeProvider) With hash code provider
ToStringVerifier	withIgnoredFields(java.util.Collection<java.lang.String> fields) If specified, this tester will assert that all but the excluded fields are present in the Object.toString() output.
ToStringVerifier	withIgnoredFields(java.lang.String... fields) If specified, this tester will assert that all but the excluded fields are present in the Object.toString() output.
ToStringVerifier	withInheritedFields(boolean inheritedFields) This is enabled by default.
ToStringVerifier	withMatchingFields(FieldFilter fields) If specified, this tester will only assert that field matching this filter criteria are present in the Object.toString() output.
ToStringVerifier	withMatchingFields(java.lang.String regex) If specified, this tester will only assert that field names matching this regex pattern are present in the Object.toString() output.
ToStringVerifier	withNullValue(java.lang.String nullValue) The value to expect on the toString output when a field value is null.
ToStringVerifier	withOnlyTheseFields(java.util.Collection<java.lang.String> fields) If specified, this tester will only assert that the given fields are present in the Object.toString() output.
ToStringVerifier	withOnlyTheseFields(java.lang.String... fields) If specified, this tester will only assert that the given fields are present in the Object.toString() output.
<S> ToStringVerifier	withPrefabValue(java.lang.Class<S> clazz, S prefabValue) Adds prefabricated values for instance fields of classes that ToStringVerifier cannot instantiate by itself.
ToStringVerifier	withPreset(Preset preset) A number of presets come with this library.
<S> ToStringVerifier	withValueProvider(java.lang.Class<S> clazz, java.util.function.Function<com.jparams.object.builder.path.Path,S> valueSupplier) Adds value provider values for instance fields of classes that ToStringVerifier cannot instantiate by itself.
ToStringVerifier	withValueProvider(com.jparams.object.builder.provider.Provider provider) Adds value provider values for instance fields of classes that ToStringVerifier cannot instantiate by itself.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

forClass

public static ToStringVerifier forClass(java.lang.Class<?> clazz)

Create a verifier for the given class

Parameters:

clazz - class to test

Returns:

verifier

forClasses

public static ToStringVerifier forClasses(java.lang.Class<?>... classes)

Create a verifier for the given classes

Parameters:

classes - classes to test

Returns:

verifier

forClasses

public static ToStringVerifier forClasses(java.util.Collection<java.lang.Class<?>> classes)

Create a verifier for the given classes

Parameters:

classes - classes to test

Returns:

verifier

forPackage

public static ToStringVerifier forPackage(java.lang.String packageName,
                                          boolean scanRecursively)

Create a verifier for a given package

Parameters:

packageName - package under test

scanRecursively - true to scan all sub-packages

Returns:

verifier

forPackage

public static ToStringVerifier forPackage(java.lang.String packageName,
                                          boolean scanRecursively,
                                          java.util.function.Predicate<java.lang.Class<?>> predicate)

Create a verifier for a given package

Parameters:

packageName - package under test

scanRecursively - true to scan all sub-packages

predicate - defines which classes will be tested

Returns:

verifier

withPreset

public ToStringVerifier withPreset(Preset preset)

A number of presets come with this library. For pre-made presets, see Presets. A preset is a pre-defined configuration for the ToStringVerifier.

Parameters:

preset - preset

Returns:

verifier

withClassName

public ToStringVerifier withClassName(NameStyle nameStyle)

If specified, this tester will assert that the Object.toString() output contains the name of the subject class in the NameStyle specified.

Parameters:

nameStyle - style of the class name

Returns:

verifier

withHashCode

public ToStringVerifier withHashCode(boolean hashCode)

If set to true, this tester will assert that the Object.toString() output contains the hash code as returned by Object.hashCode().

Parameters:

hashCode - check for inclusion of the hash code

Returns:

verifier

withInheritedFields

public ToStringVerifier withInheritedFields(boolean inheritedFields)

This is enabled by default. Set this to false to ignore fields inherited from the parent class.

Parameters:

inheritedFields - true to test for fields inherited from the parent class

Returns:

verifier

withOnlyTheseFields

public ToStringVerifier withOnlyTheseFields(java.lang.String... fields)

If specified, this tester will only assert that the given fields are present in the Object.toString() output. To assert all fields are present, do not call this method. To test for all fields excluding some, call withIgnoredFields(Collection).

Parameters:

fields - field names to include in test

Returns:

verifier

withOnlyTheseFields

public ToStringVerifier withOnlyTheseFields(java.util.Collection<java.lang.String> fields)

If specified, this tester will only assert that the given fields are present in the Object.toString() output. To assert all fields are present, do not call this method. To test for all fields excluding some, call withIgnoredFields(Collection).

Parameters:

fields - field names to include in test

Returns:

verifier

withIgnoredFields

public ToStringVerifier withIgnoredFields(java.lang.String... fields)

If specified, this tester will assert that all but the excluded fields are present in the Object.toString() output. To assert only certain fields are present, do not call this method, instead use withOnlyTheseFields(Collection).

Parameters:

fields - field names to exclude in test

Returns:

verifier

withIgnoredFields

public ToStringVerifier withIgnoredFields(java.util.Collection<java.lang.String> fields)

If specified, this tester will assert that all but the excluded fields are present in the Object.toString() output. To assert only certain fields are present, do not call this method, instead use withOnlyTheseFields(Collection).

Parameters:

fields - field names to exclude in test

Returns:

verifier

withMatchingFields

public ToStringVerifier withMatchingFields(java.lang.String regex)

If specified, this tester will only assert that field names matching this regex pattern are present in the Object.toString() output.

Parameters:

regex - field name match regex

Returns:

verifier

withMatchingFields

public ToStringVerifier withMatchingFields(FieldFilter fields)

If specified, this tester will only assert that field matching this filter criteria are present in the Object.toString() output.

Parameters:

fields - filter criteria

Returns:

verifier

withFailOnExcludedFields

public ToStringVerifier withFailOnExcludedFields(boolean failOnExcludedFields)

Define how the verifier should behave if the Object.toString() output contains a field that has been explicitly excluded by calling withIgnoredFields(String...) or implicitly excluded by calling withOnlyTheseFields(String...) or withMatchingFields(String). By default, the verifier will not test for the presence of the excluded fields and will not fail if they exist in the Object.toString() output when they should not. You can change this behaviour by setting failOnExcludedFields to true.

Parameters:

failOnExcludedFields - fail if ignored fields are found in the Object.toString() output

Returns:

verifier

withPrefabValue

public <S> ToStringVerifier withPrefabValue(java.lang.Class<S> clazz,
                                            S prefabValue)

Adds prefabricated values for instance fields of classes that ToStringVerifier cannot instantiate by itself.

Type Parameters:

S - The class of the prefabricated values.

Parameters:

clazz - The class of the prefabricated values

prefabValue - An instance of S.

Returns:

verifier

withValueProvider

public <S> ToStringVerifier withValueProvider(java.lang.Class<S> clazz,
                                              java.util.function.Function<com.jparams.object.builder.path.Path,S> valueSupplier)

Adds value provider values for instance fields of classes that ToStringVerifier cannot instantiate by itself.

Type Parameters:

S - The class of the prefabricated values.

Parameters:

clazz - The class of the value to being supplied

valueSupplier - value supplier

Returns:

verifier

withValueProvider

public ToStringVerifier withValueProvider(com.jparams.object.builder.provider.Provider provider)

Adds value provider values for instance fields of classes that ToStringVerifier cannot instantiate by itself.

Parameters:

provider - Value provider

Returns:

verifier

withFormatter

public <S> ToStringVerifier withFormatter(java.lang.Class<S> clazz,
                                          Formatter<S> formatter)

Define a value formatter for the given class type.

Type Parameters:

S - value type

Parameters:

clazz - class

formatter - formatter

Returns:

verifier

withNullValue

public ToStringVerifier withNullValue(java.lang.String nullValue)

The value to expect on the toString output when a field value is null. This defaults to null

Parameters:

nullValue - null value

Returns:

verifier

withHashCodeProvider

public ToStringVerifier withHashCodeProvider(HashCodeProvider hashCodeProvider)

With hash code provider

Parameters:

hashCodeProvider - hash code provider

Returns:

verifier

verify

public void verify()

Perform verification

Throws:

java.lang.AssertionError - if assertion conditions are not met