org.springframework.data.elasticsearch.core.index

Class MappingParameters

java.lang.Object

org.springframework.data.elasticsearch.core.index.MappingParameters

public final class MappingParameters
extends Object

A class to hold the mapping parameters that might be set on Field or InnerField annotation.

Since:

4.0

Author:

Peter-Josef Meisch, Aleksei Arsenev

Method Summary

Modifier and Type	Method and Description
static MappingParameters	from(Annotation annotation) extracts the mapping parameters from the relevant annotations.
boolean	isStore()
void	writeTypeAndParametersTo(org.elasticsearch.common.xcontent.XContentBuilder builder) writes the different fields to the builder.

Methods inherited from class java.lang.Object

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

Method Detail

from

public static MappingParameters from(Annotation annotation)

extracts the mapping parameters from the relevant annotations.

Parameters:

annotation - must not be null.

Returns:

empty Optional if the annotation does not have a conformant type.

isStore

public boolean isStore()

writeTypeAndParametersTo

public void writeTypeAndParametersTo(org.elasticsearch.common.xcontent.XContentBuilder builder)
                              throws IOException

writes the different fields to the builder.

Parameters:

builder - must not be null.

Throws:

IOException