Package org.infinispan.commons.util

Class ByteQuantity

java.lang.Object

org.infinispan.commons.util.ByteQuantity

public final class ByteQuantity
extends Object

Parser human-readable quantity of bytes.

Since:

11.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ByteQuantity.Unit

Constructor Summary

Constructors

Constructor	Description
ByteQuantity()

Method Summary

Modifier and Type	Method	Description
static long	parse(String str)	Parses the byte quantity representation composed of a number plus a unit.

Methods inherited from class java.lang.Object

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

Constructor Details

ByteQuantity

public ByteQuantity()

Method Details

parse

public static long parse(String str)
                  throws IllegalArgumentException

Parses the byte quantity representation composed of a number plus a unit. When the unit is omitted, it is assumed as bytes (B). The supported units are:

• kilobyte (KB): 1000 bytes
• megabyte (MB): 1000² bytes
• gigabyte (GB): 1000³ bytes
• terabyte (TB): 1000⁴ bytes
• kibibyte (KiB): 1024 bytes
• mebibyte (MiB): 1024² bytes
• gibibyte (GiB): 1024³ bytes
• tebibyte (TiB): 1024⁴ bytes

Examples: 1000, 10 GB, 1.5TB, 100 GiB

Parameters:

str - The String representing a quantity (can have decimals) plus the optional unit.

Returns:

long number of bytes

Throws:

IllegalArgumentException - if the string cannot be parsed.