com.algolia.search.saas

Class AbstractQuery

Object

com.algolia.search.saas.AbstractQuery

Direct Known Subclasses:

PlacesQuery, Query

public abstract class AbstractQuery
extends Object

An abstract search query.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractQuery.LatLng A pair of (latitude, longitude).

Method Summary

Modifier and Type	Method and Description
String	build() Build the URL query parameter string representing this object.
boolean	equals(Object other)
String	get(String name) Get a parameter in an untyped fashion.
int	hashCode()
void	parseFrom(String queryParameters) Parse a URL query parameter string and store the resulting parameters into this query.
static AbstractQuery.LatLng	parseLatLng(String value) Deprecated. Please use AbstractQuery.LatLng.parse(String) instead.
AbstractQuery	set(String name, Object value) Set a parameter in an untyped fashion.
String	toString() Obtain a debug representation of this query.

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

equals

public boolean equals(@Nullable
                      Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

@NonNull
public String toString()

Obtain a debug representation of this query. To get the raw query URL part, please see build().

Overrides:

toString in class Object

Returns:

A debug representation of this query.

build

@NonNull
public String build()

Build the URL query parameter string representing this object.

Returns:

A string suitable for use inside the query part of a URL (i.e. after the question mark).

parseFrom

public void parseFrom(@NonNull
                      String queryParameters)

Parse a URL query parameter string and store the resulting parameters into this query.

Parameters:

queryParameters - URL query parameter string.

parseLatLng

@Nullable
public static AbstractQuery.LatLng parseLatLng(String value)

Deprecated. Please use AbstractQuery.LatLng.parse(String) instead.

set

@NonNull
public AbstractQuery set(@NonNull
                                  String name,
                                  @Nullable
                                  Object value)

Set a parameter in an untyped fashion. This low-level accessor is intended to access parameters that this client does not yet support.

Parameters:

name - The parameter's name.

value - The parameter's value, or null to remove it. It will first be converted to a String by the `toString()` method.

Returns:

This instance (used to chain calls).

get

@Nullable
public String get(@NonNull
                            String name)

Get a parameter in an untyped fashion.

Parameters:

name - The parameter's name.

Returns:

The parameter's value, or null if a parameter with the specified name does not exist.