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>
public enum ByteSizeUnit
- extends java.lang.Enum<ByteSizeUnit>
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.
Method Summary |
long |
toBytes(long size)
|
long |
toGB(long size)
|
long |
toKB(long size)
|
long |
toMB(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. |
Methods inherited from class java.lang.Enum |
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf |
Methods inherited from class java.lang.Object |
getClass, notify, notifyAll, wait, wait, wait |
BYTES
public static final ByteSizeUnit BYTES
KB
public static final ByteSizeUnit KB
MB
public static final ByteSizeUnit MB
GB
public static final ByteSizeUnit GB
values
public static ByteSizeUnit[] values()
- Returns an array containing the constants of this enum type, in
the order they are declared. This method may be used to iterate
over the constants as follows:
for (ByteSizeUnit c : ByteSizeUnit.values())
System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in
the order they are declared
valueOf
public static ByteSizeUnit valueOf(java.lang.String name)
- 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 name
java.lang.NullPointerException
- if the argument is null
toBytes
public long toBytes(long size)
toKB
public long toKB(long size)
toMB
public long toMB(long size)
toGB
public long toGB(long size)