rx.schedulers.TimeInterval Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of rxjava Show documentation
rxjava
The newest version!
/**
 * Copyright 2014 Netflix, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package rx.schedulers;

/**
 * A {@code TimeInterval} represents an item emitted by an {@code Observable} along with the amount of time that
 * elapsed either since the emission of the previous item or (if there was no previous item) since the
 * {@code Observable} was first subscribed to.
 * @param  the value type held along with the interval length
 */
public class TimeInterval {
    private final long intervalInMilliseconds;
    private final T value;

    /**
     * Creates a {@code TimeInterval} object.
     *
     * @param intervalInMilliseconds
     *          the number of milliseconds between the time when {@code value} was emitted and the item that
     *          was emitted immediately prior to {@code value}, or, if there was no such prior item, since the
     *          initial subscription to the {@code Observable}
     * @param value
     *          the item emitted by the Observable
     */
    public TimeInterval(long intervalInMilliseconds, T value) {
        this.value = value;
        this.intervalInMilliseconds = intervalInMilliseconds;
    }

    /**
     * Returns the time interval, expressed in milliseconds.
     *
     * @return the time interval in milliseconds
     */
    public long getIntervalInMilliseconds() {
        return intervalInMilliseconds;
    }

    /**
     * Returns the item that was emitted by the Observable after this time interval.
     *
     * @return the item that was emitted by the Observable
     */
    public T getValue() {
        return value;
    }

    // The following methods are generated by eclipse automatically.
    @Override
    public int hashCode() {
        int prime = 31;
        int result = 1;
        result = prime
                * result
                + (int) (intervalInMilliseconds ^ (intervalInMilliseconds >>> 32));
        result = prime * result + ((value == null) ? 0 : value.hashCode());
        return result;
    }

    @Override
    public boolean equals(Object obj) {
        if (this == obj) {
            return true;
        }
        if (obj == null) {
            return false;
        }
        if (getClass() != obj.getClass()) {
            return false;
        }
        TimeInterval other = (TimeInterval) obj;
        if (intervalInMilliseconds != other.intervalInMilliseconds) {
            return false;
        }
        if (value == null) {
            if (other.value != null) {
                return false;
            }
        } else if (!value.equals(other.value)) {
            return false;
        }
        return true;
    }

    @Override
    public String toString() {
        return "TimeInterval [intervalInMilliseconds=" + intervalInMilliseconds
                + ", value=" + value + "]";
    }
}