com.squareup.square.models.RetrieveLocationResponse 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.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 RetrieveLocationResponse type.
 */
public class RetrieveLocationResponse {
    private HttpContext httpContext;
    @JsonInclude(JsonInclude.Include.NON_NULL)
    private final List errors;
    @JsonInclude(JsonInclude.Include.NON_NULL)
    private final Location location;

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

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

    /**
     * Getter for Errors.
     * Information on errors encountered during the request.
     * @return Returns the List of Error
     */
    @JsonGetter("errors")
    public List getErrors() {
        return errors;
    }

    /**
     * Getter for Location.
     * Represents one of a business's
     * [locations](https://developer.squareup.com/docs/locations-api).
     * @return Returns the Location
     */
    @JsonGetter("location")
    public Location getLocation() {
        return location;
    }

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

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

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

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

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



        /**
         * 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 location.
         * @param  location  Location value for location.
         * @return Builder
         */
        public Builder location(Location location) {
            this.location = location;
            return this;
        }

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