org.usefultoys.slf4j.utils

Class UnitFormatter

java.lang.Object

org.usefultoys.slf4j.utils.UnitFormatter

public final class UnitFormatter
extends Object

Utility class that provides methods to format numbers by rounding them to a unit, thereby reducing their string representation.

This class supports formatting for time durations, memory sizes, and iteration-related values.

For example, it can convert large numbers into human-readable formats such as "1.2kB" or "3.4ms".

Author:

Daniel Felix Ferber

Constructor Summary

Constructors

Constructor and Description
UnitFormatter()

Method Summary

Modifier and Type	Method and Description
String	bytes(long value) Formats a number of bytes into a human-readable string with appropriate units.
String	iterations(long value) Formats a number of iterations into a human-readable string with appropriate units.
String	iterationsPerSecond(double value) Formats a number of iterations per second (as a double) into a human-readable string with appropriate units.
String	nanoseconds(double value) Formats a duration in nanoseconds (as a double) into a human-readable string with appropriate time units.
String	nanoseconds(long value) Formats a duration in nanoseconds into a human-readable string with appropriate time units.

Methods inherited from class java.lang.Object

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

Constructor Detail

UnitFormatter

public UnitFormatter()

Method Detail

bytes

public String bytes(long value)

Formats a number of bytes into a human-readable string with appropriate units.

Parameters:

value - The number of bytes.

Returns:

A formatted string representing the value in bytes, kilobytes, megabytes, or gigabytes.

nanoseconds

public String nanoseconds(long value)

Formats a duration in nanoseconds into a human-readable string with appropriate time units.

Parameters:

value - The duration in nanoseconds.

Returns:

A formatted string representing the value in nanoseconds, microseconds, milliseconds, seconds, minutes, or hours.

nanoseconds

public String nanoseconds(double value)

Formats a duration in nanoseconds (as a double) into a human-readable string with appropriate time units.

Parameters:

value - The duration in nanoseconds.

Returns:

A formatted string representing the value in nanoseconds, microseconds, milliseconds, seconds, minutes, or hours.

iterations

public String iterations(long value)

Formats a number of iterations into a human-readable string with appropriate units.

Parameters:

value - The number of iterations.

Returns:

A formatted string representing the value in iterations, thousands, or millions.

iterationsPerSecond

public String iterationsPerSecond(double value)

Formats a number of iterations per second (as a double) into a human-readable string with appropriate units.

Parameters:

value - The number of iterations per second.

Returns:

A formatted string representing the value in iterations per second, thousands per second, or millions per second.