SizeUnit (converter 1.1.0 API)

java.lang.Object
- java.lang.Enum<SizeUnit>
- - com.kamontat.constants.SizeUnit

All Implemented Interfaces:

Serializable, Comparable<SizeUnit>
```
public enum SizeUnit
extends Enum<SizeUnit>
```
contains the unit of file size and type of that unit
The type we have 2 type
1. SI - SizeUnitType.SI
2. Non-SI - SizeUnitType.NON_SI
Since:

Thu 16/Mar/2017 - 12:02 AM

Version:

1.0

Author:

kamontat

See Also:

SizeUnitType

Enum Constant Summary

Enum Constants
Enum Constant and Description
`B` Byte or Byte
`EB` Exabyte or Exbibyte
`GB` Gigabyte or Gibibyte
`KB` Kilobyte or Kibibyte
`MB` Megabyte or Mebibyte
`PB` Petabyte or Pebibyte
`TB` Terabyte or Tebibyte
`YB` Yottabyte or Yobibyte
`ZB` Zettabyte or Zebibyte

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getString()` get unit, by type that insert
`String`	`getString(SizeUnitType type)` get string of specify input type
`SizeUnitType`	`getType()`
`static void`	`main(String[] args)` Example usage directly otherwise you can use this enum by `SizeUtil.getSize(long, SizeUnit, SizeUnitType)`
`SizeUnit`	`setType(SizeUnitType type)` set new type and return this
`BigDecimal`	`to(BigDecimal number, int decimalPoint, SizeUnit unit)` convert this unit to any unit that you pass from the parameter and return the decimal number in decimal point number Example: decimalPoint=2 the return value will compute until 2 number after pass dot (##.XX)
`BigDecimal`	`to(BigDecimal number, SizeUnit unit)` same with `to(BigDecimal, int, SizeUnit)` but pass int as `Size.SIZE_SCALE`
`BigDecimal`	`toB(BigDecimal number)` `toB(BigDecimal, int)` by place int to `Size.SIZE_SCALE`
`BigDecimal`	`toB(BigDecimal number, int decimalPoint)` convert this unit to Byte unit (`B`) 1 byte = 1 byte Minimum: 10^0 or 2^0
`BigDecimal`	`toE(BigDecimal number)` `toE(BigDecimal, int)` by place int to `Size.SIZE_SCALE`
`BigDecimal`	`toE(BigDecimal number, int decimalPoint)` convert this unit to EB unit (`EB`) 1 EB = 1,000,000,000,000,000,000 byte or 1,152,921,504,606,846,976 byte Minimum: 10^18 or 2^60
`BigDecimal`	`toG(BigDecimal number)` `toG(BigDecimal, int)` by place int to `Size.SIZE_SCALE`
`BigDecimal`	`toG(BigDecimal number, int decimalPoint)` convert this unit to GB unit (`GB`) 1 GB = 1,000,000,000 byte or 1,073,741,824 byte Minimum: 10^9 or 2^30
`BigDecimal`	`toK(BigDecimal number)` `toK(BigDecimal, int)` by place int to `Size.SIZE_SCALE`
`BigDecimal`	`toK(BigDecimal number, int decimalPoint)` convert this unit to KB unit (`KB`) 1 KB = 1000 byte or 1024 byte Minimum: 10^3 or 2^10
`BigDecimal`	`toM(BigDecimal number)` `toM(BigDecimal, int)` by place int to `Size.SIZE_SCALE`
`BigDecimal`	`toM(BigDecimal number, int decimalPoint)` convert this unit to MB unit (`MB`) 1 MB = 1,000,000 byte or 1,048,576 byte Minimum: 10^6 or 2^20
`BigDecimal`	`toP(BigDecimal number)` `toP(BigDecimal, int)` by place int to `Size.SIZE_SCALE`
`BigDecimal`	`toP(BigDecimal number, int decimalPoint)` convert this unit to PB unit (`PB`) 1 PB = 1,000,000,000,000,000 byte or 1,125,899,906,842,624 byte Minimum: 10^15 or 2^50
`BigDecimal`	`toT(BigDecimal number)` `toT(BigDecimal, int)` by place int to `Size.SIZE_SCALE`
`BigDecimal`	`toT(BigDecimal number, int decimalPoint)` convert this unit to TB unit (`TB`) 1 TB = 1,000,000,000,000 byte or 1,099,511,627,776 byte Minimum: 10^12 or 2^40
`BigDecimal`	`toY(BigDecimal number)` `toY(BigDecimal, int)` by place int to `Size.SIZE_SCALE`
`BigDecimal`	`toY(BigDecimal number, int decimalPoint)` convert this unit to YB unit (`YB`) 1 YB = 1,000,000,000,000,000,000,000,000 byte or 1,208,925,819,614,629,174,706,176 byte Minimum: 10^24 or 2^80
`BigDecimal`	`toZ(BigDecimal number)` `toZ(BigDecimal, int)` by place int to `Size.SIZE_SCALE`
`BigDecimal`	`toZ(BigDecimal number, int decimalPoint)` convert this unit to ZB unit (`ZB`) 1 ZB = 1,000,000,000,000,000,000,000 byte or 1,180,591,620,717,411,303,424 byte Minimum: 10^21 or 2^70
`static SizeUnit`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static SizeUnit`	`valueOf(String s, SizeUnitType type)` get string that must contain unit of file size and convert it to `SizeUnit`
`static SizeUnit[]`	`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
  - B
```
public static final SizeUnit B
```
    Byte or Byte
  - KB
```
public static final SizeUnit KB
```
    Kilobyte or Kibibyte
  - MB
```
public static final SizeUnit MB
```
    Megabyte or Mebibyte
  - GB
```
public static final SizeUnit GB
```
    Gigabyte or Gibibyte
  - TB
```
public static final SizeUnit TB
```
    Terabyte or Tebibyte
  - PB
```
public static final SizeUnit PB
```
    Petabyte or Pebibyte
  - EB
```
public static final SizeUnit EB
```
    Exabyte or Exbibyte
  - ZB
```
public static final SizeUnit ZB
```
    Zettabyte or Zebibyte
  - YB
```
public static final SizeUnit YB
```
    Yottabyte or Yobibyte
- Method Detail
  - values
```
public static SizeUnit[] 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 (SizeUnit c : SizeUnit.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static SizeUnit 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
  - setType
```
public SizeUnit setType(SizeUnitType type)
```
    set new type and return this
    
    Parameters:
    
    type - the new type, can't be null
    
    Returns:
    
    this
  - getType
```
public SizeUnitType getType()
```
  - getString
```
public String getString()
```
    get unit, by type that insert
    
    Returns:
    
    string of unit
  - getString
```
public String getString(SizeUnitType type)
```
    get string of specify input type
    
    Parameters:
    
    type - input size unit type
    
    Returns:
    
    string of unit
  - valueOf
```
public static SizeUnit valueOf(String s,
                               SizeUnitType type)
```
    get string that must contain unit of file size and convert it to SizeUnit
    
    Parameters:
    
    s - string that contains unit, like this SizeUtil.toMinimumByte(long, SizeUnitType) method
    
    type - the type (can be null if don't know)
    
    Returns:
    
    SizeUnit if present; otherwise, will return B
  - toB
```
public BigDecimal toB(BigDecimal number,
                      int decimalPoint)
```
    convert this unit to Byte unit (B)
    1 byte = 1 byte
    Minimum: 10^0 or 2^0
    
    Parameters:
    
    number - the number to conversion
    
    decimalPoint - the decimal to conversion, if you want to use Size.SIZE_SCALE yo can call toB(BigDecimal) method instantly
    
    Returns:
    
    the size in Byte unit
  - toK
```
public BigDecimal toK(BigDecimal number,
                      int decimalPoint)
```
    convert this unit to KB unit (KB)
    1 KB = 1000 byte or 1024 byte
    Minimum: 10^3 or 2^10
    
    Parameters:
    
    number - the number to conversion
    
    decimalPoint - the decimal to conversion, if you want to use Size.SIZE_SCALE yo can call toK(BigDecimal) method instantly
    
    Returns:
    
    the size in KB unit
  - toM
```
public BigDecimal toM(BigDecimal number,
                      int decimalPoint)
```
    convert this unit to MB unit (MB)
    1 MB = 1,000,000 byte or 1,048,576 byte
    Minimum: 10^6 or 2^20
    
    Parameters:
    
    number - the number to conversion
    
    decimalPoint - the decimal to conversion, if you want to use Size.SIZE_SCALE yo can call toM(BigDecimal) method instantly
    
    Returns:
    
    the size in MB unit
  - toG
```
public BigDecimal toG(BigDecimal number,
                      int decimalPoint)
```
    convert this unit to GB unit (GB)
    1 GB = 1,000,000,000 byte or 1,073,741,824 byte
    Minimum: 10^9 or 2^30
    
    Parameters:
    
    number - the number to conversion
    
    decimalPoint - the decimal to conversion, if you want to use Size.SIZE_SCALE yo can call toG(BigDecimal) method instantly
    
    Returns:
    
    the size in GB unit
  - toT
```
public BigDecimal toT(BigDecimal number,
                      int decimalPoint)
```
    convert this unit to TB unit (TB)
    1 TB = 1,000,000,000,000 byte or 1,099,511,627,776 byte
    Minimum: 10^12 or 2^40
    
    Parameters:
    
    number - the number to conversion
    
    decimalPoint - the decimal to conversion, if you want to use Size.SIZE_SCALE yo can call toT(BigDecimal) method instantly
    
    Returns:
    
    the size in TB unit
  - toP
```
public BigDecimal toP(BigDecimal number,
                      int decimalPoint)
```
    convert this unit to PB unit (PB)
    1 PB = 1,000,000,000,000,000 byte or 1,125,899,906,842,624 byte
    Minimum: 10^15 or 2^50
    
    Parameters:
    
    number - the number to conversion
    
    decimalPoint - the decimal to conversion, if you want to use Size.SIZE_SCALE yo can call toP(BigDecimal) method instantly
    
    Returns:
    
    the size in PB unit
  - toE
```
public BigDecimal toE(BigDecimal number,
                      int decimalPoint)
```
    convert this unit to EB unit (EB)
    1 EB = 1,000,000,000,000,000,000 byte or 1,152,921,504,606,846,976 byte
    Minimum: 10^18 or 2^60
    
    Parameters:
    
    number - the number to conversion
    
    decimalPoint - the decimal to conversion, if you want to use Size.SIZE_SCALE yo can call toE(BigDecimal) method instantly
    
    Returns:
    
    the size in EB unit
  - toZ
```
public BigDecimal toZ(BigDecimal number,
                      int decimalPoint)
```
    convert this unit to ZB unit (ZB)
    1 ZB = 1,000,000,000,000,000,000,000 byte or 1,180,591,620,717,411,303,424 byte
    Minimum: 10^21 or 2^70
    
    Parameters:
    
    number - the number to conversion
    
    decimalPoint - the decimal to conversion, if you want to use Size.SIZE_SCALE yo can call toZ(BigDecimal) method instantly
    
    Returns:
    
    the size in ZB unit
  - toY
```
public BigDecimal toY(BigDecimal number,
                      int decimalPoint)
```
    convert this unit to YB unit (YB)
    1 YB = 1,000,000,000,000,000,000,000,000 byte or 1,208,925,819,614,629,174,706,176 byte
    Minimum: 10^24 or 2^80
    
    Parameters:
    
    number - the number to conversion
    
    decimalPoint - the decimal to conversion, if you want to use Size.SIZE_SCALE yo can call toY(BigDecimal) method instantly
    
    Returns:
    
    the size in YB unit
  - toB
```
public BigDecimal toB(BigDecimal number)
```
    toB(BigDecimal, int) by place int to Size.SIZE_SCALE
    
    Parameters:
    
    number - the conversion number
    
    Returns:
    
    the size that already convert
  - toK
```
public BigDecimal toK(BigDecimal number)
```
    toK(BigDecimal, int) by place int to Size.SIZE_SCALE
    
    Parameters:
    
    number - the conversion number
    
    Returns:
    
    the size that already convert
  - toM
```
public BigDecimal toM(BigDecimal number)
```
    toM(BigDecimal, int) by place int to Size.SIZE_SCALE
    
    Parameters:
    
    number - the conversion number
    
    Returns:
    
    the size that already convert
  - toG
```
public BigDecimal toG(BigDecimal number)
```
    toG(BigDecimal, int) by place int to Size.SIZE_SCALE
    
    Parameters:
    
    number - the conversion number
    
    Returns:
    
    the size that already convert
  - toT
```
public BigDecimal toT(BigDecimal number)
```
    toT(BigDecimal, int) by place int to Size.SIZE_SCALE
    
    Parameters:
    
    number - the conversion number
    
    Returns:
    
    the size that already convert
  - toP
```
public BigDecimal toP(BigDecimal number)
```
    toP(BigDecimal, int) by place int to Size.SIZE_SCALE
    
    Parameters:
    
    number - the conversion number
    
    Returns:
    
    the size that already convert
  - toE
```
public BigDecimal toE(BigDecimal number)
```
    toE(BigDecimal, int) by place int to Size.SIZE_SCALE
    
    Parameters:
    
    number - the conversion number
    
    Returns:
    
    the size that already convert
  - toZ
```
public BigDecimal toZ(BigDecimal number)
```
    toZ(BigDecimal, int) by place int to Size.SIZE_SCALE
    
    Parameters:
    
    number - the conversion number
    
    Returns:
    
    the size that already convert
  - toY
```
public BigDecimal toY(BigDecimal number)
```
    toY(BigDecimal, int) by place int to Size.SIZE_SCALE
    
    Parameters:
    
    number - the conversion number
    
    Returns:
    
    the size that already convert
  - to
```
public BigDecimal to(BigDecimal number,
                     int decimalPoint,
                     SizeUnit unit)
```
    convert this unit to any unit that you pass from the parameter
    and return the decimal number in decimal point number
    Example: decimalPoint=2
    the return value will compute until 2 number after pass dot (##.XX)
    
    Parameters:
    
    number - the conversion number
    
    decimalPoint - the number of number after dot (###.XX)
    
    unit - the unit that want to convert to
    
    Returns:
    
    number that already converted
  - to
```
public BigDecimal to(BigDecimal number,
                     SizeUnit unit)
```
    same with to(BigDecimal, int, SizeUnit) but pass int as Size.SIZE_SCALE
    
    Parameters:
    
    number - the conversion number
    
    unit - the unit that want to convert to
    
    Returns:
    
    number that already converted
  - main
```
public static void main(String[] args)
```
    Example usage directly
    otherwise you can use this enum by SizeUtil.getSize(long, SizeUnit, SizeUnitType)
    
    Parameters:
    
    args - no used
    
    See Also:
    
    SizeUtil, Size

Enum SizeUnit

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

B

KB

MB

GB

TB

PB

EB

ZB

YB

Method Detail

values

valueOf

setType

getType

getString

getString

valueOf

toB

toK

toM

toG

toT

toP

toE

toZ

toY

toB

toK

toM

toG

toT

toP

toE

toZ

toY

to

to

main