org.apache.hadoop.util.OperationDuration Maven / Gradle / Ivy
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you 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 org.apache.hadoop.util;
import java.time.Duration;
import org.apache.hadoop.classification.InterfaceAudience;
import org.apache.hadoop.classification.InterfaceStability;
/**
* Little duration counter.
*/
@InterfaceAudience.Public
@InterfaceStability.Unstable
public class OperationDuration {
/**
* Time in millis when the operation started.
*/
private final long started;
/**
* Time when the operation finished.
*/
private long finished;
/**
* Instantiate.
* The start time and finished time are both set
* to the current clock time.
*/
public OperationDuration() {
started = time();
finished = started;
}
/**
* Evaluate the system time.
* @return the current clock time.
*/
protected long time() {
return System.currentTimeMillis();
}
/**
* Update the finished time with the current system time.
*/
public void finished() {
finished = time();
}
/**
* Return the duration as {@link #humanTime(long)}.
* @return a printable duration.
*/
public String getDurationString() {
return humanTime(value());
}
/**
* Convert to a human time of minutes:seconds.millis.
* @param time time to humanize.
* @return a printable value.
*/
public static String humanTime(long time) {
long seconds = (time / 1000);
long minutes = (seconds / 60);
return String.format("%d:%02d.%03ds", minutes, seconds % 60, time % 1000);
}
/**
* Return the duration as {@link #humanTime(long)}.
* @return a printable duration.
*/
@Override
public String toString() {
return getDurationString();
}
/**
* Get the duration in milliseconds.
*
* This will be 0 until a call
* to {@link #finished()} has been made.
* @return the currently recorded duration.
*/
public long value() {
return finished -started;
}
/**
* Get the duration of an operation as a java Duration
* instance.
* @return a duration.
*/
public Duration asDuration() {
return Duration.ofMillis(value());
}
}