Package io.activej.common

Class MemSize

java.lang.Object

io.activej.common.MemSize

All Implemented Interfaces:

Comparable<MemSize>

public final class MemSize
extends Object
implements Comparable<MemSize>

Encapsulates a size in bytes as a convenient abstraction

Field Summary

Fields

Modifier and Type	Field	Description
static final long	GB
static final long	KB
static final long	MB
static final long	TB
static final MemSize	ZERO

Method Summary

Modifier and Type	Method	Description
static MemSize	bytes(long bytes)	Creates a MemSize of n bytes
int	compareTo(MemSize o)
boolean	equals(Object o)
String	format()	Formats this MemSize as a string
static MemSize	gigabytes(long gigabytes)	Creates a MemSize of n gigabytes
int	hashCode()
static MemSize	kilobytes(long kilobytes)	Creates a MemSize of n kilobytes
MemSize	map(LongUnaryOperator fn)	Returns a new MemSize which has a number of bytes equal to the result of a mapping function applied to the number of bytes of this MemSize
static MemSize	megabytes(long megabytes)	Creates a MemSize of n megabytes
static MemSize	of(long bytes)	Creates a MemSize of n bytes
static MemSize	terabytes(long terabytes)	Creates a MemSize of n terabytes
int	toInt()	Returns a number of bytes is this MemSize as int
long	toLong()	Returns a number of bytes is this MemSize
String	toString()
static MemSize	valueOf(String string)	Creates a new MemSize out of a given String

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

ZERO

public static final MemSize ZERO

KB

public static final long KB

See Also:

• Constant Field Values

MB

public static final long MB

See Also:

• Constant Field Values

GB

public static final long GB

See Also:

• Constant Field Values

TB

public static final long TB

See Also:

• Constant Field Values

Method Details

of

public static MemSize of(long bytes)

Creates a MemSize of n bytes

Parameters:

bytes - a number of bytes

Returns:

a new instance of MemSize of n bytes

bytes

public static MemSize bytes(long bytes)

Creates a MemSize of n bytes

Parameters:

bytes - a number of bytes

Returns:

a new instance of MemSize of n bytes

See Also:

• of(long)

kilobytes

public static MemSize kilobytes(long kilobytes)

Creates a MemSize of n kilobytes

Parameters:

kilobytes - a number of kilobytes

Returns:

a new instance of MemSize of n kilobytes

megabytes

public static MemSize megabytes(long megabytes)

Creates a MemSize of n megabytes

Parameters:

megabytes - a number of megabytes

Returns:

a new instance of MemSize of n megabytes

gigabytes

public static MemSize gigabytes(long gigabytes)

Creates a MemSize of n gigabytes

Parameters:

gigabytes - a number of gigabytes

Returns:

a new instance of MemSize of n gigabytes

terabytes

public static MemSize terabytes(long terabytes)

Creates a MemSize of n terabytes

Parameters:

terabytes - a number of terabytes

Returns:

a new instance of MemSize of n terabytes

toLong

public long toLong()

Returns a number of bytes is this MemSize

toInt

public int toInt()

Returns a number of bytes is this MemSize as int

Throws:

IllegalStateException - if number of bytes is greater than Integer.MAX_VALUE

map

public MemSize map(LongUnaryOperator fn)

Returns a new MemSize which has a number of bytes equal to the result of a mapping function applied to the number of bytes of this MemSize

Parameters:

fn - a mapping function that maps current size to a new one

Returns:

a new MemSize with mapped number of bytes

valueOf

public static MemSize valueOf(String string)

Creates a new MemSize out of a given String

Parameters:

string - a string to be parsed

Returns:

a parsed MemSize

Throws:

IllegalArgumentException - on malformed string

See Also:

• StringFormatUtils.parseMemSize(String)

format

public String format()

Formats this MemSize as a string

A string format is the same as valueOf(String) method parses

Returns:

a string that represents a MemSize

See Also:

• StringFormatUtils.formatMemSize(MemSize)

compareTo

public int compareTo(MemSize o)

Specified by:

compareTo in interface Comparable<MemSize>

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object