Package org.elasticsearch.common.unit
Enum MemorySizeValue
- java.lang.Object
-
- java.lang.Enum<MemorySizeValue>
-
- org.elasticsearch.common.unit.MemorySizeValue
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Comparable<MemorySizeValue>
public enum MemorySizeValue extends java.lang.Enum<MemorySizeValue>
Utility methods to get memory sizes.
-
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static ByteSizeValue
parseBytesSizeValueOrHeapRatio(java.lang.String sValue, java.lang.String settingName)
Parse the provided string as a memory size.static MemorySizeValue
valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name.static MemorySizeValue[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Method Detail
-
values
public static MemorySizeValue[] 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 (MemorySizeValue c : MemorySizeValue.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static MemorySizeValue 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 namejava.lang.NullPointerException
- if the argument is null
-
parseBytesSizeValueOrHeapRatio
public static ByteSizeValue parseBytesSizeValueOrHeapRatio(java.lang.String sValue, java.lang.String settingName)
Parse the provided string as a memory size. This method either accepts absolute values such as42
(default assumed unit is byte) or2mb
, or percentages of the heap size: if the heap is 1G,10%
will be parsed as100mb
.
-
-