Class PropertyMapper

java.lang.Object

org.springframework.boot.context.properties.PropertyMapper

public final class PropertyMapper
extends Object

Utility that can be used to map values from a supplied source to a destination. Primarily intended to be help when mapping from @ConfigurationProperties to third-party classes.

Can filter values based on predicates and adapt values if needed. For example:

PropertyMapper map = PropertyMapper.get();
map.from(source::getName)
  .to(destination::setName);
map.from(source::getTimeout)
  .when(this::thisYear)
  .asInt(Duration::getSeconds)
  .to(destination::setTimeoutSecs);
map.from(source::isEnabled)
  .whenFalse().
  .toCall(destination::disable);

Mappings can ultimately be applied to a setter, trigger a method call or create a new instance.

By default null values and any NullPointerException thrown from the supplier are filtered and will not be applied to consumers. If you want to apply nulls, you can use PropertyMapper.Source.always().

Since:

2.0.0

Author:

Phillip Webb, Artsiom Yudovin, Chris Bono, Moritz Halbritter

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	PropertyMapper.Source<T>	A source that is in the process of being mapped.
static interface	PropertyMapper.SourceOperator	An operation that can be applied to a PropertyMapper.Source.

Method Summary

Modifier and Type	Method	Description
PropertyMapper	alwaysApplying(PropertyMapper.SourceOperator operator)	Return a new PropertyMapper instance that applies the given PropertyMapper.SourceOperator to every source.
<T> PropertyMapper.Source<T>	from(@Nullable T value)	Return a new PropertyMapper.Source from the specified value that can be used to perform the mapping.
<T> PropertyMapper.Source<T>	from(Supplier<? extends @Nullable T> supplier)	Return a new PropertyMapper.Source from the specified value supplier that can be used to perform the mapping.
static PropertyMapper	get()	Return the property mapper.

Methods inherited from class Object

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

Method Details

alwaysApplying

public PropertyMapper alwaysApplying(PropertyMapper.SourceOperator operator)

Return a new PropertyMapper instance that applies the given PropertyMapper.SourceOperator to every source.

Parameters:

operator - the source operator to apply

Returns:

a new property mapper instance

from

public <T> PropertyMapper.Source<T> from(@Nullable T value)

Return a new PropertyMapper.Source from the specified value that can be used to perform the mapping.

Type Parameters:

T - the source type

Parameters:

value - the value

Returns:

a PropertyMapper.Source that can be used to complete the mapping

from

public <T> PropertyMapper.Source<T> from(Supplier<? extends @Nullable T> supplier)

Return a new PropertyMapper.Source from the specified value supplier that can be used to perform the mapping.

Type Parameters:

T - the source type

Parameters:

supplier - the value supplier

Returns:

a PropertyMapper.Source that can be used to complete the mapping

See Also:

• from(Object)

get

public static PropertyMapper get()

Return the property mapper.

Returns:

the property mapper