com.github.valid8j.pcond.validator

Interface MessageComposer

All Known Implementing Classes:

MessageComposer.Default

public interface MessageComposer

An interface that defines methods to compose a message when a value violates a given condition based on a context.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	MessageComposer.Default A default implementation of MessageComposer.

Method Summary

Modifier and Type	Method and Description
<T> String	composeMessageForAssertion(T value, Predicate<? super T> predicate) Compose a message string for a value, which violates a general condition given as predicate.
<T> String	composeMessageForPostcondition(T value, Predicate<? super T> predicate) Compose a message string for a value, which violates a postcondition given as predicate.
<T> String	composeMessageForPrecondition(T value, Predicate<? super T> predicate) Compose a message string for a value, which violates a precondition given as predicate.
<T> String	composeMessageForValidation(T value, Predicate<? super T> predicate) Compose a message string for a value, which violates a user input checking condition given as predicate.

Method Detail

composeMessageForPrecondition

<T> String composeMessageForPrecondition(T value,
                                         Predicate<? super T> predicate)

Compose a message string for a value, which violates a precondition given as predicate.

Type Parameters:

T - The type of the value.

Parameters:

value - A value for which a message is created.

predicate - A condition that a given value violated.

Returns:

A composed message string.

composeMessageForPostcondition

<T> String composeMessageForPostcondition(T value,
                                          Predicate<? super T> predicate)

Compose a message string for a value, which violates a postcondition given as predicate.

Type Parameters:

T - The type of the value.

Parameters:

value - A value for which a message is created.

predicate - A condition that a given value violated.

Returns:

A composed message string.

composeMessageForAssertion

<T> String composeMessageForAssertion(T value,
                                      Predicate<? super T> predicate)

Compose a message string for a value, which violates a general condition given as predicate. Used for invariant conditions, test assertion (assertThat), and test prerequisition checking (assumeThat).

Type Parameters:

T - The type of the value.

Parameters:

value - A value for which a message is created.

predicate - A condition that a given value violated.

Returns:

A composed message string.

composeMessageForValidation

<T> String composeMessageForValidation(T value,
                                       Predicate<? super T> predicate)

Compose a message string for a value, which violates a user input checking condition given as predicate.

Type Parameters:

T - The type of the value.

Parameters:

value - A value for which a message is created.

predicate - A condition that a given value violated.

Returns:

A composed message string.