io.tourniquet.measure.TimeMeasure Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of tourniquet-measure Show documentation

Measurement of execution times.

The newest version!

/*
 * Copyright 2015-2016 DevCon5 GmbH, [email protected]
 *
 * 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 io.tourniquet.measure;

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

/**
 * Represents a single time measure. The time measure can either denote a specific point in time - being an unfinished
 * measure - or a specific time (the start of the measurement) and a duration the measured operation took.
 */
public class TimeMeasure {

    protected static final Duration NEGATIVE = Duration.ZERO.minus(Duration.ofMillis(1));
    private final Instant start;
    private final Duration duration;

    public TimeMeasure(final Instant start, final Duration duration) {

        this.start = start;
        this.duration = duration;
    }

    public TimeMeasure(final Instant start) {
        this(start, NEGATIVE);
    }

    public Instant getStart() {

        return start;
    }

    public Duration getDuration() {

        return duration;
    }

    public boolean isFinished(){
        return duration != NEGATIVE;
    }

}