Package org.apache.hadoop.yarn.util

Class UnitsConversionUtil

java.lang.Object

org.apache.hadoop.yarn.util.UnitsConversionUtil

@Private
@Unstable
public class UnitsConversionUtil
extends java.lang.Object

A util to convert values in one unit to another. Units refers to whether the value is expressed in pico, nano, etc.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	UnitsConversionUtil.Converter	Helper class for encapsulating conversion values.

Field Summary

Fields

Modifier and Type	Field	Description
static java.util.Set<java.lang.String>	KNOWN_UNITS

Constructor Summary

Constructors

Constructor	Description
UnitsConversionUtil()

Method Summary

Modifier and Type	Method	Description
static int	compare(java.lang.String unitA, long valueA, java.lang.String unitB, long valueB)	Compare a value in a given unit with a value in another unit.
static int	compareUnits(java.lang.String unitA, java.lang.String unitB)	Compare a unit to another unit.
static long	convert(java.lang.String fromUnit, java.lang.String toUnit, long fromValue)	Converts a value from one unit to another.

Methods inherited from class java.lang.Object

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

Field Detail

KNOWN_UNITS

public static final java.util.Set<java.lang.String> KNOWN_UNITS

Constructor Detail

UnitsConversionUtil

public UnitsConversionUtil()

Method Detail

convert

public static long convert(java.lang.String fromUnit,
                           java.lang.String toUnit,
                           long fromValue)

Converts a value from one unit to another. Supported units can be obtained by inspecting the KNOWN_UNITS set.

Parameters:

fromUnit - the unit of the from value

toUnit - the target unit

fromValue - the value you wish to convert

Returns:

the value in toUnit

compare

public static int compare(java.lang.String unitA,
                          long valueA,
                          java.lang.String unitB,
                          long valueB)

Compare a value in a given unit with a value in another unit. The return value is equivalent to the value returned by compareTo.

Parameters:

unitA - first unit

valueA - first value

unitB - second unit

valueB - second value

Returns:

+1, 0 or -1 depending on whether the relationship is greater than, equal to or lesser than

compareUnits

public static int compareUnits(java.lang.String unitA,
                               java.lang.String unitB)

Compare a unit to another unit.
Examples:
1. 'm' (milli) is smaller than 'k' (kilo), so compareUnits("m", "k") will return -1.
2. 'M' (MEGA) is greater than 'k' (kilo), so compareUnits("M", "k") will return 1.

Parameters:

unitA - first unit

unitB - second unit

Returns:

+1, 0 or -1 depending on whether the relationship between units is smaller than, equal to or lesser than.