Package org.hibernate.search.mapper.pojo.standalone.mapping

Class SearchMappingBuilder

java.lang.Object

org.hibernate.search.mapper.pojo.standalone.mapping.SearchMappingBuilder

@Incubating
public final class SearchMappingBuilder
extends Object

Method Summary

Modifier and Type	Method	Description
CloseableSearchMapping	build()	Builds the search mapping.
SearchMappingBuilder	properties(Reader propertiesReader)	Reads the properties from the reader and sets them as overrides for already configured properties.
SearchMappingBuilder	properties(Map<String,?> map)	Sets multiple configuration properties.
SearchMappingBuilder	property(String name, Object value)	Sets a configuration property.

Methods inherited from class java.lang.Object

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

Method Details

property

public SearchMappingBuilder property(String name,
 Object value)

Sets a configuration property.

Configuration properties are mentioned in StandalonePojoMapperSettings, or in the reference documentation for backend-related properties.

Parameters:

name - The name (key) of the configuration property.

value - The value of the configuration property.

Returns:

this, for call chaining.

properties

public SearchMappingBuilder properties(Map<String,?> map)

Sets multiple configuration properties.

Configuration properties are mentioned in StandalonePojoMapperSettings, or in the reference documentation for backend-related properties.

Parameters:

map - A map containing property names (property keys) as map keys and property values as map values.

Returns:

this, for call chaining.

properties

public SearchMappingBuilder properties(Reader propertiesReader)
                                throws IOException

Reads the properties from the reader and sets them as overrides for already configured properties.

Provided reader should be compatible with Properties.load(Reader).

Configuration properties are mentioned in StandalonePojoMapperSettings, or in the reference documentation for backend-related properties.

Parameters:

propertiesReader - A configuration property source reader. Properties from it will be added as an override to previously set properties.

Returns:

this, for call chaining.

Throws:

IOException

See Also:

• ConfigurationPropertySource.withOverride(ConfigurationPropertySource)

build

public CloseableSearchMapping build()

Builds the search mapping.

Returns:

The SearchMapping.