Module org.elasticsearch.server

Package org.elasticsearch.common

Class FieldMemoryStats

java.lang.Object

org.elasticsearch.common.FieldMemoryStats

All Implemented Interfaces:

Iterable<Map.Entry<String,Long>>, Writeable

public final class FieldMemoryStats
extends Object
implements Writeable, Iterable<Map.Entry<String,Long>>

A reusable class to encode field -> memory size mappings

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	Description
FieldMemoryStats(Map<String,Long> stats)	Creates a new FieldMemoryStats instance
FieldMemoryStats(StreamInput input)	Creates a new FieldMemoryStats instance from a stream

Method Summary

Modifier and Type	Method	Description
void	add(FieldMemoryStats fieldMemoryStats)	Adds / merges the given field memory stats into this stats instance
boolean	containsField(String field)	Returns true iff the given field is in the stats
FieldMemoryStats	copy()	Creates a deep copy of this stats instance
boolean	equals(Object o)
long	get(String field)	Returns the fields value in bytes or 0 if it's not present in the stats
int	hashCode()
Iterator<Map.Entry<String,Long>>	iterator()
void	toXContent(XContentBuilder builder, String key, String rawKey, String readableKey)	Generates x-content into the given builder for each of the fields in this stats instance
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Details

FieldMemoryStats

public FieldMemoryStats(Map<String,Long> stats)

Creates a new FieldMemoryStats instance

FieldMemoryStats

public FieldMemoryStats(StreamInput input)
                 throws IOException

Creates a new FieldMemoryStats instance from a stream

Throws:

IOException

Method Details

add

public void add(FieldMemoryStats fieldMemoryStats)

Adds / merges the given field memory stats into this stats instance

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

toXContent

public void toXContent(XContentBuilder builder,
 String key,
 String rawKey,
 String readableKey)
                throws IOException

Generates x-content into the given builder for each of the fields in this stats instance

Parameters:

builder - the builder to generated on

key - the top level key for this stats object

rawKey - the raw byte key for each of the fields byte sizes

readableKey - the readable key for each of the fields byte sizes

Throws:

IOException

copy

public FieldMemoryStats copy()

Creates a deep copy of this stats instance

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

iterator

public Iterator<Map.Entry<String,Long>> iterator()

Specified by:

iterator in interface Iterable<Map.Entry<String,Long>>

get

public long get(String field)

Returns the fields value in bytes or 0 if it's not present in the stats

containsField

public boolean containsField(String field)

Returns true iff the given field is in the stats