A C E F G H I M N O P S T V W

A

APACHE_TO_STRING_BUILDER_DEFAULT_STYLE - Static variable in class com.jparams.verifier.tostring.preset.Presets

Pre-set for testing toString generated using Apache's ToStringBuilder using the ToStringStyle.DEFAULT_STYLE.

APACHE_TO_STRING_BUILDER_JSON_STYLE - Static variable in class com.jparams.verifier.tostring.preset.Presets

Pre-set for testing toString generated using Apache's ToStringBuilder using the ToStringStyle.JSON_STYLE.

APACHE_TO_STRING_BUILDER_MULTI_LINE_STYLE - Static variable in class com.jparams.verifier.tostring.preset.Presets

Pre-set for testing toString generated using Apache's ToStringBuilder using the ToStringStyle.MULTI_LINE_STYLE.

APACHE_TO_STRING_BUILDER_NO_CLASS_NAME_STYLE - Static variable in class com.jparams.verifier.tostring.preset.Presets

Pre-set for testing toString generated using Apache's ToStringBuilder using the ToStringStyle.NO_CLASS_NAME_STYLE.

APACHE_TO_STRING_BUILDER_SHORT_PREFIX_STYLE - Static variable in class com.jparams.verifier.tostring.preset.Presets

Pre-set for testing toString generated using Apache's ToStringBuilder using the ToStringStyle.SHORT_PREFIX_STYLE.

ApacheToStringBuilderPreset - Class in com.jparams.verifier.tostring.preset

Preset for org.apache.commons.lang3.builder.ToStringBuilder

ApacheToStringBuilderPreset(ApacheToStringBuilderPreset.Style) - Constructor for class com.jparams.verifier.tostring.preset.ApacheToStringBuilderPreset

ApacheToStringBuilderPreset.Style - Enum in com.jparams.verifier.tostring.preset

See org.apache.commons.lang3.builder.ToStringStyle

apply(ToStringVerifier) - Method in class com.jparams.verifier.tostring.preset.ApacheToStringBuilderPreset

apply(ToStringVerifier) - Method in class com.jparams.verifier.tostring.preset.EclipsePreset

apply(ToStringVerifier) - Method in class com.jparams.verifier.tostring.preset.GuavaPreset

apply(ToStringVerifier) - Method in class com.jparams.verifier.tostring.preset.IntelliJPreset

apply(ToStringVerifier) - Method in interface com.jparams.verifier.tostring.preset.Preset

Apply preset to the verifier

C

ClassNameVerificationError - Class in com.jparams.verifier.tostring.error

ClassNameVerificationError(String) - Constructor for class com.jparams.verifier.tostring.error.ClassNameVerificationError

com.jparams.verifier.tostring - package com.jparams.verifier.tostring

com.jparams.verifier.tostring.error - package com.jparams.verifier.tostring.error

com.jparams.verifier.tostring.preset - package com.jparams.verifier.tostring.preset

E

ECLIPSE - Static variable in class com.jparams.verifier.tostring.preset.Presets

Pre-set for testing toString generated using the Eclipse IDE.

EclipsePreset - Class in com.jparams.verifier.tostring.preset

EclipsePreset() - Constructor for class com.jparams.verifier.tostring.preset.EclipsePreset

ErrorMessageGenerator - Class in com.jparams.verifier.tostring.error

F

FieldFilter - Interface in com.jparams.verifier.tostring

Field filter

FieldValue - Class in com.jparams.verifier.tostring.error

FieldValue(String, String, FieldValue.ErrorType) - Constructor for class com.jparams.verifier.tostring.error.FieldValue

FieldValue.ErrorType - Enum in com.jparams.verifier.tostring.error

FieldValueVerificationError - Class in com.jparams.verifier.tostring.error

FieldValueVerificationError(List<FieldValue>) - Constructor for class com.jparams.verifier.tostring.error.FieldValueVerificationError

forClass(Class<?>) - Static method in class com.jparams.verifier.tostring.ToStringVerifier

Create a verifier for the given class

forClasses(Class<?>...) - Static method in class com.jparams.verifier.tostring.ToStringVerifier

Create a verifier for the given classes

forClasses(Collection<Class<?>>) - Static method in class com.jparams.verifier.tostring.ToStringVerifier

Create a verifier for the given classes

format(T) - Method in interface com.jparams.verifier.tostring.Formatter

Format the item to string

Formatter<T> - Interface in com.jparams.verifier.tostring

Formatter for a data type

forPackage(String, boolean) - Static method in class com.jparams.verifier.tostring.ToStringVerifier

Create a verifier for a given package

forPackage(String, boolean, Predicate<Class<?>>) - Static method in class com.jparams.verifier.tostring.ToStringVerifier

Create a verifier for a given package

G

generateErrorMessage(Class<?>, String, List<VerificationError>) - Static method in class com.jparams.verifier.tostring.error.ErrorMessageGenerator

Generate error message

getErrorType() - Method in class com.jparams.verifier.tostring.error.FieldValue

getFieldName() - Method in class com.jparams.verifier.tostring.error.FieldValue

getMessages() - Method in class com.jparams.verifier.tostring.error.ClassNameVerificationError

getMessages() - Method in class com.jparams.verifier.tostring.error.FieldValueVerificationError

getMessages() - Method in class com.jparams.verifier.tostring.error.HashCodeVerificationError

getMessages() - Method in interface com.jparams.verifier.tostring.error.VerificationError

getName(Class<?>) - Method in enum com.jparams.verifier.tostring.NameStyle

getValue() - Method in class com.jparams.verifier.tostring.error.FieldValue

GUAVA_TO_STRING_HELPER - Static variable in class com.jparams.verifier.tostring.preset.Presets

Pre-set for testing toString generated using Guava's MoreObjects.toStringHelper(...).

GuavaPreset - Class in com.jparams.verifier.tostring.preset

GuavaPreset() - Constructor for class com.jparams.verifier.tostring.preset.GuavaPreset

H

HashCodeProvider - Interface in com.jparams.verifier.tostring

Hash code provider

HashCodeVerificationError - Class in com.jparams.verifier.tostring.error

HashCodeVerificationError(int) - Constructor for class com.jparams.verifier.tostring.error.HashCodeVerificationError

I

INTELLI_J - Static variable in class com.jparams.verifier.tostring.preset.Presets

Pre-set for testing toString generated using the IntelliJ IDE.

IntelliJPreset - Class in com.jparams.verifier.tostring.preset

IntelliJPreset() - Constructor for class com.jparams.verifier.tostring.preset.IntelliJPreset

M

matches(Class<?>, Field) - Method in interface com.jparams.verifier.tostring.FieldFilter

Return true to allow the field to be tested

N

NameStyle - Enum in com.jparams.verifier.tostring

Style of the class name

O

ObjectHashCodeProvider - Class in com.jparams.verifier.tostring

Provides the hash code by calling Object.hashCode()

ObjectHashCodeProvider() - Constructor for class com.jparams.verifier.tostring.ObjectHashCodeProvider

P

Preset - Interface in com.jparams.verifier.tostring.preset

Preset

Presets - Class in com.jparams.verifier.tostring.preset

Presets

provide(Object) - Method in interface com.jparams.verifier.tostring.HashCodeProvider

Provide object hash code

provide(Object) - Method in class com.jparams.verifier.tostring.ObjectHashCodeProvider

provide(Object) - Method in class com.jparams.verifier.tostring.SystemIdentityHashCodeProvider

S

SystemIdentityHashCodeProvider - Class in com.jparams.verifier.tostring

Provides the System identity hash code by calling System.identityHashCode(Object)

SystemIdentityHashCodeProvider() - Constructor for class com.jparams.verifier.tostring.SystemIdentityHashCodeProvider

T

ToStringVerifier - Class in com.jparams.verifier.tostring

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

V

valueOf(String) - Static method in enum com.jparams.verifier.tostring.error.FieldValue.ErrorType

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.jparams.verifier.tostring.NameStyle

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.jparams.verifier.tostring.preset.ApacheToStringBuilderPreset.Style

Returns the enum constant of this type with the specified name.

values() - Static method in enum com.jparams.verifier.tostring.error.FieldValue.ErrorType

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.jparams.verifier.tostring.NameStyle

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.jparams.verifier.tostring.preset.ApacheToStringBuilderPreset.Style

Returns an array containing the constants of this enum type, in the order they are declared.

VerificationError - Interface in com.jparams.verifier.tostring.error

Verification error

verify() - Method in class com.jparams.verifier.tostring.ToStringVerifier

Perform verification

W

withClassName(NameStyle) - Method in class com.jparams.verifier.tostring.ToStringVerifier

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

withFailOnExcludedFields(boolean) - Method in class com.jparams.verifier.tostring.ToStringVerifier

Define how the verifier should behave if the Object.toString() output contains a field that has been explicitly excluded by calling ToStringVerifier.withIgnoredFields(String...) or implicitly excluded by calling ToStringVerifier.withOnlyTheseFields(String...) or ToStringVerifier.withMatchingFields(String).

withFormatter(Class<S>, Formatter<S>) - Method in class com.jparams.verifier.tostring.ToStringVerifier

Define a value formatter for the given class type.

withHashCode(boolean) - Method in class com.jparams.verifier.tostring.ToStringVerifier

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

withHashCodeProvider(HashCodeProvider) - Method in class com.jparams.verifier.tostring.ToStringVerifier

With hash code provider

withIgnoredFields(String...) - Method in class com.jparams.verifier.tostring.ToStringVerifier

If specified, this tester will assert that all but the excluded fields are present in the Object.toString() output.

withIgnoredFields(Collection<String>) - Method in class com.jparams.verifier.tostring.ToStringVerifier

If specified, this tester will assert that all but the excluded fields are present in the Object.toString() output.

withInheritedFields(boolean) - Method in class com.jparams.verifier.tostring.ToStringVerifier

This is enabled by default.

withMatchingFields(String) - Method in class com.jparams.verifier.tostring.ToStringVerifier

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

withMatchingFields(FieldFilter) - Method in class com.jparams.verifier.tostring.ToStringVerifier

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

withNullValue(String) - Method in class com.jparams.verifier.tostring.ToStringVerifier

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

withOnlyTheseFields(String...) - Method in class com.jparams.verifier.tostring.ToStringVerifier

If specified, this tester will only assert that the given fields are present in the Object.toString() output.

withOnlyTheseFields(Collection<String>) - Method in class com.jparams.verifier.tostring.ToStringVerifier

If specified, this tester will only assert that the given fields are present in the Object.toString() output.

withPrefabValue(Class<S>, S) - Method in class com.jparams.verifier.tostring.ToStringVerifier

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

withPreset(Preset) - Method in class com.jparams.verifier.tostring.ToStringVerifier

A number of presets come with this library.

withValueProvider(Class<S>, Function<Path, S>) - Method in class com.jparams.verifier.tostring.ToStringVerifier

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

withValueProvider(Provider) - Method in class com.jparams.verifier.tostring.ToStringVerifier

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

A C E F G H I M N O P S T V W