Package org.apache.maven.cli.transfer

Class FileSizeFormat

java.lang.Object

org.apache.maven.cli.transfer.FileSizeFormat

public class FileSizeFormat
extends Object

Formats file size with the associated SI prefix (GB, MB, kB) and using the patterns #0.0 for numbers between 1 and 10 and ###0 for numbers between 10 and 1000+ by default.

See Also:

• https://en.wikipedia.org/wiki/Metric_prefix
• https://en.wikipedia.org/wiki/Binary_prefix
• https://en.wikipedia.org/wiki/Octet_(computing)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	FileSizeFormat.ScaleUnit

Constructor Summary

Constructors

Constructor	Description
FileSizeFormat(Locale locale)

Method Summary

Modifier and Type	Method	Description
String	format(long size)
String	format(long size, FileSizeFormat.ScaleUnit unit)
String	format(long size, FileSizeFormat.ScaleUnit unit, boolean omitSymbol)
void	format(StringBuilder builder, long size)
void	format(StringBuilder builder, long size, FileSizeFormat.ScaleUnit unit)
void	format(org.apache.maven.api.services.MessageBuilder builder, long size)
void	format(org.apache.maven.api.services.MessageBuilder builder, long size, FileSizeFormat.ScaleUnit unit)
String	formatProgress(long progressedSize, long size)
void	formatProgress(StringBuilder builder, long progressedSize, long size)

Methods inherited from class java.lang.Object

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

Constructor Details

FileSizeFormat

public FileSizeFormat(Locale locale)

Method Details

format

public String format(long size)

format

public String format(long size,
 FileSizeFormat.ScaleUnit unit)

format

public String format(long size,
 FileSizeFormat.ScaleUnit unit,
 boolean omitSymbol)

format

public void format(StringBuilder builder,
 long size)

format

public void format(StringBuilder builder,
 long size,
 FileSizeFormat.ScaleUnit unit)

format

public void format(org.apache.maven.api.services.MessageBuilder builder,
 long size)

format

public void format(org.apache.maven.api.services.MessageBuilder builder,
 long size,
 FileSizeFormat.ScaleUnit unit)

formatProgress

public String formatProgress(long progressedSize,
 long size)

formatProgress

public void formatProgress(StringBuilder builder,
 long progressedSize,
 long size)