org.apache.druid.java.util.common

Class HumanReadableBytes

java.lang.Object

org.apache.druid.java.util.common.HumanReadableBytes

public class HumanReadableBytes
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HumanReadableBytes.UnitSystem

Field Summary

Fields

Modifier and Type	Field and Description
static HumanReadableBytes	ZERO

Constructor Summary

Constructors

Constructor and Description
HumanReadableBytes(long bytes)
HumanReadableBytes(String bytes)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object thatObj)
static String	format(long bytes, long precision, HumanReadableBytes.UnitSystem unitSystem) Returns a human-readable string version of input value
long	getBytes()
int	getBytesInInt()
int	hashCode()
static long	parse(String number)
static long	parse(String number, long nullValue) parse the case-insensitive string number, which is either:
String	toString()
static HumanReadableBytes	valueOf(int bytes)
static HumanReadableBytes	valueOf(long bytes)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

ZERO

public static final HumanReadableBytes ZERO

Constructor Detail

HumanReadableBytes

public HumanReadableBytes(String bytes)

HumanReadableBytes

public HumanReadableBytes(long bytes)

Method Detail

getBytes

public long getBytes()

getBytesInInt

public int getBytesInInt()

equals

public boolean equals(Object thatObj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

valueOf

public static HumanReadableBytes valueOf(int bytes)

valueOf

public static HumanReadableBytes valueOf(long bytes)

parse

public static long parse(String number)

parse

public static long parse(String number,
                         long nullValue)

parse the case-insensitive string number, which is either:

a number string

or

a number string with a suffix which indicates the unit the of number the unit must be one of following k - kilobyte = 1000 m - megabyte = 1,000,000 g - gigabyte = 1,000,000,000 t - terabyte = 1,000,000,000,000 p - petabyte = 1,000,000,000,000,000 Ki(B) - kilo binary byte = 1024 Mi(B) - mega binary byte = 1024*1204 Gi(B) - giga binary byte = 1024*1024*1024 Ti(B) - tera binary byte = 1024*1024*1024*1024 Pi(B) - peta binary byte = 1024*1024*1024*1024*1024

Parameters:

nullValue - to be returned when given number is null or empty

Returns:

nullValue if input is null or empty value of number

Throws:

IAE - if the input is invalid

format

public static String format(long bytes,
                            long precision,
                            HumanReadableBytes.UnitSystem unitSystem)

Returns a human-readable string version of input value

Parameters:

bytes - input value. Negative value is also allowed

precision - [0,3]

unitSystem - which unit system is adopted to format the input value, see HumanReadableBytes.UnitSystem