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

Go to download
Show more of this group Show more artifacts with this name
Show all versions of square Show documentation
Java client library for the Square API
There is a newer version: 41.2.0.20241017

package com.squareup.square.models;

import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonGetter;
import com.fasterxml.jackson.annotation.JsonIgnore;
import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.squareup.square.http.client.HttpContext;
import java.util.List;
import java.util.Objects;

/**
 * This is a model class for ListLocationsResponse type.
 */
public class ListLocationsResponse {
    private HttpContext httpContext;
    private final List errors;
    private final List locations;

    /**
     * Initialization constructor.
     * @param  errors  List of Error value for errors.
     * @param  locations  List of Location value for locations.
     */
    @JsonCreator
    public ListLocationsResponse(
            @JsonProperty("errors") List errors,
            @JsonProperty("locations") List locations) {
        this.errors = errors;
        this.locations = locations;
    }

    @JsonIgnore
    public HttpContext getContext() {
        return httpContext;
    }

    /**
     * Getter for Errors.
     * Any errors that occurred during the request.
     * @return Returns the List of Error
     */
    @JsonGetter("errors")
    @JsonInclude(JsonInclude.Include.NON_NULL)
    public List getErrors() {
        return errors;
    }

    /**
     * Getter for Locations.
     * The business locations.
     * @return Returns the List of Location
     */
    @JsonGetter("locations")
    @JsonInclude(JsonInclude.Include.NON_NULL)
    public List getLocations() {
        return locations;
    }

    @Override
    public int hashCode() {
        return Objects.hash(errors, locations);
    }

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

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

    /**
     * Builds a new {@link ListLocationsResponse.Builder} object.
     * Creates the instance with the state of the current model.
     * @return a new {@link ListLocationsResponse.Builder} object
     */
    public Builder toBuilder() {
        Builder builder = new Builder()
                .errors(getErrors())
                .locations(getLocations());
        return builder;
    }

    /**
     * Class to build instances of {@link ListLocationsResponse}.
     */
    public static class Builder {
        private HttpContext httpContext;
        private List errors;
        private List locations;



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

        /**
         * Setter for errors.
         * @param  errors  List of Error value for errors.
         * @return Builder
         */
        public Builder errors(List errors) {
            this.errors = errors;
            return this;
        }

        /**
         * Setter for locations.
         * @param  locations  List of Location value for locations.
         * @return Builder
         */
        public Builder locations(List locations) {
            this.locations = locations;
            return this;
        }

        /**
         * Builds a new {@link ListLocationsResponse} object using the set fields.
         * @return {@link ListLocationsResponse}
         */
        public ListLocationsResponse build() {
            ListLocationsResponse model =
                    new ListLocationsResponse(errors, locations);
            model.httpContext = httpContext;
            return model;
        }
    }
}