Class SearchRequestProperties
- java.lang.Object
-
- java.util.AbstractMap<K,V>
-
- java.util.HashMap<String,Object>
-
- com.broadleafcommerce.search.core.service.SearchRequestProperties
-
- All Implemented Interfaces:
Serializable
,Cloneable
,Map<String,Object>
public class SearchRequestProperties extends HashMap<String,Object>
An extension ofHashMap
. Allows passing arbitrary additional properties when performing a search request, including if this is a type ahead request.empty()
may be used to retrieve an empty set of properties.- See Also:
- Serialized Form
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class java.util.AbstractMap
AbstractMap.SimpleEntry<K extends Object,V extends Object>, AbstractMap.SimpleImmutableEntry<K extends Object,V extends Object>
-
-
Constructor Summary
Constructors Constructor Description SearchRequestProperties()
SearchRequestProperties(boolean typeAheadRequest)
SearchRequestProperties(int initialCapacity)
SearchRequestProperties(int initialCapacity, float loadFactor)
SearchRequestProperties(Map<? extends String,?> m)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static SearchRequestProperties
empty()
boolean
isTypeAheadRequest()
Is this a type ahead request?void
setTypeAheadRequest(boolean typeAheadRequest)
Is this a type ahead request?-
Methods inherited from class java.util.HashMap
clear, clone, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, forEach, get, getOrDefault, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values
-
Methods inherited from class java.util.AbstractMap
equals, hashCode, toString
-
-
-
-
Constructor Detail
-
SearchRequestProperties
public SearchRequestProperties(int initialCapacity, float loadFactor)
-
SearchRequestProperties
public SearchRequestProperties(int initialCapacity)
-
SearchRequestProperties
public SearchRequestProperties()
-
SearchRequestProperties
public SearchRequestProperties(boolean typeAheadRequest)
-
-
Method Detail
-
empty
public static SearchRequestProperties empty()
- Returns:
- An empty property map with
isTypeAheadRequest()
set to false.
-
isTypeAheadRequest
public boolean isTypeAheadRequest()
Is this a type ahead request?
-
setTypeAheadRequest
public void setTypeAheadRequest(boolean typeAheadRequest)
Is this a type ahead request?
-
-