Package org.hibernate.search.engine.search.common.spi

Class MapNamedValues

java.lang.Object

org.hibernate.search.engine.search.common.spi.MapNamedValues

All Implemented Interfaces:

NamedValues

Direct Known Subclasses:

QueryParameters

@Incubating
public class MapNamedValues
extends Object
implements NamedValues

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static interface	MapNamedValues.NamedValueIncorrectType
protected static interface	MapNamedValues.NamedValueMissing

Field Summary

Fields

Modifier and Type	Field	Description
protected final Map<String,Object>	values

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	MapNamedValues(Map<String,Object> values, MapNamedValues.NamedValueMissing namedValueMissing)
protected	MapNamedValues(Map<String,Object> values, MapNamedValues.NamedValueMissing namedValueMissing, MapNamedValues.NamedValueIncorrectType namedValueIncorrectType)

Method Summary

Modifier and Type	Method	Description
static NamedValues	fromMap(Map<String,Object> map, Function<String,SearchException> namedValueMissing)	Create a simple instance of NamedValues backed by a map.
<T> T	get(String name, Class<T> paramType)
<T> Optional<T>	getOptional(String name, Class<T> paramType)

Methods inherited from class java.lang.Object

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

Field Details

values

protected final Map<String,Object> values

Constructor Details

MapNamedValues

protected MapNamedValues(Map<String,Object> values,
 MapNamedValues.NamedValueMissing namedValueMissing)

MapNamedValues

protected MapNamedValues(Map<String,Object> values,
 MapNamedValues.NamedValueMissing namedValueMissing,
 MapNamedValues.NamedValueIncorrectType namedValueIncorrectType)

Method Details

fromMap

public static NamedValues fromMap(Map<String,Object> map,
 Function<String,SearchException> namedValueMissing)

Create a simple instance of NamedValues backed by a map.

Parameters:

map - The map with values.

namedValueMissing - A function that returns an exception for the name if the value is missing.

get

public <T> T get(String name,
 Class<T> paramType)

Specified by:

get in interface NamedValues

Type Parameters:

T - The expected type of the value.

Parameters:

name - The name of the value.

paramType - The expected type of the parameter.

Returns:

The value with the given name.

getOptional

public <T> Optional<T> getOptional(String name,
 Class<T> paramType)

Specified by:

getOptional in interface NamedValues

Type Parameters:

T - The expected type of the value.

Parameters:

name - The name of the value.

paramType - The expected type of the parameter.

Returns:

An optional containing the value with the given name, or Optional.empty() if there is none.