Package nl.vpro.util

Class FileSizeFormatter

java.lang.Object

nl.vpro.util.FileSizeFormatter

public class FileSizeFormatter
extends Object

Formatting file sizes it not always very trivial. This can help.

E.g.

 FileSizeFormatter.DEFAULT.format(12345)
 
 

For customizing a builder is available (Use builder())

Find more examples in FileSizeFormatterTest.

Since:

1.76

Author:

Michiel Meeuwissen

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FileSizeFormatter.Builder

Field Summary

Fields

Modifier and Type	Field	Description
static final DecimalFormatSymbols	DECIMAL
static final FileSizeFormatter	DEFAULT
static final FileSizeFormatter	SI

Constructor Summary

Constructors

Constructor	Description
FileSizeFormatter(DecimalFormat format, DecimalFormat exactFormat, boolean mebi)

Method Summary

Modifier and Type	Method	Description
static FileSizeFormatter.Builder	builder()
String	format(@Nullable Number numberOfBytes)
String	format(@Nullable Number numberOfBytes, boolean exact)
String	formatSpeed(@Nullable Number numberOfBytes, Duration duration)	Given a number of bytes, processed in a certain duration, format it as certain amount of bytes per second.
String	formatSpeed(Number length, Instant start)
DecimalFormat	getExactFormat()
DecimalFormat	getFormat()
boolean	isMebi()	Whether to use binary prefixes
FileSizeFormatter.Builder	toBuilder()

Methods inherited from class java.lang.Object

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

Field Details

DECIMAL

public static final DecimalFormatSymbols DECIMAL

DEFAULT

public static final FileSizeFormatter DEFAULT

SI

public static final FileSizeFormatter SI

Constructor Details

FileSizeFormatter

public FileSizeFormatter(DecimalFormat format,
 DecimalFormat exactFormat,
 boolean mebi)

Method Details

format

public String format(@Nullable Number numberOfBytes)

format

public String format(@Nullable Number numberOfBytes,
 boolean exact)

formatSpeed

public String formatSpeed(@Nullable Number numberOfBytes,
 Duration duration)

Given a number of bytes, processed in a certain duration, format it as certain amount of bytes per second.

formatSpeed

public String formatSpeed(Number length,
 Instant start)

builder

public static FileSizeFormatter.Builder builder()

toBuilder

public FileSizeFormatter.Builder toBuilder()

getFormat

public DecimalFormat getFormat()

getExactFormat

public DecimalFormat getExactFormat()

isMebi

public boolean isMebi()

Whether to use binary prefixes