Package de.odrotbohm.spring.web.model

Class MappedPayloads.MappedPayload<T>

java.lang.Object

de.odrotbohm.spring.web.model.MappedPayloads.MappedErrors

de.odrotbohm.spring.web.model.MappedPayloads.MappedPayload<T>

Enclosing interface:

MappedPayloads

public static class MappedPayloads.MappedPayload<T>
extends MappedPayloads.MappedErrors

A monadic type to work with a mapped payload alongside Errors to build up pipelines to eventually result in an HttpEntity based on the processing steps.

Author:

Oliver Drotbohm

Field Summary

Fields inherited from class de.odrotbohm.spring.web.model.MappedPayloads.MappedErrors

onErrors

Method Summary

Modifier and Type	Method	Description
org.springframework.http.HttpEntity<?>	concludeIfValid(BiFunction<? super T,org.springframework.validation.Errors,? extends org.springframework.http.ResponseEntity<?>> finalizer)	Concludes the processing of the current payload with the given finalizer, but automatically produces an error response via the callbacks registered for onErrors(java.util.function.Function<org.springframework.validation.Errors, org.springframework.http.ResponseEntity<?>>) and onAbsence.
<S, R extends org.springframework.http.ResponseEntity<? extends S>> R	concludeIfValid(Function<? super T,R> finalizer)	Concludes the processing of the current payload with the given finalizer, but automatically produces an error response via the callbacks registered for onErrors(java.util.function.Function<org.springframework.validation.Errors, org.springframework.http.ResponseEntity<?>>) and onAbsence.
org.springframework.http.HttpEntity<?>	concludeSelfIfValid(BiFunction<? super T,MappedPayloads.MappedErrors,? extends org.springframework.http.ResponseEntity<?>> finalizer)	Concludes the processing of the current payload with the given finalizer, but automatically produces an error response via the callbacks registered for onErrors(java.util.function.Function<org.springframework.validation.Errors, org.springframework.http.ResponseEntity<?>>) and onAbsence.
org.springframework.http.HttpEntity<?>	concludeWithoutContent()	Terminal operation that produces an empty response with HttpStatus.NO_CONTENT.
protected Optional<org.springframework.http.ResponseEntity<?>>	errorsOrNone()
<S> MappedPayloads.MappedPayload<S>	flatMap(Function<? super T,Optional<S>> mapper)
<S> MappedPayloads.MappedPayload<S>	flatMapIfValid(Function<? super T,Optional<S>> mapper)
<S> MappedPayloads.MappedPayload<S>	map(BiFunction<? super T,org.springframework.validation.Errors,S> mapper)
<S> MappedPayloads.MappedPayload<S>	map(Function<? super T,S> mapper)	Applies the given Function, even if errors have been accumulated.
<S> MappedPayloads.MappedPayload<S>	mapIfValid(BiFunction<? super T,org.springframework.validation.Errors,S> mapper)
<S> MappedPayloads.MappedPayload<S>	mapIfValid(Function<? super T,S> mapper)	Applies the given Function if no errors have been accumulated or we're on a path to a HttpStatus.NOT_FOUND yet.
MappedPayloads.MappedPayload<T>	notFoundIf(boolean guard)	Switches the MappedPayloads.MappedPayload to unconditionally produce an HttpEntity with status code HttpStatus.NOT_FOUND.
MappedPayloads.MappedPayload<T>	notFoundIf(Predicate<? super T> predicate)	Turns the MappedPayloads.MappedPayload to unconditionally produce an HttpEntity with status code HttpStatus.NOT_FOUND if the given predicate on the payload matches.
MappedPayloads.MappedPayload<T>	onAbsence(Supplier<org.springframework.http.ResponseEntity<?>> callback)	Registers a Function to create an ResponseEntity in case the pipeline yields the absence of a payload.
MappedPayloads.MappedPayload<T>	onAbsenceReject(String field, String errorCode)	Registers the given field to be rejected on payload absence.
MappedPayloads.MappedPayload<T>	onErrors(Function<org.springframework.validation.Errors,org.springframework.http.ResponseEntity<?>> callback)	Registers a Function to eventually turn an Errors instance into an HttpEntity.
MappedPayloads.MappedPayload<T>	onErrors(Supplier<org.springframework.http.ResponseEntity<?>> callback)
MappedPayloads.MappedPayload<T>	peek(BiConsumer<? super T,org.springframework.validation.Errors> consumer)
MappedPayloads.MappedPayload<T>	peek(Consumer<? super T> consumer)
MappedPayloads.MappedPayload<T>	peekIfValid(BiConsumer<? super T,org.springframework.validation.Errors> consumer)	Peeks at the given payload and Errors if no errors have been accumulated or we're on a path to a HttpStatus.NOT_FOUND yet.
MappedPayloads.MappedPayload<T>	peekIfValid(Consumer<? super T> consumer)	Peeks at the payload if present and no errors have been accumulated or we're on a path to a HttpStatus.NOT_FOUND yet.
MappedPayloads.MappedPayload<T>	rejectField(boolean condition, String field, String errorCode)	Rejects the field with the given name with the given error code if the given condition is true.
MappedPayloads.MappedPayload<T>	rejectField(boolean condition, String field, String errorCode, Function<org.springframework.validation.Errors,org.springframework.http.ResponseEntity<?>> errorHandler)	Rejects the field with the given name with the given error code if the given condition is true.
MappedPayloads.MappedPayload<T>	rejectField(String field, String errorCode)	Rejects the field of the given name with the given error code.
MappedPayloads.MappedPayload<T>	rejectField(String field, String errorCode, String defaultMessage)	Rejects the field with the given name with the given error code and default message.
MappedPayloads.MappedPayload<T>	rejectField(Predicate<T> condition, String field, String errorCode)	Rejects the field with the given name with the given error code if the given condition predicate returns true.
MappedPayloads.MappedPayload<T>	validate(BiConsumer<? super T,org.springframework.validation.Errors> validator)	Syntactic sugar to invoke validations in a readable way.

Methods inherited from class de.odrotbohm.spring.web.model.MappedPayloads.MappedErrors

onValidGet, peekErrors, toBadRequest, with

Methods inherited from class java.lang.Object

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

Method Details

notFoundIf

public MappedPayloads.MappedPayload<T> notFoundIf(boolean guard)

Switches the MappedPayloads.MappedPayload to unconditionally produce an HttpEntity with status code HttpStatus.NOT_FOUND. Customize the eventual creation of that using onAbsence(Supplier).

Parameters:

guard - whether to end up with HttpStatus.NOT_FOUND or not.

Returns:

will never be null.

See Also:

• onAbsence(Supplier)

notFoundIf

public MappedPayloads.MappedPayload<T> notFoundIf(Predicate<? super T> predicate)

Turns the MappedPayloads.MappedPayload to unconditionally produce an HttpEntity with status code HttpStatus.NOT_FOUND if the given predicate on the payload matches. Customize the eventual creation of that using onAbsence(Supplier).

Parameters:

predicate - must not be null.

Returns:

will never be null.

See Also:

• onAbsence(Supplier)

peekIfValid

public MappedPayloads.MappedPayload<T> peekIfValid(Consumer<? super T> consumer)

Peeks at the payload if present and no errors have been accumulated or we're on a path to a HttpStatus.NOT_FOUND yet.

Parameters:

consumer - must not be null.

Returns:

the current instance, never null.

peekIfValid

public MappedPayloads.MappedPayload<T> peekIfValid(BiConsumer<? super T,org.springframework.validation.Errors> consumer)

Peeks at the given payload and Errors if no errors have been accumulated or we're on a path to a HttpStatus.NOT_FOUND yet.

Parameters:

consumer -

Returns:

the current instance, never null.

peek

public MappedPayloads.MappedPayload<T> peek(Consumer<? super T> consumer)

peek

public MappedPayloads.MappedPayload<T> peek(BiConsumer<? super T,org.springframework.validation.Errors> consumer)

validate

public MappedPayloads.MappedPayload<T> validate(BiConsumer<? super T,org.springframework.validation.Errors> validator)

Syntactic sugar to invoke validations in a readable way. Essentially the same as peek(BiConsumer). Easy to use with Spring's own Validator interface or the YAVI YaviValidator adapter.

Parameters:

validator - must not be null.

Returns:

map

public <S> MappedPayloads.MappedPayload<S> map(Function<? super T,S> mapper)

Applies the given Function, even if errors have been accumulated.

Type Parameters:

S -

Parameters:

mapper - must not be null.

Returns:

will never be null.

flatMap

public <S> MappedPayloads.MappedPayload<S> flatMap(Function<? super T,Optional<S>> mapper)

mapIfValid

public <S> MappedPayloads.MappedPayload<S> mapIfValid(Function<? super T,S> mapper)

Applies the given Function if no errors have been accumulated or we're on a path to a HttpStatus.NOT_FOUND yet.

Type Parameters:

S -

Parameters:

mapper - must not be null.

Returns:

flatMapIfValid

public <S> MappedPayloads.MappedPayload<S> flatMapIfValid(Function<? super T,Optional<S>> mapper)

map

public <S> MappedPayloads.MappedPayload<S> map(BiFunction<? super T,org.springframework.validation.Errors,S> mapper)

mapIfValid

public <S> MappedPayloads.MappedPayload<S> mapIfValid(BiFunction<? super T,org.springframework.validation.Errors,S> mapper)

onErrors

public MappedPayloads.MappedPayload<T> onErrors(Function<org.springframework.validation.Errors,org.springframework.http.ResponseEntity<?>> callback)

Description copied from class: MappedPayloads.MappedErrors

Registers a Function to eventually turn an Errors instance into an HttpEntity. Will only be used if the Errors have accumulated at least one error in the pipeline.

Overrides:

onErrors in class MappedPayloads.MappedErrors

Parameters:

callback - must not be null.

Returns:

onErrors

public MappedPayloads.MappedPayload<T> onErrors(Supplier<org.springframework.http.ResponseEntity<?>> callback)

Overrides:

onErrors in class MappedPayloads.MappedErrors

onAbsence

public MappedPayloads.MappedPayload<T> onAbsence(Supplier<org.springframework.http.ResponseEntity<?>> callback)

Registers a Function to create an ResponseEntity in case the pipeline yields the absence of a payload.

Parameters:

callback - must not be null.

Returns:

See Also:

• notFoundIf(boolean)
• notFoundIf(Predicate)

onAbsenceReject

public MappedPayloads.MappedPayload<T> onAbsenceReject(String field,
 String errorCode)

Registers the given field to be rejected on payload absence. Transparently registers the error handler as absence handler.

Parameters:

field - must not be null or empty.

errorCode - must not be null or empty.

Returns:

will never be null.

concludeIfValid

public <S,
R extends org.springframework.http.ResponseEntity<? extends S>>
R concludeIfValid(Function<? super T,R> finalizer)

Concludes the processing of the current payload with the given finalizer, but automatically produces an error response via the callbacks registered for onErrors(java.util.function.Function<org.springframework.validation.Errors, org.springframework.http.ResponseEntity<?>>) and onAbsence.

Parameters:

finalizer - must not be null.

Returns:

concludeIfValid

public org.springframework.http.HttpEntity<?> concludeIfValid(BiFunction<? super T,org.springframework.validation.Errors,? extends org.springframework.http.ResponseEntity<?>> finalizer)

Concludes the processing of the current payload with the given finalizer, but automatically produces an error response via the callbacks registered for onErrors(java.util.function.Function<org.springframework.validation.Errors, org.springframework.http.ResponseEntity<?>>) and onAbsence.

Parameters:

finalizer - must not be null.

Returns:

concludeSelfIfValid

public org.springframework.http.HttpEntity<?> concludeSelfIfValid(BiFunction<? super T,MappedPayloads.MappedErrors,? extends org.springframework.http.ResponseEntity<?>> finalizer)

Concludes the processing of the current payload with the given finalizer, but automatically produces an error response via the callbacks registered for onErrors(java.util.function.Function<org.springframework.validation.Errors, org.springframework.http.ResponseEntity<?>>) and onAbsence.

Parameters:

finalizer - must not be null.

Returns:

concludeWithoutContent

public org.springframework.http.HttpEntity<?> concludeWithoutContent()

Terminal operation that produces an empty response with HttpStatus.NO_CONTENT.

Returns:

rejectField

public MappedPayloads.MappedPayload<T> rejectField(boolean condition,
 String field,
 String errorCode)

Description copied from class: MappedPayloads.MappedErrors

Rejects the field with the given name with the given error code if the given condition is true.

Overrides:

rejectField in class MappedPayloads.MappedErrors

Parameters:

condition - the condition under which to reject the given field.

field - must not be null or empty.

errorCode - must not be null or empty.

Returns:

the current instance, never null.

rejectField

public MappedPayloads.MappedPayload<T> rejectField(Predicate<T> condition,
 String field,
 String errorCode)

Rejects the field with the given name with the given error code if the given condition predicate returns true.

Parameters:

condition - the condition predicate under which to reject the given field.

field - must not be null or empty.

errorCode - must not be null or empty.

Returns:

the current instance, never null.

rejectField

public MappedPayloads.MappedPayload<T> rejectField(String field,
 String errorCode)

Description copied from class: MappedPayloads.MappedErrors

Rejects the field of the given name with the given error code.

Overrides:

rejectField in class MappedPayloads.MappedErrors

Parameters:

field - must not be null or empty.

errorCode - must not be null or empty.

Returns:

the current instance, never null.

rejectField

public MappedPayloads.MappedPayload<T> rejectField(String field,
 String errorCode,
 String defaultMessage)

Description copied from class: MappedPayloads.MappedErrors

Rejects the field with the given name with the given error code and default message.

Overrides:

rejectField in class MappedPayloads.MappedErrors

Parameters:

field - must not be null or empty.

errorCode - must not be null or empty.

defaultMessage - must not be null or empty.

Returns:

the current instance, never null.

rejectField

public MappedPayloads.MappedPayload<T> rejectField(boolean condition,
 String field,
 String errorCode,
 Function<org.springframework.validation.Errors,org.springframework.http.ResponseEntity<?>> errorHandler)

Rejects the field with the given name with the given error code if the given condition is true.

Overrides:

rejectField in class MappedPayloads.MappedErrors

Parameters:

condition - the condition under which to reject the given field.

field - must not be null or empty.

errorCode - must not be null or empty.

errorHandler - and error handler to be registered in case the condition is true.

Returns:

the current instance, never null.

errorsOrNone

protected Optional<org.springframework.http.ResponseEntity<?>> errorsOrNone()

Overrides:

errorsOrNone in class MappedPayloads.MappedErrors