Package org.opensearch.core.common.unit

Class ByteSizeValue

java.lang.Object

org.opensearch.core.common.unit.ByteSizeValue

All Implemented Interfaces:

Comparable<ByteSizeValue>, Writeable, ToXContent, ToXContentFragment

@PublicApi(since="1.0.0")
public class ByteSizeValue
extends Object
implements Writeable, Comparable<ByteSizeValue>, ToXContentFragment

A byte size value

Opensearch.api:

Nested Class Summary

Nested classes/interfaces inherited from interface org.opensearch.core.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

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

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

Field Summary

Fields

Modifier and Type	Field	Description
static final ByteSizeValue	ZERO

Fields inherited from interface org.opensearch.core.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

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

Method Summary

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.core.xcontent.ToXContentFragment

isFragment

Field Details

ZERO

public static final ByteSizeValue ZERO

Constructor Details

ByteSizeValue

public ByteSizeValue(StreamInput in)
              throws IOException

Throws:

IOException

ByteSizeValue

public ByteSizeValue(long bytes)

ByteSizeValue

public ByteSizeValue(long size,
 ByteSizeUnit unit)

Method Details

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Throws:

IOException

bytesAsInt

@Deprecated
public int bytesAsInt()

Deprecated.

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()

getStringRep

public String getStringRep()

Returns:

a string representation of this value which is guaranteed to be able to be parsed using parseBytesSizeValue(String, ByteSizeValue, String). Unlike toString() this method will not output fractional or rounded values so this method should be preferred when serialising the value to JSON.

toString

public String toString()

Overrides:

toString in class Object

parseBytesSizeValue

public static ByteSizeValue parseBytesSizeValue(String sValue,
 String settingName)
                                         throws OpenSearchParseException

Throws:

OpenSearchParseException

parseBytesSizeValue

public static ByteSizeValue parseBytesSizeValue(String sValue,
 ByteSizeValue defaultValue,
 String settingName)
                                         throws OpenSearchParseException

Throws:

OpenSearchParseException

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

compareTo

public int compareTo(ByteSizeValue other)

Specified by:

compareTo in interface Comparable<ByteSizeValue>

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
 ToXContent.Params params)
                           throws IOException

Specified by:

toXContent in interface ToXContent

Throws:

IOException