Package org.elasticsearch.common.unit
Enum ByteSizeUnit
java.lang.Object
java.lang.Enum<ByteSizeUnit>
org.elasticsearch.common.unit.ByteSizeUnit
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Comparable<ByteSizeUnit>
,java.lang.constant.Constable
,Writeable
public enum ByteSizeUnit extends java.lang.Enum<ByteSizeUnit> implements Writeable
A
SizeUnit
represents size at a given unit of
granularity and provides utility methods to convert across units.
A SizeUnit
does not maintain size information, but only
helps organize and use size representations that may be maintained
separately across various contexts.-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
java.lang.Enum.EnumDesc<E extends java.lang.Enum<E>>
Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable
Writeable.Reader<V>, Writeable.Writer<V>
-
Enum Constant Summary
-
Method Summary
Modifier and Type Method Description static ByteSizeUnit
fromId(int id)
abstract java.lang.String
getSuffix()
static ByteSizeUnit
readFrom(StreamInput in)
Reads aByteSizeUnit
from a givenStreamInput
abstract long
toBytes(long size)
abstract long
toGB(long size)
int
toIntBytes(long size)
Convert to anint
number of bytes.abstract long
toKB(long size)
abstract long
toMB(long size)
abstract long
toPB(long size)
abstract long
toTB(long size)
static ByteSizeUnit
valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name.static ByteSizeUnit[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.void
writeTo(StreamOutput out)
Write this into the StreamOutput.Methods inherited from class java.lang.Enum
clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
-
Enum Constant Details
-
BYTES
-
KB
-
MB
-
GB
-
TB
-
PB
-
-
Method Details
-
values
Returns an array containing the constants of this enum type, in the order they are declared.- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)- Parameters:
name
- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
java.lang.IllegalArgumentException
- if this enum type has no constant with the specified namejava.lang.NullPointerException
- if the argument is null
-
fromId
-
toIntBytes
public final int toIntBytes(long size)Convert to anint
number of bytes. Callers are expected to be certain this will not overflow.- Returns:
- The number of bytes represented as an
int
. - Throws:
java.lang.IllegalArgumentException
- on overflow, unless assertions are enabled in which case it throws anAssertionError
.
-
toBytes
public abstract long toBytes(long size) -
toKB
public abstract long toKB(long size) -
toMB
public abstract long toMB(long size) -
toGB
public abstract long toGB(long size) -
toTB
public abstract long toTB(long size) -
toPB
public abstract long toPB(long size) -
getSuffix
public abstract java.lang.String getSuffix() -
writeTo
Description copied from interface:Writeable
Write this into the StreamOutput. -
readFrom
Reads aByteSizeUnit
from a givenStreamInput
- Throws:
java.io.IOException
-