io.ipgeolocation.api

Class GeolocationParams.GeolocationParamsBuilder

java.lang.Object

io.ipgeolocation.api.GeolocationParams.GeolocationParamsBuilder

Enclosing class:

GeolocationParams

public static class GeolocationParams.GeolocationParamsBuilder
extends Object

The GeolocationParamsBuilder class is a builder pattern for constructing GeolocationParams objects with various parameters.

Method Summary

Modifier and Type	Method and Description
GeolocationParams	build() Constructs a new GeolocationParams object using the builder's parameters.
GeolocationParams.GeolocationParamsBuilder	includeHostname() Sets whether to include hostname information in the response.
GeolocationParams.GeolocationParamsBuilder	includeHostnameFallbackLive() Sets whether to include fallback live hostname information in the response.
GeolocationParams.GeolocationParamsBuilder	includeLiveHostname() Sets whether to include live hostname information in the response.
GeolocationParams.GeolocationParamsBuilder	includeSecurity() Specifies to include security information in the response.
GeolocationParams.GeolocationParamsBuilder	includeUserAgentDetail() Specifies to include user agent detail in the response.
GeolocationParams.GeolocationParamsBuilder	withExcludes(String excludes) Sets the fields to exclude from the response.
GeolocationParams.GeolocationParamsBuilder	withFields(String fields) Sets the fields to include in the response.
GeolocationParams.GeolocationParamsBuilder	withIPAddress(String ipAddress) Sets the IPv4, IPv6 address or domain name for which geolocation information will be retrieved.
GeolocationParams.GeolocationParamsBuilder	withLang(String lang) Sets the language for the response.

Methods inherited from class java.lang.Object

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

Method Detail

withIPAddress

public GeolocationParams.GeolocationParamsBuilder withIPAddress(String ipAddress)

Sets the IPv4, IPv6 address or domain name for which geolocation information will be retrieved.

Parameters:

ipAddress - The IPv4, IPv6 address or domain name as a String.

Returns:

The GeolocationParamsBuilder instance for method chaining.

withLang

public GeolocationParams.GeolocationParamsBuilder withLang(String lang)

Sets the language for the response. Default is set to en.

Parameters:

lang - The language as a String.

Returns:

The GeolocationParamsBuilder instance for method chaining.

withFields

public GeolocationParams.GeolocationParamsBuilder withFields(String fields)

Sets the fields to include in the response. All the available fields can be found here.

Parameters:

fields - The fields as a String like "geo,time_zone,currency".

Returns:

The GeolocationParamsBuilder instance for method chaining.

withExcludes

public GeolocationParams.GeolocationParamsBuilder withExcludes(String excludes)

Sets the fields to exclude from the response.

Parameters:

excludes - The excluded fields as a String.

Returns:

The GeolocationParamsBuilder instance for method chaining.

includeHostname

public GeolocationParams.GeolocationParamsBuilder includeHostname()

Sets whether to include hostname information in the response.

This method enables the IPGeolocation API to lookup hostname from our IP-Hostname database and returns the same IP address if there is no hostname found for the queried IP address. Lookup through the IP-Hostname database is faster than other options but is experimental and under process and can produce unwanted output.

Note: use one of includeHostname, includeLiveHostname or includeHostnameFallbackLive

Returns:

The GeolocationParamsBuilder instance for method chaining.

includeLiveHostname

public GeolocationParams.GeolocationParamsBuilder includeLiveHostname()

Sets whether to include live hostname information in the response.

This method enables the IPGeolocation API to lookup hostname from live sources. Lookup through live sources is accurate but can introduce more latency to your query to IPGeolocation API.

Note: use one of includeHostname, includeLiveHostname or includeHostnameFallbackLive

Returns:

The GeolocationParamsBuilder instance for method chaining.

includeHostnameFallbackLive

public GeolocationParams.GeolocationParamsBuilder includeHostnameFallbackLive()

Sets whether to include fallback live hostname information in the response.

This method enables the IPGeolocation API to lookup hostname from our IP-Hostname database and if there is no hostname found for the queried IP address, then lookup through the live sources. This option has been introduced for faster and accurate lookup.

Note: use one of includeHostname, includeLiveHostname or includeHostnameFallbackLive

Returns:

The GeolocationParamsBuilder instance for method chaining.

includeSecurity

public GeolocationParams.GeolocationParamsBuilder includeSecurity()

Specifies to include security information in the response.

Returns:

The GeolocationParamsBuilder instance for method chaining.

includeUserAgentDetail

public GeolocationParams.GeolocationParamsBuilder includeUserAgentDetail()

Specifies to include user agent detail in the response.

Returns:

The GeolocationParamsBuilder instance for method chaining.

build

public GeolocationParams build()

Constructs a new GeolocationParams object using the builder's parameters.

Returns:

A new GeolocationParams object.