org.elasticsearch.common.unit

Class ByteSizeValue

java.lang.Object

org.elasticsearch.common.unit.ByteSizeValue

All Implemented Interfaces:

java.lang.Comparable<ByteSizeValue>, Writeable

public class ByteSizeValue
extends java.lang.Object
implements Writeable, java.lang.Comparable<ByteSizeValue>

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Constructor Summary

Constructors

Constructor and Description
ByteSizeValue(long bytes)
ByteSizeValue(long size, ByteSizeUnit unit)
ByteSizeValue(StreamInput in)

Method Summary

Modifier and Type	Method and Description
int	bytesAsInt()
int	compareTo(ByteSizeValue other)
boolean	equals(java.lang.Object o)
long	getBytes()
long	getGb()
double	getGbFrac()
long	getKb()
double	getKbFrac()
long	getMb()
double	getMbFrac()
long	getPb()
double	getPbFrac()
long	getTb()
double	getTbFrac()
int	hashCode()
static ByteSizeValue	parseBytesSizeValue(java.lang.String sValue, ByteSizeValue defaultValue, java.lang.String settingName)
static ByteSizeValue	parseBytesSizeValue(java.lang.String sValue, java.lang.String settingName)
java.lang.String	toString()
void	writeTo(StreamOutput out) Write this into the StreamOutput.

Methods inherited from class java.lang.Object

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

Constructor Detail

ByteSizeValue

public ByteSizeValue(StreamInput in)
              throws java.io.IOException

Throws:

java.io.IOException

ByteSizeValue

public ByteSizeValue(long bytes)

ByteSizeValue

public ByteSizeValue(long size,
                     ByteSizeUnit unit)

Method Detail

writeTo

public void writeTo(StreamOutput out)
             throws java.io.IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Throws:

java.io.IOException

bytesAsInt

public int bytesAsInt()

getBytes

public long getBytes()

getKb

public long getKb()

getMb

public long getMb()

getGb

public long getGb()

getTb

public long getTb()

getPb

public long getPb()

getKbFrac

public double getKbFrac()

getMbFrac

public double getMbFrac()

getGbFrac

public double getGbFrac()

getTbFrac

public double getTbFrac()

getPbFrac

public double getPbFrac()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

parseBytesSizeValue

public static ByteSizeValue parseBytesSizeValue(java.lang.String sValue,
                                                java.lang.String settingName)
                                         throws ElasticsearchParseException

Throws:

ElasticsearchParseException

parseBytesSizeValue

public static ByteSizeValue parseBytesSizeValue(java.lang.String sValue,
                                                ByteSizeValue defaultValue,
                                                java.lang.String settingName)
                                         throws ElasticsearchParseException

Throws:

ElasticsearchParseException

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

compareTo

public int compareTo(ByteSizeValue other)

Specified by:

compareTo in interface java.lang.Comparable<ByteSizeValue>