com.datastax.oss.dsbulk.workflow.api.utils

Class DurationUtils

java.lang.Object

com.datastax.oss.dsbulk.workflow.api.utils.DurationUtils

public class DurationUtils
extends Object

Constructor Summary

Constructors

Constructor and Description
DurationUtils()

Method Summary

Modifier and Type	Method and Description
static String	formatDuration(Duration duration) Formats the given duration in plain English text.
static Duration	round(Duration duration, TimeUnit unit) Rounds the given duration to the given time unit.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DurationUtils

public DurationUtils()

Method Detail

round

@NonNull
public static Duration round(@NonNull
                                      Duration duration,
                                      @NonNull
                                      TimeUnit unit)

Rounds the given duration to the given time unit.

Conversions from finer to coarser granularities may result in precision loss; in such cases, rounding is done towards the floor. For example, rounding 119 seconds to minutes will result in one minute.

Parameters:

duration - The duration to round.

unit - The unit to round to.

Returns:

A rounded duration.

formatDuration

@NonNull
public static String formatDuration(@NonNull
                                             Duration duration)

Formats the given duration in plain English text. The duration must be strictly positive.

Parameters:

duration - The duration to format, must be non-null and strictly positive.

Returns:

The duration expressed in plain English.

Throws:

IllegalArgumentException - if the duration is negative or zero.