com.codelanx.commons.util.time

Class TimeUtil

java.lang.Object

com.codelanx.commons.util.time.TimeUtil

public final class TimeUtil
extends Object

Provides utility method for determining differences in time as well as providing ways to utilize things such as timers

Since:

0.0.1

Version:

0.1.0

Author:

1Rogue

Method Summary

Modifier and Type	Method and Description
static String	formatTime(long durationNS) Formats time in a readable output.
static String	formatTime(long durationNS, TimeUnit min) Formats time in a readable output.
static String	formatTime(TimePoint point) Formats time in a readable output.
static String	formatTime(TimePoint point, TimeUnit min) Formats time in a readable output.
static String	getProperUnitName(TimeUnit unit, long amount) Returns the appropriate spelling for a TimeUnit value based on the value of the "amount" parameter.
static String	getTime(long start) Returns a formatted string of how long ago the passed time was

Methods inherited from class java.lang.Object

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

Method Detail

getTime

public static String getTime(long start)

Returns a formatted string of how long ago the passed time was

Parameters:

start - How long ago something was in nanoseconds

Returns:

A formatted string representing the passed point in time

Since:

0.1.0

formatTime

public static String formatTime(long durationNS)

Formats time in a readable output.

Calling this method is equivalent to TimeUtil.formatTime(durationNS, TimeUnit.NANOSECONDS)

Parameters:

durationNS - The amount of time in nanoseconds

Returns:

The formatted string

Since:

0.0.1

See Also:

formatTime(long, TimeUnit)

formatTime

public static String formatTime(long durationNS,
                                TimeUnit min)

Formats time in a readable output. Creates a TimePoint out of the pass long in order to do so.

Calling this method is equivalent to TimeUtil.formatTime(TimePoint, TimeUnit.NANOSECONDS)

Parameters:

durationNS - The amount of time in nanoseconds

min - The minimum (inclusive) unit of time to output as a secondary measurement

Returns:

The formatted string

Since:

0.1.0

See Also:

formatTime(TimePoint, TimeUnit)

formatTime

public static String formatTime(TimePoint point)

Formats time in a readable output.

Calling this method is equivalent to TimeUtil.formatTime(point, TimeUnit.NANOSECONDS)

Parameters:

point - The TimePoint to use

Returns:

The formatted string

Since:

0.1.0

See Also:

formatTime(TimePoint, TimeUnit)

formatTime

public static String formatTime(TimePoint point,
                                TimeUnit min)

Formats time in a readable output. Depending on the amount of time, the format will attempt to output the largest possible value first (e.g. days), followed by the next non-zero measurement of time (e.g., minutes). If there is no non-zero secondary measurement, it is excluded.

Parameters:

point - The TimePoint to use

min - The minimum (inclusive) unit of time to output as a secondary measurement

Returns:

The formatted string

Since:

0.1.0

getProperUnitName

public static String getProperUnitName(TimeUnit unit,
                                       long amount)

Returns the appropriate spelling for a TimeUnit value based on the value of the "amount" parameter. Values other than 1 will return a plural measurement whereas 1 will return a singular measurement.

Parameters:

unit - The unit to beautify

amount - The amount relevant to the measurement output

Returns:

A formatted word

Since:

0.0.1