Package com.broadleafcommerce.customer.web.endpoint

Class CustomerPaymentAccountEndpoint.PaymentAccountUpdate

java.lang.Object
com.broadleafcommerce.customer.web.endpoint.CustomerPaymentAccountEndpoint.PaymentAccountUpdate
Enclosing class:
CustomerPaymentAccountEndpoint
public static class CustomerPaymentAccountEndpoint.PaymentAccountUpdate extends Object
A custom DTO that is intended for the specific purpose of supporting PATCH for PaymentAccount.

It is important to note that the combined usage of @Nullable and Optional for the fields is entirely intentional.. Since there is no way to distinguish between a value not being supplied and being updated to null, this mechanism is necessary.

If the request JSON does not have a particular field's key, the field in this DTO will deserialize to null. If the request JSON does have the field's key but the value is null, the field in this DTO will deserialize to Optional.empty().

An earlier, alternate implementation relied on a single Map<String, Object> "updateFields" property to achieve the same distinction between unsupplied and null, but this approach had the flaw of not being able to take advantage of Jackson's automatic type-safe deserialization. With the current approach, Jackson can understand the declared types and automatically verify and convert the fields to the appropriate types.

Another important note is that the use of @Data and @Setter with AccessLevel#PRIVATE is intentional. This is required for getting the behavior we want from Jackson on deserialization, while still maintaining @Value-like immutability. If we were to use @Value, Jackson would always set unsupplied keys to Optional.empty(). However, when we use @Data, it seems that Jackson simply does not call the setters for the fields with unsupplied keys, which leaves them null (giving us our desired behavior).

For paymentGatewayProperties, only keys present will be added or updated. If the caller wants to remove an entry, they should supply a blank value for the key.

  • Constructor Details

    • PaymentAccountUpdate

      public PaymentAccountUpdate()

  • Method Details

    • getDisplayName

      @Nullable public Optional<String> getDisplayName()

    • getNameOnAccount

      @Nullable public Optional<String> getNameOnAccount()

    • getExpirationMonth

      @Nullable public Optional<Integer> getExpirationMonth()

    • getExpirationYear

      @Nullable public Optional<Integer> getExpirationYear()

    • getFullName

      @Nullable public Optional<String> getFullName()

    • getAddressLine1

      @Nullable public Optional<String> getAddressLine1()

    • getAddressLine2

      @Nullable public Optional<String> getAddressLine2()

    • getAddressLine3

      @Nullable public Optional<String> getAddressLine3()

    • getCity

      @Nullable public Optional<String> getCity()

    • getCounty

      @Nullable public Optional<String> getCounty()

    • getStateProvinceRegion

      @Nullable public Optional<String> getStateProvinceRegion()

    • getCountry

      @Nullable public Optional<String> getCountry()

    • getPostalCode

      @Nullable public Optional<String> getPostalCode()

    • getPhonePrimary

      @Nullable public Optional<Phone> getPhonePrimary()

    • getPhoneSecondary

      @Nullable public Optional<Phone> getPhoneSecondary()

    • getDeactivated

      @Nullable public Optional<Boolean> getDeactivated()

    • getPaymentGatewayProperties

      public Map<String,String> getPaymentGatewayProperties()
      Only keys present will be added or updated. If the caller wants to remove an entry, they should supply a blank value for the key.

    • getDisplayAttributes

      public Map<String,String> getDisplayAttributes()
      Only keys present will be added or updated. If the caller wants to remove an entry, they should supply a blank value for the key.

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • canEqual

      protected boolean canEqual(Object other)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object