com.stormpath.sdk.lang.Duration Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2013 Stormpath, 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 com.stormpath.sdk.lang;

import java.util.Locale;
import java.util.concurrent.TimeUnit;

/**
 * A duration is a scalar value paired with a unit of time. For example, 10 milliseconds and 50 minutes are both
 * durations (scalar + unit of time).
 *
 * @since 0.8
 */
public class Duration implements Comparable, Cloneable {

    private final long value;

    private final TimeUnit timeUnit;

    public Duration(long value, TimeUnit timeUnit) {
        Assert.notNull(timeUnit, "TimeUnit argument cannot be null.");
        this.value = value;
        this.timeUnit = timeUnit;
    }

    public long getValue() {
        return value;
    }

    public TimeUnit getTimeUnit() {
        return timeUnit;
    }

    @Override
    public int compareTo(Duration duration) {
        long converted = timeUnit.convert(duration.getValue(), duration.getTimeUnit());

        if (this.value < converted) {
            return -1;
        } else if (this.value > converted) {
            return 1;
        } else {
            return 0;
        }
    }

    public boolean isLessThan(Duration duration) {
        return compareTo(duration) < 0;
    }

    public boolean isGreaterThan(Duration duration) {
        return compareTo(duration) > 0;
    }

    public boolean isEquivalentTo(Duration duration) {
        return compareTo(duration) == 0;
    }

    public boolean equals(Object o) {
        if (o == this) {
            return true;
        }
        if (o instanceof Duration) {
            Duration d = (Duration) o;
            return this.value == d.value && this.timeUnit.equals(d.timeUnit);
        }
        return false;
    }

    public String toString() {
        return value + " " + this.timeUnit.name().toLowerCase(Locale.ENGLISH);
    }

    public int hashCode() {
        return Objects.hashCode(value) * 37 + Objects.nullSafeHashCode(timeUnit);
    }

    @SuppressWarnings("CloneDoesntDeclareCloneNotSupportedException")
    public Duration clone() {
        try {
            return (Duration) super.clone();
        } catch (CloneNotSupportedException e) {
            //should never happen since we subclass Object directly:
            throw new InternalError("Unable to clone Object direct subclass! " + e.getMessage());
        }
    }
}