com.squareup.square.legacy.models.SearchOrdersSort Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of square-legacy Show documentation
There is a newer version: 44.2.0.20250521
package com.squareup.square.legacy.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 SearchOrdersSort type.
 */
public class SearchOrdersSort {
    private final String sortField;
    private final String sortOrder;

    /**
     * Initialization constructor.
     * @param  sortField  String value for sortField.
     * @param  sortOrder  String value for sortOrder.
     */
    @JsonCreator
    public SearchOrdersSort(
            @JsonProperty("sort_field") String sortField, @JsonProperty("sort_order") String sortOrder) {
        this.sortField = sortField;
        this.sortOrder = sortOrder;
    }

    /**
     * Getter for SortField.
     * Specifies which timestamp to use to sort `SearchOrder` results.
     * @return Returns the String
     */
    @JsonGetter("sort_field")
    public String getSortField() {
        return sortField;
    }

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

    @Override
    public int hashCode() {
        return Objects.hash(sortField, sortOrder);
    }

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

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

    /**
     * Builds a new {@link SearchOrdersSort.Builder} object.
     * Creates the instance with the state of the current model.
     * @return a new {@link SearchOrdersSort.Builder} object
     */
    public Builder toBuilder() {
        Builder builder = new Builder(sortField).sortOrder(getSortOrder());
        return builder;
    }

    /**
     * Class to build instances of {@link SearchOrdersSort}.
     */
    public static class Builder {
        private String sortField;
        private String sortOrder;

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

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

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

        /**
         * Builds a new {@link SearchOrdersSort} object using the set fields.
         * @return {@link SearchOrdersSort}
         */
        public SearchOrdersSort build() {
            return new SearchOrdersSort(sortField, sortOrder);
        }
    }
}