com.urbanairship.connect.client.StreamQueryDescriptor Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of connect-client Show documentation
The UA Connect Java client library
There is a newer version: 5.4.2
/*
Copyright 2015 Urban Airship and Contributors
*/

package com.urbanairship.connect.client;

import com.google.common.base.Optional;
import com.urbanairship.connect.client.model.Subset;
import com.urbanairship.connect.client.model.filters.Filter;

import java.util.Arrays;
import java.util.Collection;
import java.util.HashSet;
import java.util.Objects;
import java.util.Set;

/**
 * Object containing app credentials and API request details for the {@link com.urbanairship.connect.client.MobileEventStream}.
 */
public final class StreamQueryDescriptor {

    private final Creds creds;
    private final Optional offset;
    private final Optional> filters;
    private final Optional subset;

    /**
     * StreamDescriptor builder
     * @return Builder
     */
    public static Builder newBuilder() {
        return new Builder();
    }

    private StreamQueryDescriptor(Creds creds, Optional offset, Optional> filters, Optional subset) {
        this.creds = creds;
        this.offset = offset;
        this.filters = filters;
        this.subset = subset;
    }

    /**
     * Get the app creds.
     *
     * @return the app creds.
     */
    public Creds getCreds() {
        return creds;
    }

    /**
     * Get the stream offset.
     *
     * @return offset
     */
    public Optional getOffset() {
        return offset;
    }

    /**
     * Get the request filters.
     *
     * @return set of filters.
     */
    public Optional> getFilters() {
        return filters;
    }

    /**
     * Get the request subset.
     *
     * @return subset.
     */
    public Optional getSubset() {
        return subset;
    }

    @Override
    public boolean equals(Object o) {
        if (this == o) {
            return true;
        }
        if (o == null || getClass() != o.getClass()) {
            return false;
        }
        StreamQueryDescriptor that = (StreamQueryDescriptor) o;
        return Objects.equals(creds, that.creds) &&
                Objects.equals(offset, that.offset) &&
                Objects.equals(filters, that.filters) &&
                Objects.equals(subset, that.subset);
    }

    @Override
    public int hashCode() {
        return Objects.hash(creds, offset, filters, subset);
    }

    public static final class Builder {
        private Creds creds;
        private String offset = null;
        private Set filters = null;
        private Subset subset = null;

        private Builder() {}

        /**
         * Sets the app creds.
         *
         * @param value Creds
         * @return Builder
         */
        public Builder setCreds(Creds value) {
            this.creds = value;
            return this;
        }

        /**
         * Set the stream offset.
         *
         * @param value String
         * @return Builder
         */
        public Builder setOffset(String value) {
            this.offset = value;
            return this;
        }

        /**
         * Add a single filter.
         *
         * @param value Filter
         * @return Builder
         */
        public Builder addFilter(Filter value) {
            return addFilters(value);
        }

        /**
         * Add multiple filters.
         *
         * @param value Filter...
         * @return Builder
         */
        public Builder addFilters(Filter... value) {
            return addFilters(new HashSet<>(Arrays.asList(value)));
        }

        /**
         * Add a Collection of filters.
         *
         * @param value {@code Collection}
         * @return Builder
         */
        public Builder addFilters(Collection value) {
            if (this.filters == null) {
                this.filters = new HashSet<>();
            }

            this.filters.addAll(value);
            return this;
        }

        /**
         * Set the subset.
         *
         * @param value Subset
         * @return Builder
         */
        public Builder setSubset(Subset value) {
            this.subset = value;
            return this;
        }

        /**
         * Builder a StreamDescriptor object.
         * @return StreamDescriptor
         */
        public StreamQueryDescriptor build() {
            return new StreamQueryDescriptor(creds, Optional.fromNullable(offset), Optional.fromNullable(filters), Optional.fromNullable(subset));
        }
    }
}