Package reactor.test

Interface ValueFormatters.Extractor<CONTAINER>

Type Parameters:

CONTAINER - the type of container

All Superinterfaces:

BiFunction<Object,Function<Object,String>,String>, Predicate<Object>

Enclosing class:

ValueFormatters

public static interface ValueFormatters.Extractor<CONTAINER>
extends Predicate<Object>, BiFunction<Object,Function<Object,String>,String>

An extractor of data wrapped in a BiFunction aiming at producing a customized String representation of a container type and its contained elements, each element being potentially itself converted to String using a ValueFormatters.ToStringConverter:

• it only considers specific container types, see getTargetClass()
• it can further filter these container instances using matches(Object)
• it can be applied to arbitrary objects, as it will default to String.valueOf(Object) on non-matching containers
• it can apply a ValueFormatters.ToStringConverter to the content, passed as the second parameter of the BiFunction
• it reconstructs the String representation of the container by exploding it and then joining it with {#code ", "} delimiter, as well as custom prefix(Object) and suffix(Object)

Method Summary

Modifier and Type	Method	Description
default @Nullable String	apply(Object target, Function<Object,String> contentFormatter)	Given an arbitrary object and a ValueFormatters.ToStringConverter, if the object passes the test(Object), extract elements from it and convert them using the ValueFormatters.ToStringConverter, joining the result together to obtain a customized String representation of both the container and its contents.
Stream<Object>	explode(CONTAINER original)	Explode the container into a Stream of Object, each of which is a candidate for individual String conversion by a ValueFormatters.ToStringConverter when applied as a BiFunction.
Class<CONTAINER>	getTargetClass()	Return the targeted container Class.
default boolean	matches(CONTAINER value)	An additional test to perform on a matching container to further decide to convert it or not.
default String	prefix(CONTAINER original)	Return the prefix to use in the container's String representation, given the original container.
default String	suffix(CONTAINER original)	Return the suffix to use in the container's String representation, given the original container.
default boolean	test(Object o)	Test if an object is a container that can be extracted and converted by this ValueFormatters.Extractor.

Methods inherited from interface java.util.function.BiFunction

andThen

Methods inherited from interface java.util.function.Predicate

and, negate, or

Method Details

getTargetClass

Class<CONTAINER> getTargetClass()

Return the targeted container Class. The BiFunction shouldn't be applied to objects that are not of that class, although it will default to using String.valueOf(Object) on them. This verification is included in test(Object).

Returns:

the target container Class

matches

default boolean matches(CONTAINER value)

An additional test to perform on a matching container to further decide to convert it or not. The BiFunction shouldn't be applied to container that do not match that predicate, although it will default to using String.valueOf(Object) on them. This verification is included in test(Object).

Defaults to always matching instances of the target Class.

Parameters:

value - the candidate container

Returns:

true if it can be extracted and converted, false otherwise

prefix

default String prefix(CONTAINER original)

Return the prefix to use in the container's String representation, given the original container.

Defaults to "[".

Parameters:

original - the original container

Returns:

the prefix to use

suffix

default String suffix(CONTAINER original)

Return the suffix to use in the container's String representation, given the original container.

Defaults to "]".

Parameters:

original - the original container

Returns:

the suffix to use

explode

Stream<Object> explode(CONTAINER original)

Explode the container into a Stream of Object, each of which is a candidate for individual String conversion by a ValueFormatters.ToStringConverter when applied as a BiFunction.

Parameters:

original - the container to extract contents from

Returns:

the Stream of elements contained in the container

test

default boolean test(Object o)

Test if an object is a container that can be extracted and converted by this ValueFormatters.Extractor. Defaults to testing getTargetClass() and matches(Object). The BiFunction shouldn't be applied to objects that do not match this test, although it will default to using String.valueOf(Object) on them.

Specified by:

test in interface Predicate<CONTAINER>

Parameters:

o - the arbitrary object to test.

Returns:

true if the object can be extracted and converted to String

apply

default @Nullable String apply(Object target,
 Function<Object,String> contentFormatter)

Given an arbitrary object and a ValueFormatters.ToStringConverter, if the object passes the test(Object), extract elements from it and convert them using the ValueFormatters.ToStringConverter, joining the result together to obtain a customized String representation of both the container and its contents. Any object that doesn't match this ValueFormatters.Extractor is naively transformed using String.valueOf(Object), use test(Object) to avoid that when choosing between multiple ValueFormatters.Extractor.

Specified by:

apply in interface BiFunction<Object,Function<Object,String>,String>

Parameters:

target - the arbitrary object to potentially convert.

contentFormatter - the ValueFormatters.ToStringConverter to apply on each element contained in the target

Returns:

the String representation of the target, customized as needed