ByteSize (OWNER :: Java 8 Extras 1.0.12 API)

java.lang.Object
- org.aeonbits.owner.util.bytesize.ByteSize

```
public class ByteSize
extends java.lang.Object
```
A unit of byte size, such as "512 kilobytes". This class models a two part byte count size, one part being a value and the other part being a ByteSizeUnit. This class supports converting to another ByteSizeUnit.

Author:

Stefan Freyr Stefansson

Constructor Summary

Constructors
Constructor	Description
`ByteSize(double value, ByteSizeUnit unit)`	Creates a byte size value from a `double` value and a `ByteSizeUnit`.
`ByteSize(long bytes)`	Creates a byte size value from a `long` value representing the number of bytes.
`ByteSize(long value, ByteSizeUnit unit)`	Creates a byte size value from a `long` value and a `ByteSizeUnit`.
`ByteSize(java.lang.String value, ByteSizeUnit unit)`	Creates a byte size value from a `String` value and a `ByteSizeUnit`.
`ByteSize(java.math.BigDecimal value, ByteSizeUnit unit)`	Creates a byte size value from two parts, a value and a `ByteSizeUnit`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`ByteSize`	`convertTo(ByteSizeUnit unit)`	Creates a new `ByteSize` representing the same byte size but in a different unit.
`boolean`	`equals(java.lang.Object o)`
`java.math.BigInteger`	`getBytes()`	Returns the number of bytes that this byte size represents after multiplying the unit factor with the value.
`int`	`getBytesAsInt()`	Returns the number of bytes that this byte size represents as an `int` after multiplying the unit factor with the value, throwing an exception if the result overflows an `int`.
`long`	`getBytesAsLong()`	Returns the number of bytes that this byte size represents as a `long` after multiplying the unit factor with the value, throwing an exception if the result overflows a `long`.
`int`	`hashCode()`
`java.lang.String`	`toString()`

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

- Constructor Detail
  - ByteSize
```
public ByteSize(java.math.BigDecimal value,
                ByteSizeUnit unit)
```
    Creates a byte size value from two parts, a value and a ByteSizeUnit.
    
    Parameters:
    
    value - the value part of this byte size.
    
    unit - the unit part of this byte size.
  - ByteSize
```
public ByteSize(long bytes)
```
    Creates a byte size value from a long value representing the number of bytes. The unit part of this byte size will be ByteSizeUnit.BYTES.
    
    Parameters:
    
    bytes - the number of bytes this ByteSize instance should represent
  - ByteSize
```
public ByteSize(java.lang.String value,
                ByteSizeUnit unit)
```
    Creates a byte size value from a String value and a ByteSizeUnit.
    
    Parameters:
    
    value - the value part of this byte size
    
    unit - the unit part of this byte size
  - ByteSize
```
public ByteSize(long value,
                ByteSizeUnit unit)
```
    Creates a byte size value from a long value and a ByteSizeUnit.
    
    Parameters:
    
    value - the value part of this byte size
    
    unit - the unit part of this byte size
  - ByteSize
```
public ByteSize(double value,
                ByteSizeUnit unit)
```
    Creates a byte size value from a double value and a ByteSizeUnit.
    
    Parameters:
    
    value - the value part of this byte size
    
    unit - the unit part of this byte size
- Method Detail
  - getBytes
```
public java.math.BigInteger getBytes()
```
    Returns the number of bytes that this byte size represents after multiplying the unit factor with the value. Since the value part can be a represented by a decimal, there is some possibility of a rounding error. Therefore, the result of multiplying the value and the unit factor are always rounded towards positive infinity to the nearest integer value (see RoundingMode.CEILING) to make sure that this method never gives values that are too small.
    
    Returns:
    
    number of bytes this byte size represents after factoring in the unit.
  - getBytesAsLong
```
public long getBytesAsLong()
```
    Returns the number of bytes that this byte size represents as a long after multiplying the unit factor with the value, throwing an exception if the result overflows a long.
    
    Returns:
    
    the number of bytes that this byte size represents after factoring in the unit.
    
    Throws:
    
    java.lang.ArithmeticException - if the result overflows a long
  - getBytesAsInt
```
public int getBytesAsInt()
```
    Returns the number of bytes that this byte size represents as an int after multiplying the unit factor with the value, throwing an exception if the result overflows an int.
    
    Returns:
    
    the number of bytes that this byte size represents after factoring in the unit.
    
    Throws:
    
    java.lang.ArithmeticException - if the result overflows an int
  - convertTo
```
public ByteSize convertTo(ByteSizeUnit unit)
```
    Creates a new ByteSize representing the same byte size but in a different unit. Scale of the value (number of decimal points) is handled automatically but if a non-terminating decimal expansion occurs, an ArithmeticException is thrown.
    
    Parameters:
    
    unit - the unit for the new ByteSize.
    
    Returns:
    
    a new ByteSize instance representing the same byte size as this but using the specified unit.
    
    Throws:
    
    java.lang.ArithmeticException - if a non-terminating decimal expansion occurs during calculation.
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object o)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object

Class ByteSize

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ByteSize

ByteSize

ByteSize

ByteSize

ByteSize

Method Detail

getBytes

getBytesAsLong

getBytesAsInt

convertTo

toString

equals

hashCode