org.diirt.util.time.TimeRelativeInterval Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of diirt-util Show documentation

Basic Java utility classes to be shared across projects until suitable replacements are available in the JDK.

The newest version!

/**
 * Copyright (C) 2010-18 diirt developers. See COPYRIGHT.TXT
 * All rights reserved. Use is subject to license terms. See LICENSE.TXT
 */
package org.diirt.util.time;

import java.time.Duration;
import java.time.Instant;

/**
 * A period of time where each end can either be an absolute moment in time
 * (e.g. 5/16/2012 11:30 AM) or a relative moment from a reference (e.g. 30 seconds before)
 * which typically is going to be "now".
 * 
 * This class stores a reference for start and a reference for end. Each reference
 * can either be absolute, in which case it's a Instant, or relative, in
 * which case it's a TimeDuration. The {@link Instant}
 * can be used to transform the relative interval into an absolute one
 * calculated from the reference. This allows to keep the relative interval,
 * and then to convert multiple time to an absolute interval every time
 * that one needs to calculate. For example, one can keep the range of a plot
 * from 1 minute ago to now, and then get a specific moment the absolute range
 * of that plot.
 *
 * @author carcassi
 */
public class TimeRelativeInterval {

    private final Object start;
    private final Object end;

    private TimeRelativeInterval(Object start, Object end) {
        this.start = start;
        this.end = end;
    }

    public static TimeRelativeInterval of(Instant start, Instant end) {
        return new TimeRelativeInterval(start, end);
    }

    public boolean isIntervalAbsolute() {
        return isStartAbsolute() && isEndAbsolute();
    }

    public boolean isStartAbsolute() {
        return start instanceof Instant || start == null;
    }

    public boolean isEndAbsolute() {
        return end instanceof Instant || end == null;
    }

    public Object getStart() {
        return start;
    }

    public Object getEnd() {
        return end;
    }

    public Instant getAbsoluteStart() {
        return (Instant) start;
    }

    public Instant getAbsoluteEnd() {
        return (Instant) end;
    }

    public Duration getRelativeStart() {
        return (Duration) start;
    }

    public Duration getRelativeEnd() {
        return (Duration) end;
    }

    public TimeInterval toAbsoluteInterval(Instant reference) {
        Instant absoluteStart;
        if (isStartAbsolute()) {
            absoluteStart = getAbsoluteStart();
        } else {
            absoluteStart = reference.plus(getRelativeStart());
        }
        Instant absoluteEnd;
        if (isEndAbsolute()) {
            absoluteEnd = getAbsoluteEnd();
        } else {
            absoluteEnd = reference.plus(getRelativeEnd());
        }
        return TimeInterval.between(absoluteStart, absoluteEnd);
    }


}