Package org.springframework.data.elasticsearch.core.index

Class Settings

java.lang.Object

org.springframework.data.elasticsearch.support.DefaultStringObjectMap<Settings>

org.springframework.data.elasticsearch.core.index.Settings

All Implemented Interfaces:

Map<String,Object>, StringObjectMap<Settings>

public class Settings
extends DefaultStringObjectMap<Settings>

class defining the settings for an index.

Since:

4.2

Author:

Peter-Josef Meisch

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K extends Object,V extends Object>

Constructor Summary

Constructors

Constructor	Description
Settings()
Settings(Map<String,Object> map)

Method Summary

Modifier and Type	Method	Description
Settings	flatten()	flattens the nested structure (JSON fields index/foo/bar/: value) into a flat structure (index.foo.bar: value)
Object	get(Object key)
void	merge(Settings other)	Merges some other settings onto this one.
static Settings	parse(String json)	Creates a Settings object from the given JSON String
String	toString()

Methods inherited from class org.springframework.data.elasticsearch.support.DefaultStringObjectMap

clear, containsKey, containsValue, entrySet, equals, forEach, fromJson, getOrDefault, hashCode, isEmpty, keySet, path, put, putAll, remove, size, toJson, values

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, merge, putIfAbsent, remove, replace, replace, replaceAll

Methods inherited from interface org.springframework.data.elasticsearch.support.StringObjectMap

append, get, getBoolean, getBooleanOrDefault, getBooleanOrDefault, getInt, getIntOrDefault, getIntOrDefault, getLong, getLongOrDefault, getLongOrDefault, getString, getStringOrDefault, getStringOrDefault

Constructor Details

Settings

public Settings()

Settings

public Settings(Map<String,Object> map)

Method Details

parse

public static Settings parse(String json)

Creates a Settings object from the given JSON String

Parameters:

json - must not be null

Returns:

Settings object

toString

public String toString()

Overrides:

toString in class DefaultStringObjectMap<Settings>

get

public Object get(Object key)

Specified by:

get in interface Map<String,Object>

Overrides:

get in class DefaultStringObjectMap<Settings>

merge

public void merge(Settings other)

Merges some other settings onto this one. Other has higher priority on same keys.

Parameters:

other - the other settings. Must not be null

Since:

4.4

flatten

public Settings flatten()

flattens the nested structure (JSON fields index/foo/bar/: value) into a flat structure (index.foo.bar: value)

Returns:

Settings with the flattened elements.