com.mindee.product.us.bankcheck.BankCheckV1Document Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of mindee-api-java Show documentation

Java Library to call Mindee's Off-The-Shelf and Custom APIs

The newest version!

package com.mindee.product.us.bankcheck;

import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.mindee.parsing.SummaryHelper;
import com.mindee.parsing.common.Prediction;
import com.mindee.parsing.standard.AmountField;
import com.mindee.parsing.standard.DateField;
import com.mindee.parsing.standard.StringField;
import java.util.ArrayList;
import java.util.List;
import lombok.EqualsAndHashCode;
import lombok.Getter;

/**
 * Bank Check API version 1.1 document data.
 */
@Getter
@EqualsAndHashCode(callSuper = false)
@JsonIgnoreProperties(ignoreUnknown = true)
public class BankCheckV1Document extends Prediction {

  /**
   * The check payer's account number.
   */
  @JsonProperty("account_number")
  protected StringField accountNumber;
  /**
   * The amount of the check.
   */
  @JsonProperty("amount")
  protected AmountField amount;
  /**
   * The issuer's check number.
   */
  @JsonProperty("check_number")
  protected StringField checkNumber;
  /**
   * The date the check was issued.
   */
  @JsonProperty("date")
  protected DateField date;
  /**
   * List of the check's payees (recipients).
   */
  @JsonProperty("payees")
  protected List payees = new ArrayList<>();
  /**
   * The check issuer's routing number.
   */
  @JsonProperty("routing_number")
  protected StringField routingNumber;

  @Override
  public boolean isEmpty() {
    return (
      this.date == null
      && this.amount == null
      && (this.payees == null || this.payees.isEmpty())
      && this.routingNumber == null
      && this.accountNumber == null
      && this.checkNumber == null
      );
  }

  @Override
  public String toString() {
    StringBuilder outStr = new StringBuilder();
    outStr.append(
        String.format(":Check Issue Date: %s%n", this.getDate())
    );
    outStr.append(
        String.format(":Amount: %s%n", this.getAmount())
    );
    String payees = SummaryHelper.arrayToString(
        this.getPayees(),
        "%n         "
    );
    outStr.append(
        String.format(":Payees: %s%n", payees)
    );
    outStr.append(
        String.format(":Routing Number: %s%n", this.getRoutingNumber())
    );
    outStr.append(
        String.format(":Account Number: %s%n", this.getAccountNumber())
    );
    outStr.append(
        String.format(":Check Number: %s%n", this.getCheckNumber())
    );
    return SummaryHelper.cleanSummary(outStr.toString());
  }
}