org.springframework.boot.context.properties.bind

Class BindResult<T>

java.lang.Object

org.springframework.boot.context.properties.bind.BindResult<T>

Type Parameters:

T - the result type

public final class BindResult<T>
extends Object

A container object to return the result of a Binder bind operation. May contain either a successfully bound object or an empty result.

Since:

2.0.0

Author:

Phillip Webb, Madhura Bhave

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
T	get() Return the object that was bound or throw a NoSuchElementException if no value was bound.
int	hashCode()
void	ifBound(Consumer<? super T> consumer) Invoke the specified consumer with the bound value, or do nothing if no value has been bound.
boolean	isBound() Returns true if a result was bound.
<U> BindResult<U>	map(Function<? super T,? extends U> mapper) Apply the provided mapping function to the bound value, or return an updated unbound result if no value has been bound.
T	orElse(T other) Return the object that was bound, or other if no value has been bound.
T	orElseCreate(Class<? extends T> type) Deprecated. since 2.2.0 in favor of Binder.bindOrCreate(java.lang.String, java.lang.Class<T>)
T	orElseGet(Supplier<? extends T> other) Return the object that was bound, or the result of invoking other if no value has been bound.
<X extends Throwable> T	orElseThrow(Supplier<? extends X> exceptionSupplier) Return the object that was bound, or throw an exception to be created by the provided supplier if no value has been bound.

Methods inherited from class java.lang.Object

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

Method Detail

get

public T get()
      throws NoSuchElementException

Return the object that was bound or throw a NoSuchElementException if no value was bound.

Returns:

the bound value (never null)

Throws:

NoSuchElementException - if no value was bound

See Also:

isBound()

isBound

public boolean isBound()

Returns true if a result was bound.

Returns:

if a result was bound

ifBound

public void ifBound(Consumer<? super T> consumer)

Invoke the specified consumer with the bound value, or do nothing if no value has been bound.

Parameters:

consumer - block to execute if a value has been bound

map

public <U> BindResult<U> map(Function<? super T,? extends U> mapper)

Apply the provided mapping function to the bound value, or return an updated unbound result if no value has been bound.

Type Parameters:

U - the type of the result of the mapping function

Parameters:

mapper - a mapping function to apply to the bound value. The mapper will not be invoked if no value has been bound.

Returns:

an BindResult describing the result of applying a mapping function to the value of this BindResult.

orElse

public T orElse(T other)

Return the object that was bound, or other if no value has been bound.

Parameters:

other - the value to be returned if there is no bound value (may be null)

Returns:

the value, if bound, otherwise other

orElseGet

public T orElseGet(Supplier<? extends T> other)

Return the object that was bound, or the result of invoking other if no value has been bound.

Parameters:

other - a Supplier of the value to be returned if there is no bound value

Returns:

the value, if bound, otherwise the supplied other

orElseCreate

@Deprecated
public T orElseCreate(Class<? extends T> type)

Deprecated. since 2.2.0 in favor of Binder.bindOrCreate(java.lang.String, java.lang.Class<T>)

Return the object that was bound, or a new instance of the specified class if no value has been bound.

Parameters:

type - the type to create if no value was bound

Returns:

the value, if bound, otherwise a new instance of type

orElseThrow

public <X extends Throwable> T orElseThrow(Supplier<? extends X> exceptionSupplier)
                                    throws X extends Throwable

Return the object that was bound, or throw an exception to be created by the provided supplier if no value has been bound.

Type Parameters:

X - the type of the exception to be thrown

Parameters:

exceptionSupplier - the supplier which will return the exception to be thrown

Returns:

the present value

Throws:

X - if there is no value present

X extends Throwable

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object