Spring Core 6.1.4 · org.springframework.util.unit.DataSize

Term	Data Size	Size in Bytes
byte	1B	1
kilobyte	1KB	1,024
megabyte	1MB	1,048,576
gigabyte	1GB	1,073,741,824
terabyte	1TB	1,099,511,627,776

Modifier and Type	Class and Description
private static class	DataSize.DataSizeUtils Static nested class to support lazy loading of the `PATTERN`.

Modifier and Type	Field and Description
private final long	bytes
private static final long	BYTES_PER_GB Bytes per Gigabyte.
private static final long	BYTES_PER_KB Bytes per Kilobyte.
private static final long	BYTES_PER_MB Bytes per Megabyte.
private static final long	BYTES_PER_TB Bytes per Terabyte.

Access	Constructor and Description
private	DataSize(long bytes)

Method Summary

Modifier and Type	Method and Description
public int	compareTo(DataSize the object to be compared. other) Implements java.lang.Comparable.compareTo. Compares this object with the specified object for order.
public boolean	equals(Object the reference object with which to compare. obj) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for the object.
public boolean	Returns: true if this size has a size less than zero bytes isNegative() Checks if this size is negative, excluding zero.
public static DataSize	Returns: a corresponding `DataSize` of(long the amount of the size, measured in terms of the unit, positive or negative amount, DataUnit unit) Obtain a `DataSize` representing an amount in the specified `DataUnit`.
public static DataSize	Returns: a `DataSize` ofBytes(long the number of bytes, positive or negative bytes) Obtain a `DataSize` representing the specified number of bytes.
public static DataSize	Returns: a `DataSize` ofGigabytes(long the number of gigabytes, positive or negative gigabytes) Obtain a `DataSize` representing the specified number of gigabytes.
public static DataSize	Returns: a `DataSize` ofKilobytes(long the number of kilobytes, positive or negative kilobytes) Obtain a `DataSize` representing the specified number of kilobytes.
public static DataSize	Returns: a `DataSize` ofMegabytes(long the number of megabytes, positive or negative megabytes) Obtain a `DataSize` representing the specified number of megabytes.
public static DataSize	Returns: a `DataSize` ofTerabytes(long the number of terabytes, positive or negative terabytes) Obtain a `DataSize` representing the specified number of terabytes.
public static DataSize	Returns: the parsed `DataSize` parse(CharSequence the text to parse text) Obtain a `DataSize` from a text string such as `12MB` using `DataUnit#BYTES` if no unit is specified.
public static DataSize	Returns: the parsed `DataSize` parse(CharSequence the text to parse text, DataUnit the default `DataUnit` to use defaultUnit) Obtain a `DataSize` from a text string such as `12MB` using the specified default `DataUnit` if no unit is specified.
public long	Returns: the number of bytes toBytes() Return the number of bytes in this instance.
public long	Returns: the number of gigabytes toGigabytes() Return the number of gigabytes in this instance.
public long	Returns: the number of kilobytes toKilobytes() Return the number of kilobytes in this instance.
public long	Returns: the number of megabytes toMegabytes() Return the number of megabytes in this instance.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
public long	Returns: the number of terabytes toTerabytes() Return the number of terabytes in this instance.

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll wait wait wait

bytes	back to summary
private final long bytes

BYTES_PER_GB	back to summary
private static final long BYTES_PER_GB Bytes per Gigabyte.

BYTES_PER_KB	back to summary
private static final long BYTES_PER_KB Bytes per Kilobyte.

BYTES_PER_MB	back to summary
private static final long BYTES_PER_MB Bytes per Megabyte.

BYTES_PER_TB	back to summary
private static final long BYTES_PER_TB Bytes per Terabyte.

DataSize	back to summary
private DataSize(long bytes)

Method Detail

compareTo back to summary

compareTo	back to summary
public int compareTo(DataSize other) Implements java.lang.Comparable.compareTo. Doc from java.lang.Comparable.compareTo. Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object. The implementor must ensure `signum(x.compareTo(y)) == -signum(y.compareTo(x))` for all `x` and `y`. (This implies that `x.compareTo(y)` must throw an exception if and only if `y.compareTo(x)` throws an exception.) The implementor must also ensure that the relation is transitive: `(x.compareTo(y) > 0 && y.compareTo(z) > 0)` implies `x.compareTo(z) > 0`. Finally, the implementor must ensure that `x.compareTo(y)==0` implies that `signum(x.compareTo(z)) == signum(y.compareTo(z))`, for all `z`. Parameters other:DataSize the object to be compared. Returns:int a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object. Annotations @Override

public int compareTo(DataSize other)

Implements java.lang.Comparable.compareTo.

Doc from java.lang.Comparable.compareTo.

Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

The implementor must ensure signum(x.compareTo(y)) == -signum(y.compareTo(x)) for all x and y. (This implies that x.compareTo(y) must throw an exception if and only if y.compareTo(x) throws an exception.)

The implementor must also ensure that the relation is transitive: (x.compareTo(y) > 0 && y.compareTo(z) > 0) implies x.compareTo(z) > 0.

Finally, the implementor must ensure that x.compareTo(y)==0 implies that signum(x.compareTo(z)) == signum(y.compareTo(z)), for all z.

Parameters

other:DataSize: the object to be compared.

Returns:int

a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

Annotations

@Override

equals back to summary

equals	back to summary
public boolean equals(Object obj) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Parameters obj:Object the reference object with which to compare. Returns:boolean `true` if this object is the same as the obj argument; `false` otherwise. Annotations @Override

public boolean equals(Object obj)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters

obj:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Returns:int a hash code value for this object. Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int

a hash code value for this object.

Annotations

@Override

isNegative	back to summary
public boolean isNegative() Checks if this size is negative, excluding zero. Returns:boolean true if this size has a size less than zero bytes

isNegative

back to summary

public boolean isNegative()

Checks if this size is negative, excluding zero.

Returns:boolean: true if this size has a size less than zero bytes

of back to summary

of	back to summary
public static DataSize of(long amount, DataUnit unit) Obtain a `DataSize` representing an amount in the specified `DataUnit`. Parameters amount:long the amount of the size, measured in terms of the unit, positive or negative Returns:DataSize a corresponding `DataSize`

public static DataSize of(long amount, DataUnit unit)

Obtain a DataSize representing an amount in the specified DataUnit.

Parameters

amount:long: the amount of the size, measured in terms of the unit, positive or negative

Returns:DataSize

a corresponding DataSize

ofBytes back to summary

ofBytes	back to summary
public static DataSize ofBytes(long bytes) Obtain a `DataSize` representing the specified number of bytes. Parameters bytes:long the number of bytes, positive or negative Returns:DataSize a `DataSize`

public static DataSize ofBytes(long bytes)

Obtain a DataSize representing the specified number of bytes.

Parameters

bytes:long: the number of bytes, positive or negative

Returns:DataSize

a DataSize

ofGigabytes back to summary

ofGigabytes	back to summary
public static DataSize ofGigabytes(long gigabytes) Obtain a `DataSize` representing the specified number of gigabytes. Parameters gigabytes:long the number of gigabytes, positive or negative Returns:DataSize a `DataSize`

public static DataSize ofGigabytes(long gigabytes)

Obtain a DataSize representing the specified number of gigabytes.

Parameters

gigabytes:long: the number of gigabytes, positive or negative

Returns:DataSize

a DataSize

ofKilobytes back to summary

ofKilobytes	back to summary
public static DataSize ofKilobytes(long kilobytes) Obtain a `DataSize` representing the specified number of kilobytes. Parameters kilobytes:long the number of kilobytes, positive or negative Returns:DataSize a `DataSize`

public static DataSize ofKilobytes(long kilobytes)

Obtain a DataSize representing the specified number of kilobytes.

Parameters

kilobytes:long: the number of kilobytes, positive or negative

Returns:DataSize

a DataSize

ofMegabytes back to summary

ofMegabytes	back to summary
public static DataSize ofMegabytes(long megabytes) Obtain a `DataSize` representing the specified number of megabytes. Parameters megabytes:long the number of megabytes, positive or negative Returns:DataSize a `DataSize`

public static DataSize ofMegabytes(long megabytes)

Obtain a DataSize representing the specified number of megabytes.

Parameters

megabytes:long: the number of megabytes, positive or negative

Returns:DataSize

a DataSize

ofTerabytes back to summary

ofTerabytes	back to summary
public static DataSize ofTerabytes(long terabytes) Obtain a `DataSize` representing the specified number of terabytes. Parameters terabytes:long the number of terabytes, positive or negative Returns:DataSize a `DataSize`

public static DataSize ofTerabytes(long terabytes)

Obtain a DataSize representing the specified number of terabytes.

Parameters

terabytes:long: the number of terabytes, positive or negative

Returns:DataSize

a DataSize

parse back to summary

parse	back to summary
public static DataSize parse(CharSequence text) Obtain a `DataSize` from a text string such as `12MB` using `DataUnit#BYTES` if no unit is specified. Examples: "12KB" -- parses as "12 kilobytes" "5MB" -- parses as "5 megabytes" "20" -- parses as "20 bytes" Parameters text:CharSequence the text to parse Returns:DataSize the parsed `DataSize` See Also `parse(CharSequence, DataUnit)`

public static DataSize parse(CharSequence text)

Obtain a DataSize from a text string such as 12MB using DataUnit#BYTES if no unit is specified.

Examples:

"12KB" -- parses as "12 kilobytes"
"5MB"  -- parses as "5 megabytes"
"20"   -- parses as "20 bytes"

Parameters

text:CharSequence: the text to parse

Returns:DataSize

the parsed DataSize

See Also

parse(CharSequence, DataUnit)

parse back to summary

parse	back to summary
public static DataSize parse(CharSequence text, DataUnit defaultUnit) Obtain a `DataSize` from a text string such as `12MB` using the specified default `DataUnit` if no unit is specified. The string starts with a number followed optionally by a unit matching one of the supported suffixes. If neither a unit nor a default `DataUnit` is specified, `DataUnit#BYTES` will be inferred. Examples: "12KB" -- parses as "12 kilobytes" "5MB" -- parses as "5 megabytes" "20" -- parses as "20 kilobytes" (where the `defaultUnit` is `DataUnit#KILOBYTES`) "20" -- parses as "20 bytes" (if the `defaultUnit` is `null`) Parameters text:CharSequence the text to parse defaultUnit:DataUnit the default `DataUnit` to use Returns:DataSize the parsed `DataSize`

public static DataSize parse(CharSequence text, DataUnit defaultUnit)

Obtain a DataSize from a text string such as 12MB using the specified default DataUnit if no unit is specified.

The string starts with a number followed optionally by a unit matching one of the supported suffixes.

If neither a unit nor a default DataUnit is specified, DataUnit#BYTES will be inferred.

Examples:

"12KB" -- parses as "12 kilobytes"
"5MB"  -- parses as "5 megabytes"
"20"   -- parses as "20 kilobytes" (where the defaultUnit is DataUnit#KILOBYTES)
"20"   -- parses as "20 bytes" (if the defaultUnit is null)

Parameters

text:CharSequence: the text to parse
defaultUnit:DataUnit: the default DataUnit to use

Returns:DataSize

the parsed DataSize

toBytes	back to summary
public long toBytes() Return the number of bytes in this instance. Returns:long the number of bytes

toBytes

back to summary

public long toBytes()

Return the number of bytes in this instance.

Returns:long: the number of bytes

toGigabytes	back to summary
public long toGigabytes() Return the number of gigabytes in this instance. Returns:long the number of gigabytes

toGigabytes

back to summary

public long toGigabytes()

Return the number of gigabytes in this instance.

Returns:long: the number of gigabytes

toKilobytes	back to summary
public long toKilobytes() Return the number of kilobytes in this instance. Returns:long the number of kilobytes

toKilobytes

back to summary

public long toKilobytes()

Return the number of kilobytes in this instance.

Returns:long: the number of kilobytes

toMegabytes	back to summary
public long toMegabytes() Return the number of megabytes in this instance. Returns:long the number of megabytes

toMegabytes

back to summary

public long toMegabytes()

Return the number of megabytes in this instance.

Returns:long: the number of megabytes

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Returns:String a string representation of the object. Annotations @Override

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations