ByteSize (MicroStream API 6.0)

All Superinterfaces:: Comparable<ByteSize>

All Known Implementing Classes:: ByteSize.Default

public interface ByteSize
extends Comparable<ByteSize>

Compound object which carries an amount paired with a ByteUnit.

Nested Class Summary

Nested Classes

Modifier and Type Interface Description

static class ByteSize.Default

Method Summary

Modifier and Type	Method	Description
`double`	`amount()`	Gets the amount of this `ByteSize`.
`long`	`bytes()`
`static ByteSize`	`New(double amount, ByteUnit unit)`	Pseudo-constructor method which creates a new `ByteSize` object.
`static ByteSize`	`New(String value)`	Pseudo-constructor method which creates a new `ByteSize` object by calling `ByteSizeParser.parse(String)`.
`String`	`toString()`	Returns the amount followed by the unit, e.g 1.2MB.
`ByteUnit`	`unit()`	Gets the unit of this `ByteSize`.

Methods inherited from interface java.lang.Comparable

compareTo

Method Details
- amount
  
  double amount()
  
  Gets the amount of this ByteSize.
  
  Returns:
  
  the amount
- unit
  
  ByteUnit unit()
  
  Gets the unit of this ByteSize.
  
  Returns:
  
  the unit
- bytes
  
  long bytes()
  
  Returns:
  
  the total number of bytes which amount() and unit() yield
  
  See Also:
  
  ByteUnit.toBytes(double)
- toString
  
  String toString()
  
  Returns the amount followed by the unit, e.g 1.2MB.
  
  Overrides:
  
  toString in class Object
  
  Returns:
  
  a String representation of this byte size, which can be understood by ByteSizeParser.parse(String)
  
  See Also:
  
  New(String)
- New
  
  static ByteSize New(String value)
  
  Pseudo-constructor method which creates a new ByteSize object by calling ByteSizeParser.parse(String).
  
  Parameters:
  
  value - the String value wich can be understood by ByteSizeParser.parse(String)
  
  Returns:
  
  a newly created ByteSize object with the given value
  
  See Also:
  
  ByteSizeParser, ByteSizeParser.parse(String)
- New
  
  static ByteSize New(double amount, ByteUnit unit)
  
  Pseudo-constructor method which creates a new ByteSize object.
  
  Parameters:
  
  amount - the amount
  
  unit - the unit
  
  Returns:
  
  a newly created ByteSize object with the given values