Class SearchHistoryEntry.Builder

java.lang.Object

ca.phon.util.SearchHistoryEntry.Builder

Enclosing class:

SearchHistoryEntry

public static final class SearchHistoryEntry.Builder
extends Object

Builder class for creating SearchHistoryEntry instances.

Method Summary

Modifier and Type	Method	Description
SearchHistoryEntry	build()	Builds the search history entry.
SearchHistoryEntry.Builder	caseSensitive(boolean caseSensitive)	Sets whether the search is case sensitive.
SearchHistoryEntry.Builder	clearParameters()	Clears all parameters.
SearchHistoryEntry.Builder	date(LocalDateTime date)	Sets the search date.
SearchHistoryEntry.Builder	parameter(String key, String value)	Adds a single parameter.
SearchHistoryEntry.Builder	parameters(Map<String,String> parameters)	Adds multiple parameters from a map.
SearchHistoryEntry.Builder	queryText(String queryText)	Sets the query text.
SearchHistoryEntry.Builder	queryType(SearchType queryType)	Sets the query type.
SearchHistoryEntry.Builder	removeParameter(String key)	Removes a parameter.

Methods inherited from class java.lang.Object

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

Method Details

date

public SearchHistoryEntry.Builder date(LocalDateTime date)

Sets the search date. If not specified, the current date/time will be used.

Parameters:

date - the search date

Returns:

this builder

queryText

public SearchHistoryEntry.Builder queryText(String queryText)

Sets the query text.

Parameters:

queryText - the query text (required, cannot be null or empty)

Returns:

this builder

Throws:

IllegalArgumentException - if queryText is null or empty

queryType

public SearchHistoryEntry.Builder queryType(SearchType queryType)

Sets the query type.

Parameters:

queryType - the query type (required, cannot be null or empty)

Returns:

this builder

Throws:

IllegalArgumentException - if queryType is null or empty

caseSensitive

public SearchHistoryEntry.Builder caseSensitive(boolean caseSensitive)

Sets whether the search is case sensitive.

Parameters:

caseSensitive - true for case sensitive search

Returns:

this builder

parameter

public SearchHistoryEntry.Builder parameter(String key,
 String value)

Adds a single parameter.

Parameters:

key - the parameter key (cannot be null)

value - the parameter value (cannot be null)

Returns:

this builder

Throws:

IllegalArgumentException - if key or value is null

parameters

public SearchHistoryEntry.Builder parameters(Map<String,String> parameters)

Adds multiple parameters from a map.

Parameters:

parameters - the parameters to add (cannot be null)

Returns:

this builder

Throws:

IllegalArgumentException - if parameters is null or contains null keys/values

removeParameter

public SearchHistoryEntry.Builder removeParameter(String key)

Removes a parameter.

Parameters:

key - the parameter key to remove

Returns:

this builder

clearParameters

public SearchHistoryEntry.Builder clearParameters()

Clears all parameters.

Returns:

this builder

build

public SearchHistoryEntry build()

Builds the search history entry.

Returns:

a new SearchHistoryEntry instance

Throws:

IllegalStateException - if required fields are not set