Package com.couchbase.client.core.util

Class StorageSize

java.lang.Object

com.couchbase.client.core.util.StorageSize

@Volatile
public final class StorageSize
extends Object

A size measured in bytes, kibibytes, mebibytes, etc.

Create an instance using one of the "of" factory methods, or from a string using parse(String).

See Also:

• ofBytes(long)
• ofKibibytes(long)
• ofMebibytes(long)
• ofGibibytes(long)
• ofTebibytes(long)
• ofPebibytes(long)

Method Summary

Modifier and Type	Method	Description
long	bytes()	Returns the storage size in bytes.
int	bytesAsInt()	Returns the storage size in bytes.
boolean	equals(Object o)
String	format()
int	hashCode()
static StorageSize	ofBytes(long value)
static StorageSize	ofGibibytes(long value)
static StorageSize	ofKibibytes(long value)
static StorageSize	ofMebibytes(long value)
static StorageSize	ofPebibytes(long value)
static StorageSize	ofTebibytes(long value)
static StorageSize	parse(String s)	Creates a new instance from its string representation: a whole number followed by a unit, optionally separated by whitespace.
StorageSize	requireInt()
String	toString()

Methods inherited from class java.lang.Object

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

Method Details

parse

public static StorageSize parse(String s)

Creates a new instance from its string representation: a whole number followed by a unit, optionally separated by whitespace. Recognized units: B, KiB, MiB, GiB, TiB, PiB.

Examples:

• "128B" or "128 B" -> 128 bytes
• "512KiB" or "512 KiB" -> 512 kibibytes
• "64MiB" or "64 MiB" -> 64 mebibytes
• etc.

Throws:

IllegalArgumentException - if the given string could not be parsed

ofBytes

public static StorageSize ofBytes(long value)

Throws:

IllegalArgumentException - if value is negative

ofKibibytes

public static StorageSize ofKibibytes(long value)

Throws:

IllegalArgumentException - if value is negative, or the size is greater than Long.MAX_VALUE bytes (~8191 PiB)

ofMebibytes

public static StorageSize ofMebibytes(long value)

Throws:

IllegalArgumentException - if value is negative, or the size is greater than Long.MAX_VALUE bytes (~8191 PiB)

ofGibibytes

public static StorageSize ofGibibytes(long value)

Throws:

IllegalArgumentException - if value is negative, or the size is greater than Long.MAX_VALUE bytes (~8191 PiB)

ofTebibytes

public static StorageSize ofTebibytes(long value)

Throws:

IllegalArgumentException - if value is negative, or the size is greater than Long.MAX_VALUE bytes (~8191 PiB)

ofPebibytes

public static StorageSize ofPebibytes(long value)

Throws:

IllegalArgumentException - if value is negative, or the size is greater than Long.MAX_VALUE bytes (~8191 PiB)

bytes

public long bytes()

Returns the storage size in bytes.

bytesAsInt

public int bytesAsInt()

Returns the storage size in bytes.

Throws:

IllegalArgumentException - if this size is >= 2 GiB

requireInt

@Internal
public StorageSize requireInt()

format

public String format()

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object