com.squareup.square.models.InvoiceSort Maven / Gradle / Ivy

Go to download

package com.squareup.square.models;

import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonGetter;
import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonProperty;
import java.util.Objects;

/**
 * This is a model class for InvoiceSort type.
 */
public class InvoiceSort {
    private final String field;
    private final String order;

    /**
     * Initialization constructor.
     * @param  field  String value for field.
     * @param  order  String value for order.
     */
    @JsonCreator
    public InvoiceSort(
            @JsonProperty("field") String field,
            @JsonProperty("order") String order) {
        this.field = field;
        this.order = order;
    }

    /**
     * Getter for Field.
     * The field to use for sorting.
     * @return Returns the String
     */
    @JsonGetter("field")
    public String getField() {
        return field;
    }

    /**
     * Getter for Order.
     * The order (e.g., chronological or alphabetical) in which results from a request are returned.
     * @return Returns the String
     */
    @JsonGetter("order")
    @JsonInclude(JsonInclude.Include.NON_NULL)
    public String getOrder() {
        return order;
    }

    @Override
    public int hashCode() {
        return Objects.hash(field, order);
    }

    @Override
    public boolean equals(Object obj) {
        if (obj == this) {
            return true;
        }
        if (!(obj instanceof InvoiceSort)) {
            return false;
        }
        InvoiceSort other = (InvoiceSort) obj;
        return Objects.equals(field, other.field)
            && Objects.equals(order, other.order);
    }

    /**
     * Converts this InvoiceSort into string format.
     * @return String representation of this class
     */
    @Override
    public String toString() {
        return "InvoiceSort [" + "field=" + field + ", order=" + order + "]";
    }

    /**
     * Builds a new {@link InvoiceSort.Builder} object.
     * Creates the instance with the state of the current model.
     * @return a new {@link InvoiceSort.Builder} object
     */
    public Builder toBuilder() {
        Builder builder = new Builder(field)
                .order(getOrder());
        return builder;
    }

    /**
     * Class to build instances of {@link InvoiceSort}.
     */
    public static class Builder {
        private String field = "INVOICE_SORT_DATE";
        private String order;

        /**
         * Initialization constructor.
         * @param  field  String value for field.
         */
        public Builder(String field) {
            this.field = field;
        }

        /**
         * Setter for field.
         * @param  field  String value for field.
         * @return Builder
         */
        public Builder field(String field) {
            this.field = field;
            return this;
        }

        /**
         * Setter for order.
         * @param  order  String value for order.
         * @return Builder
         */
        public Builder order(String order) {
            this.order = order;
            return this;
        }

        /**
         * Builds a new {@link InvoiceSort} object using the set fields.
         * @return {@link InvoiceSort}
         */
        public InvoiceSort build() {
            return new InvoiceSort(field, order);
        }
    }
}