com.helger.commons.io.misc

Class SizeHelper

java.lang.Object

com.helger.commons.io.misc.SizeHelper

@NotThreadSafe
public final class SizeHelper
extends Object

A utility class that converts sizes into the corresponding Kilobyte, Megabyte etc. notation.
This class is not thread-safe, because the DecimalFormat class is not thread-safe!

Author:

Philip Helger

Field Summary

Fields

Modifier and Type	Field and Description
static String	B_SUFFIX Suffix for Bytes
static String	GB_SUFFIX Suffix for Gigabytes
static String	KB_SUFFIX Suffix for Kilobytes
static String	MB_SUFFIX Suffix for Megabytes
static String	PB_SUFFIX Suffix for Petabytes
static String	TB_SUFFIX Suffix for Terabytes

Constructor Summary

Constructors

Constructor and Description
SizeHelper(DecimalFormatSymbols aDFS)
SizeHelper(Locale aDisplayLocale)

Method Summary

Modifier and Type	Method and Description
String	getAsGB(long nSize)
String	getAsGB(long nSize, int nDecimals)
String	getAsKB(long nSize)
String	getAsKB(long nSize, int nDecimals)
String	getAsMatching(BigDecimal aSize) Get the best matching formatting of the passed value.
String	getAsMatching(BigDecimal aSize, int nDecimals) Get the best matching formatting of the passed value.
String	getAsMatching(BigInteger aSize) Get the best matching formatting of the passed value.
String	getAsMatching(BigInteger aSize, int nDecimals) Get the best matching formatting of the passed value.
String	getAsMatching(long nSize)
String	getAsMatching(long nSize, int nDecimals)
String	getAsMB(long nSize)
String	getAsMB(long nSize, int nDecimals)
String	getAsPB(long nSize)
String	getAsPB(long nSize, int nDecimals)
String	getAsTB(long nSize)
String	getAsTB(long nSize, int nDecimals)
static SizeHelper	getSizeHelperOfLocale(Locale aDisplayLocale) Get the size helper for the passed locale.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

B_SUFFIX

public static final String B_SUFFIX

Suffix for Bytes

See Also:

Constant Field Values

KB_SUFFIX

public static final String KB_SUFFIX

Suffix for Kilobytes

See Also:

Constant Field Values

MB_SUFFIX

public static final String MB_SUFFIX

Suffix for Megabytes

See Also:

Constant Field Values

GB_SUFFIX

public static final String GB_SUFFIX

Suffix for Gigabytes

See Also:

Constant Field Values

TB_SUFFIX

public static final String TB_SUFFIX

Suffix for Terabytes

See Also:

Constant Field Values

PB_SUFFIX

public static final String PB_SUFFIX

Suffix for Petabytes

See Also:

Constant Field Values

Constructor Detail

SizeHelper

public SizeHelper(@Nonnull
                  Locale aDisplayLocale)

SizeHelper

public SizeHelper(@Nonnull
                  DecimalFormatSymbols aDFS)

Method Detail

getAsKB

@Nonnull
public String getAsKB(long nSize)

getAsKB

@Nonnull
public String getAsKB(long nSize,
                                @Nonnegative
                                int nDecimals)

getAsMB

@Nonnull
public String getAsMB(long nSize)

getAsMB

@Nonnull
public String getAsMB(long nSize,
                                @Nonnegative
                                int nDecimals)

getAsGB

@Nonnull
public String getAsGB(long nSize)

getAsGB

@Nonnull
public String getAsGB(long nSize,
                                @Nonnegative
                                int nDecimals)

getAsTB

@Nonnull
public String getAsTB(long nSize)

getAsTB

@Nonnull
public String getAsTB(long nSize,
                                @Nonnegative
                                int nDecimals)

getAsPB

@Nonnull
public String getAsPB(long nSize)

getAsPB

@Nonnull
public String getAsPB(long nSize,
                                @Nonnegative
                                int nDecimals)

getAsMatching

@Nonnull
public String getAsMatching(@Nonnull
                                      BigInteger aSize)

Get the best matching formatting of the passed value. No fraction digits will be emitted.

Parameters:

aSize - The value to be converted to a size value. May not be null.

Returns:

The string representation

Throws:

IllegalArgumentException - If the passed value cannot be fit in a long

getAsMatching

@Nonnull
public String getAsMatching(@Nonnull
                                      BigInteger aSize,
                                      @Nonnegative
                                      int nDecimals)

Get the best matching formatting of the passed value.

Parameters:

aSize - The value to be converted to a size value. May not be null.

nDecimals - The number of fraction digits.

Returns:

The string representation

Throws:

IllegalArgumentException - If the passed value cannot be fit in a long

getAsMatching

@Nonnull
public String getAsMatching(@Nonnull
                                      BigDecimal aSize)

Get the best matching formatting of the passed value. No fraction digits will be emitted.

Parameters:

aSize - The value to be converted to a size value. May not be null.

Returns:

The string representation

Throws:

IllegalArgumentException - If the passed value cannot be fit in a long

getAsMatching

@Nonnull
public String getAsMatching(@Nonnull
                                      BigDecimal aSize,
                                      @Nonnegative
                                      int nDecimals)

Get the best matching formatting of the passed value.

Parameters:

aSize - The value to be converted to a size value. May not be null.

nDecimals - The number of fraction digits.

Returns:

The string representation

Throws:

IllegalArgumentException - If the passed value cannot be fit in a long

getAsMatching

@Nonnull
public String getAsMatching(long nSize)

getAsMatching

@Nonnull
public String getAsMatching(long nSize,
                                      @Nonnegative
                                      int nDecimals)

toString

public String toString()

Overrides:

toString in class Object

getSizeHelperOfLocale

@Nonnull
public static SizeHelper getSizeHelperOfLocale(@Nonnull
                                                         Locale aDisplayLocale)

Get the size helper for the passed locale. The locale determines the formatting of the numeric value.

Parameters:

aDisplayLocale - The locale to be used.

Returns:

The non-null SizeHelper object for the passed locale.