org.apache.ratis.util

Enum TraditionalBinaryPrefix

java.lang.Object

java.lang.Enum<TraditionalBinaryPrefix>

org.apache.ratis.util.TraditionalBinaryPrefix

All Implemented Interfaces:

Serializable, Comparable<TraditionalBinaryPrefix>

public enum TraditionalBinaryPrefix
extends Enum<TraditionalBinaryPrefix>

The traditional binary prefixes, kilo, mega, ..., exa, which can be represented by a 64-bit integer. TraditionalBinaryPrefix symbols are case insensitive.

Enum Constant Summary

Enum Constants

Enum Constant and Description
EXA
GIGA
KILO
MEGA
PETA
TERA

Method Summary

Modifier and Type	Method and Description
char	getSymbol()
long	getValue()
static String	long2String(long n, String unit, int decimalPlaces) Convert a long integer to a string with traditional binary prefix.
static long	string2long(String s) Convert a string to long.
long	toLong(long n)
String	toString(long n)
static TraditionalBinaryPrefix	valueOf(char symbol)
static TraditionalBinaryPrefix	valueOf(String name) Returns the enum constant of this type with the specified name.
static TraditionalBinaryPrefix[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

KILO

public static final TraditionalBinaryPrefix KILO

MEGA

public static final TraditionalBinaryPrefix MEGA

GIGA

public static final TraditionalBinaryPrefix GIGA

TERA

public static final TraditionalBinaryPrefix TERA

PETA

public static final TraditionalBinaryPrefix PETA

EXA

public static final TraditionalBinaryPrefix EXA

Method Detail

values

public static TraditionalBinaryPrefix[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (TraditionalBinaryPrefix c : TraditionalBinaryPrefix.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static TraditionalBinaryPrefix valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getValue

public long getValue()

getSymbol

public char getSymbol()

toLong

public long toLong(long n)

toString

public String toString(long n)

valueOf

public static TraditionalBinaryPrefix valueOf(char symbol)

Returns:

The object corresponding to the symbol.

string2long

public static long string2long(String s)

Convert a string to long. The input string is first be trimmed and then it is parsed with traditional binary prefix. For example, "-1230k" will be converted to -1230 * 1024 = -1259520; "891g" will be converted to 891 * 1024^3 = 956703965184;

Parameters:

s - input string

Returns:

a long value represented by the input string.

long2String

public static String long2String(long n,
                                 String unit,
                                 int decimalPlaces)

Convert a long integer to a string with traditional binary prefix.

Parameters:

n - the value to be converted

unit - The unit, e.g. "B" for bytes.

decimalPlaces - The number of decimal places.

Returns:

a string with traditional binary prefix.