Class PropertyMapper.Source<T>

java.lang.Object
org.springframework.boot.context.properties.PropertyMapper.Source<T>
Type Parameters:
T - the source type
Enclosing class:
PropertyMapper
public static final class PropertyMapper.Source<T> extends Object
A source that is in the process of being mapped.
Since:
2.0.0
Author:
Phillip Webb, Artsiom Yudovin, Chris Bono, Moritz Halbritter

  • Method Details

    • orFrom

      public PropertyMapper.Source<T> orFrom(Supplier<? extends @Nullable T> fallback)
      Return a source that will use the given supplier to obtain a fallback value to use in place of null.
      Parameters:
      fallback - the fallback supplier
      Returns:
      a new PropertyMapper.Source instance
      Since:
      4.0.0

    • asInt

      public <R extends Number> PropertyMapper.Source<Integer> asInt(PropertyMapper.Source.Adapter<? super T, ? extends R> adapter)
      Return an adapted version of the source with Integer type.
      Type Parameters:
      R - the resulting type
      Parameters:
      adapter - an adapter to convert the current value to a number.
      Returns:
      a new adapted source instance

    • as

      public <R> PropertyMapper.Source<R> as(PropertyMapper.Source.Adapter<? super T, ? extends R> adapter)
      Return an adapted version of the source changed through the given adapter function.
      Type Parameters:
      R - the resulting type
      Parameters:
      adapter - the adapter to apply
      Returns:
      a new adapted source instance

    • whenTrue

      public PropertyMapper.Source<T> whenTrue()
      Return a filtered version of the source that will only map values that are true.
      Returns:
      a new filtered source instance

    • whenFalse

      public PropertyMapper.Source<T> whenFalse()
      Return a filtered version of the source that will only map values that are false.
      Returns:
      a new filtered source instance

    • whenHasText

      public PropertyMapper.Source<T> whenHasText()
      Return a filtered version of the source that will only map values that have a toString() containing actual text.
      Returns:
      a new filtered source instance

    • whenEqualTo

      public PropertyMapper.Source<T> whenEqualTo(@Nullable Object object)
      Return a filtered version of the source that will only map values equal to the specified object.
      Parameters:
      object - the object to match
      Returns:
      a new filtered source instance

    • whenInstanceOf

      public <R extends T> PropertyMapper.Source<R> whenInstanceOf(Class<R> target)
      Return a filtered version of the source that will only map values that are an instance of the given type.
      Type Parameters:
      R - the target type
      Parameters:
      target - the target type to match
      Returns:
      a new filtered source instance

    • whenNot

      public PropertyMapper.Source<T> whenNot(Predicate<T> predicate)
      Return a filtered version of the source that won't map values that match the given predicate.
      Parameters:
      predicate - the predicate used to filter values
      Returns:
      a new filtered source instance

    • when

      public PropertyMapper.Source<T> when(Predicate<T> predicate)
      Return a filtered version of the source that won't map values that don't match the given predicate.
      Parameters:
      predicate - the predicate used to filter values
      Returns:
      a new filtered source instance

    • to

      public void to(Consumer<? super T> consumer)
      Complete the mapping by passing any non-filtered value to the specified consumer. The method is designed to be used with mutable objects.
      Parameters:
      consumer - the consumer that should accept the value if it's not been filtered

    • to

      public <R> R to(R instance, BiFunction<R, ? super T, R> mapper)
      Complete the mapping for any non-filtered value by applying the given function to an existing instance and returning a new one. For filtered values, the instance parameter is returned unchanged. The method is designed to be used with immutable objects.
      Type Parameters:
      R - the result type
      Parameters:
      instance - the current instance
      mapper - the mapping function
      Returns:
      a new mapped instance or the original instance
      Since:
      3.0.0

    • toInstance

      public <R> R toInstance(Function<? super T, R> factory)
      Complete the mapping by creating a new instance from the non-filtered value.
      Type Parameters:
      R - the resulting type
      Parameters:
      factory - the factory used to create the instance
      Returns:
      the instance
      Throws:
      NoSuchElementException - if the value has been filtered

    • toCall

      public void toCall(Runnable runnable)
      Complete the mapping by calling the specified method when the value has not been filtered.
      Parameters:
      runnable - the method to call if the value has not been filtered

    • always

      public PropertyMapper.Source.Always<T> always()
      Return a version of this source that can be used to always complete mappings, even if values are null.
      Returns:
      a new PropertyMapper.Source.Always instance
      Since:
      4.0.0