com.urbanairship.api.nameduser.model.NamedUserListingResponse Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of java-client Show documentation
The Urban Airship Java client library
There is a newer version: 9.4.2
/*
 * Copyright (c) 2013-2016.  Urban Airship and Contributors
 */

package com.urbanairship.api.nameduser.model;

import com.google.common.base.Objects;
import com.google.common.base.Preconditions;
import com.google.common.collect.ImmutableList;
import com.urbanairship.api.common.model.ErrorDetails;

import java.util.Optional;

/**
 * Named user listing response object.
 */
public class NamedUserListingResponse {
    private final boolean ok;
    private final Optional nextPage;
    private final Optional namedUserView;
    private final Optional> namedUserViews;
    private final Optional error;
    private final Optional errorDetails;

    private NamedUserListingResponse(boolean ok, Optional nextPage, Optional namedUserView, Optional> namedUserViews, String error, ErrorDetails errorDetails) {
        this.ok = ok;
        this.nextPage = nextPage;
        this.namedUserView = namedUserView;
        this.namedUserViews = namedUserViews;
        this.error = Optional.ofNullable(error);
        this.errorDetails = Optional.ofNullable(errorDetails);
    }

    /**
     * New NamedUserListingResponse builder.
     *
     * @return Builder
     */
    public static Builder newBuilder() {
        return new Builder();
    }

    /**
     * Get the OK status as a boolean
     *
     * @return boolean
     */
    public boolean getOk() {
        return ok;
    }

    /**
     * Get the next page if present for a named user listing request
     *
     * @return An Optional String
     */
    public Optional getNextPage() {
        return nextPage;
    }

    /**
     * Get the named user object if present for a single named user lookup request
     *
     * @return An Optional NamedUserView
     */
    public Optional getNamedUserView() {
        return namedUserView;
    }

    /**
     * Get a list of named user objects if present for a named user listing request
     *
     * @return An Optional ImmutableList of NamedUserView objects
     */
    public Optional> getNamedUserViews() {
        return namedUserViews;
    }

    /**
     * Get the error if present
     *
     * @return An Optional String
     */
    public Optional getError() {
        return error;
    }

    /**
     * Get the error details if present
     *
     * @return An Optional String
     */
    public Optional getErrorDetails() {
        return errorDetails;
    }

    @Override
    public int hashCode() {
        return Objects.hashCode(ok, nextPage, namedUserView, namedUserViews, error, errorDetails);
    }

    @Override
    public boolean equals(Object obj) {
        if (this == obj) {
            return true;
        }
        if (obj == null || getClass() != obj.getClass()) {
            return false;
        }
        final NamedUserListingResponse other = (NamedUserListingResponse) obj;
        return Objects.equal(this.ok, other.ok) && Objects.equal(this.nextPage, other.nextPage) && Objects.equal(this.namedUserView, other.namedUserView) && Objects.equal(this.namedUserViews, other.namedUserViews) &&
        Objects.equal(this.error, other.error) && Objects.equal(this.errorDetails, other.errorDetails);
    }

    @Override
    public String toString() {
        return "NamedUserListingResponse{" +
            "ok=" + ok +
            ", nextPage=" + nextPage +
            ", namedUserView=" + namedUserView +
            ", namedUserViews=" + namedUserViews +
            ", error=" + error +
            ", errorDetails=" + errorDetails +
            '}';
    }

    public static class Builder {

        private boolean ok;
        private String nextPage = null;
        private NamedUserView namedUserView = null;
        private ImmutableList.Builder namedUserViews = ImmutableList.builder();
        private String error = null;
        private ErrorDetails errorDetails = null;

        private Builder() {
        }

        /**
         * Set the ok status
         *
         * @param value boolean
         * @return Builder
         */
        public Builder setOk(boolean value) {
            this.ok = value;
            return this;
        }

        /**
         * Set the next page
         *
         * @param value String
         * @return Builder
         */
        public Builder setNextPage(String value) {
            this.nextPage = value;
            return this;
        }

        /**
         * Set the named user object for single named user lookup
         *
         * @param value NamedUserView
         * @return Builder
         */
        public Builder setNamedUserView(NamedUserView value) {
            this.namedUserView = value;
            return this;
        }

        /**
         * Add all the named user objects for named user listings
         *
         * @param value Iterable of NamedUserView objects
         * @return Builder
         */
        public Builder setNamedUserViews(Iterable value) {
            this.namedUserViews.addAll(value);
            return this;
        }

        /**
         * Set the error
         *
         * @param error String
         * @return Builder
         */
        public Builder setError(String error) {
            this.error = error;
            return this;
        }

        /**
         * Set the errorDetails
         *
         * @param errorDetails String
         * @return Builder
         */
        public Builder setErrorDetails(ErrorDetails errorDetails) {
            this.errorDetails = errorDetails;
            return this;
        }

        /**
         * Build the NamedUserListingResponse object
         *
         *          * 1. If namedUserView is set, nextPage and namedUserView must be null.
         * 
         *
         * @return NamedUserListingResponse
         */
        public NamedUserListingResponse build() {
            if (namedUserView != null) {
                Preconditions.checkArgument(nextPage == null && namedUserViews.build().isEmpty());
            }

            return new NamedUserListingResponse(ok, Optional.ofNullable(nextPage), Optional.ofNullable(namedUserView), Optional.ofNullable(namedUserViews.build()), error, errorDetails);
        }
    }
}