biz.turnonline.ecosystem.widget.shared.rest

Interface RelevantNullChecker

All Known Implementing Classes:

Account, AccountBusiness, AccountPersonalAddress, AccountPostalAddress, AccountPublicContact, BankAccount, Customer, CustomerPostalAddress, Event, EventBegin, EventEnd, EventLocation, Image, Increment, Invoice, InvoicePayment, InvoicePricing, InvoicingConfig, InvoicingConfigBillingAddress, InvoicingConfigBillingContact, NumberSeries, Order, PricingItem, PricingProduct, Product, ProductDomain, ProductInvoicing, ProductMetaFields, ProductPricing, ProductPublishing

public interface RelevantNullChecker

Value checker that checks relevant property values whether they are not null for POST operation (sent to remote service).

The basic motivation behind is to avoid to send for example the following:

 {
     "firstName": "John",
     "address": {
         "street": null,
         "city": null
 }
 

or

 {
     "firstName": "John",
     "address": {}
 }
 

The proper JSON for above should look like:

 {
     "firstName": "John"
 }
 

Author:

Aurel Medvegy

Method Summary

Modifier and Type	Method and Description
boolean	allNull() Checks whether this resource has at least a single property with non null value within its tree, among those that has been included to be checked.
default boolean	allNull(Object... values) Checks whether the input values has at least single non null value within its tree.
default <T extends RelevantNullChecker> boolean	setIfNotAllNull(Consumer<T> setter, T value) Sets value at consumer (setter) only if input value meets a condition.

Method Detail

allNull

boolean allNull()

Checks whether this resource has at least a single property with non null value within its tree, among those that has been included to be checked.

Returns:

true if at least a single property of this resource has a non null value, otherwise false

setIfNotAllNull

default <T extends RelevantNullChecker> boolean setIfNotAllNull(@Nonnull
                                                                Consumer<T> setter,
                                                                @Nullable
                                                                T value)

Sets value at consumer (setter) only if input value meets a condition. Other words, include only those properties to be checked that will be processed by a remote service.

Type Parameters:

T - the type of the value

Parameters:

setter - the consumer to be used to set value only if allNull(Object...) returns true

value - the value to be checked and set if meets condition

Returns:

true if value from the input tree has at least single non null value within its tree, otherwise false

allNull

default boolean allNull(@Nullable
                        Object... values)

Checks whether the input values has at least single non null value within its tree.

Parameters:

values - those values that are relevant to be sent to remote service

Returns:

true if at least a single value from the input a non null value, otherwise false