ByteUnit (Neo4j - IO 3.1.1 API)

java.lang.Object
- java.lang.Enum<ByteUnit>
- - org.neo4j.io.ByteUnit

All Implemented Interfaces:

Serializable, Comparable<ByteUnit>
```
public enum ByteUnit
extends Enum<ByteUnit>
```
A ByteUnit is a unit for a quantity of bytes.
The unit knows how to convert between other units in its class, so you for instance can turn a number of KiBs into an accurate quantity of bytes. Precision can be lost when converting smaller units into larger units, because of integer division.
These units all follow the EIC (International Electrotechnical Commission) standard, which uses a multiplier of 1.024. This system is also known as the binary system, and has been accepted as part of the International System of Quantities. It is therefor the recommended choice when communicating quantities of information, and the only one available in this implementation.

Enum Constant Summary

Enum Constants
Enum Constant and Description

Byte

ExbiByte

GibiByte

KibiByte

MebiByte

PebiByte

TebiByte

Enum Constants
Enum Constant and Description
`Byte`
`ExbiByte`
`GibiByte`
`KibiByte`
`MebiByte`
`PebiByte`
`TebiByte`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`abbreviation()` Get the short or abbreviated name of this unit, e.g.
`static long`	`bytes(long bytes)`
`long`	`convert(long value, ByteUnit toUnit)` Convert the given value of this unit, to a value in the given unit.
`static long`	`exbiBytes(long exbibytes)`
`static long`	`gibiBytes(long gibibytes)`
`static long`	`kibiBytes(long kibibytes)`
`static long`	`mebiBytes(long mebibytes)`
`static long`	`pebiBytes(long pebibytes)`
`static long`	`tebiBytes(long tebibytes)`
`long`	`toBytes(long value)`
`long`	`toExbiBytes(long value)`
`long`	`toGibiBytes(long value)`
`long`	`toKibiBytes(long value)`
`long`	`toMebiBytes(long value)`
`long`	`toPebiBytes(long value)`
`long`	`toTebiBytes(long value)`
`static ByteUnit`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static ByteUnit[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - Byte
```
public static final ByteUnit Byte
```
  - KibiByte
```
public static final ByteUnit KibiByte
```
  - MebiByte
```
public static final ByteUnit MebiByte
```
  - GibiByte
```
public static final ByteUnit GibiByte
```
  - TebiByte
```
public static final ByteUnit TebiByte
```
  - PebiByte
```
public static final ByteUnit PebiByte
```
  - ExbiByte
```
public static final ByteUnit ExbiByte
```
- Method Detail
  - values
```
public static ByteUnit[] 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 (ByteUnit c : ByteUnit.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static ByteUnit 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
  - abbreviation
```
public String abbreviation()
```
    Get the short or abbreviated name of this unit, e.g. KiB or MiB.
    
    Returns:
    
    The short unit name.
  - convert
```
public long convert(long value,
                    ByteUnit toUnit)
```
    Convert the given value of this unit, to a value in the given unit.
    
    Parameters:
    
    value - The value to convert from this unit.
    
    toUnit - The unit of the resulting value.
    
    Returns:
    
    The value in the given result unit.
  - toBytes
```
public long toBytes(long value)
```
  - toKibiBytes
```
public long toKibiBytes(long value)
```
  - toMebiBytes
```
public long toMebiBytes(long value)
```
  - toGibiBytes
```
public long toGibiBytes(long value)
```
  - toTebiBytes
```
public long toTebiBytes(long value)
```
  - toPebiBytes
```
public long toPebiBytes(long value)
```
  - toExbiBytes
```
public long toExbiBytes(long value)
```
  - bytes
```
public static long bytes(long bytes)
```
  - kibiBytes
```
public static long kibiBytes(long kibibytes)
```
  - mebiBytes
```
public static long mebiBytes(long mebibytes)
```
  - gibiBytes
```
public static long gibiBytes(long gibibytes)
```
  - tebiBytes
```
public static long tebiBytes(long tebibytes)
```
  - pebiBytes
```
public static long pebiBytes(long pebibytes)
```
  - exbiBytes
```
public static long exbiBytes(long exbibytes)
```

Enum ByteUnit

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

Byte

KibiByte

MebiByte

GibiByte

TebiByte

PebiByte

ExbiByte

Method Detail

values

valueOf

abbreviation

convert

toBytes

toKibiBytes

toMebiBytes

toGibiBytes

toTebiBytes

toPebiBytes

toExbiBytes

bytes

kibiBytes

mebiBytes

gibiBytes

tebiBytes

pebiBytes

exbiBytes