Package com.geouniq.android

Class GeoUniq.CustomEndpoint.Builder

java.lang.Object

com.geouniq.android.GeoUniq.CustomEndpoint.Builder

Enclosing class:

GeoUniq.CustomEndpoint

public static class GeoUniq.CustomEndpoint.Builder
extends java.lang.Object

Builder class to obtain GeoUniq.CustomEndpoint objects

Constructor Summary

Constructors

Constructor	Description
Builder()
Builder(GeoUniq.CustomEndpoint endpoint)	Returns a Builder already configured with all the settings of the provided CustomEndpoint

Method Summary

Modifier and Type	Method	Description
GeoUniq.CustomEndpoint	build()	Creates a GeoUniq.CustomEndpoint with the parameters supplied to this Builder. Calling this method does not set the CustomEndpoint.
GeoUniq.CustomEndpoint.Builder	removeAllHeaders()	Removes all of HTTP Header for the GeoUniq.CustomEndpoint.
GeoUniq.CustomEndpoint.Builder	removeAllQueryStringParameters()	Removes all the Query-String parameters for GeoUniq.CustomEndpoint.
GeoUniq.CustomEndpoint.Builder	removeCustomData()	Removes custom data for the GeoUniq.CustomEndpoint.
GeoUniq.CustomEndpoint.Builder	removeHeader(java.lang.String key)	Removes an HTTP Header for the GeoUniq.CustomEndpoint.
GeoUniq.CustomEndpoint.Builder	removeQueryStringParameter(java.lang.String key)	Removes a Query-String parameter.
GeoUniq.CustomEndpoint.Builder	setCustomData(org.json.JSONObject data)	Sets a JSON object to be added to all location updates sent to the GeoUniq.CustomEndpoint.
GeoUniq.CustomEndpoint.Builder	setEnabled(boolean value)	Sets whether the custom endpoint must be enabled or not.
GeoUniq.CustomEndpoint.Builder	setHeader(java.lang.String key, java.lang.String value)	Configures an HTTP Header for the GeoUniq.CustomEndpoint.
GeoUniq.CustomEndpoint.Builder	setHeaders(java.util.Map<java.lang.String,java.lang.String> headers)	Sets a set of HTTP Header for the GeoUniq.CustomEndpoint.
GeoUniq.CustomEndpoint.Builder	setQueryStringParameter(java.lang.String key, java.lang.String value)	Configures a Query-String parameter to be added to the URL.
GeoUniq.CustomEndpoint.Builder	setQueryStringParameters(java.util.Map<java.lang.String,java.lang.String> parameters)	Sets a set of Query-String parameters for the GeoUniq.CustomEndpoint.
GeoUniq.CustomEndpoint.Builder	setUrl(java.lang.String url)	Sets the URL where location updates have to be sent.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Builder

public Builder(GeoUniq.CustomEndpoint endpoint)

Returns a Builder already configured with all the settings of the provided CustomEndpoint

Parameters:

endpoint - a CustomEndpoint from which all setting must be copied into this Builder

Method Detail

setUrl

public GeoUniq.CustomEndpoint.Builder setUrl(java.lang.String url)
                                      throws GeoUniq.CustomEndpoint.InvalidUrlException

Sets the URL where location updates have to be sent.

Parameters:

url - The URL

Returns:

This Builder object to allow for chaining of calls to set methods

Throws:

GeoUniq.CustomEndpoint.InvalidUrlException - if url does not represent a valid HTTP URL

See Also:

GeoUniq.setCustomEndpoint(CustomEndpoint)

setEnabled

public GeoUniq.CustomEndpoint.Builder setEnabled(boolean value)

Sets whether the custom endpoint must be enabled or not. By default, it will be disabled.

Parameters:

value - If true the custom endpoint is set as enabled.

Returns:

This Builder object to allow for chaining of calls to set methods

See Also:

GeoUniq.setCustomEndpoint(CustomEndpoint)

setHeader

public GeoUniq.CustomEndpoint.Builder setHeader(java.lang.String key,
                                                java.lang.String value)

Configures an HTTP Header for the GeoUniq.CustomEndpoint.

Parameters:

key - The HTTP header key

value - The HTTP header value

Returns:

This Builder object to allow for chaining of calls to set methods

See Also:

GeoUniq.setCustomEndpoint(CustomEndpoint)

removeHeader

public GeoUniq.CustomEndpoint.Builder removeHeader(java.lang.String key)

Removes an HTTP Header for the GeoUniq.CustomEndpoint.

Parameters:

key - The HTTP header key

Returns:

This Builder object to allow for chaining of calls to set methods

See Also:

GeoUniq.setCustomEndpoint(CustomEndpoint)

setHeaders

public GeoUniq.CustomEndpoint.Builder setHeaders(java.util.Map<java.lang.String,java.lang.String> headers)

Sets a set of HTTP Header for the GeoUniq.CustomEndpoint.

Parameters:

headers - a Map whose entries represent a single HTTP header

Returns:

This Builder object to allow for chaining of calls to set methods

See Also:

GeoUniq.setCustomEndpoint(CustomEndpoint)

removeAllHeaders

public GeoUniq.CustomEndpoint.Builder removeAllHeaders()

Removes all of HTTP Header for the GeoUniq.CustomEndpoint.

Returns:

This Builder object to allow for chaining of calls to set methods

See Also:

GeoUniq.setCustomEndpoint(CustomEndpoint)

setQueryStringParameter

public GeoUniq.CustomEndpoint.Builder setQueryStringParameter(java.lang.String key,
                                                              java.lang.String value)

Configures a Query-String parameter to be added to the URL.

Parameters:

key - The key of the parameter

value - The value of the parameter

Returns:

This Builder object to allow for chaining of calls to set methods

See Also:

GeoUniq.setCustomEndpoint(CustomEndpoint)

removeQueryStringParameter

public GeoUniq.CustomEndpoint.Builder removeQueryStringParameter(java.lang.String key)

Removes a Query-String parameter.

Parameters:

key - The key of the parameter to remove

Returns:

This Builder object to allow for chaining of calls to set methods

See Also:

GeoUniq.setCustomEndpoint(CustomEndpoint)

setQueryStringParameters

public GeoUniq.CustomEndpoint.Builder setQueryStringParameters(java.util.Map<java.lang.String,java.lang.String> parameters)

Sets a set of Query-String parameters for the GeoUniq.CustomEndpoint.

Parameters:

parameters - a Map whose entries represent a single Query-String parameter

Returns:

This Builder object to allow for chaining of calls to set methods

See Also:

GeoUniq.setCustomEndpoint(CustomEndpoint)

removeAllQueryStringParameters

public GeoUniq.CustomEndpoint.Builder removeAllQueryStringParameters()

Removes all the Query-String parameters for GeoUniq.CustomEndpoint.

Returns:

This Builder object to allow for chaining of calls to set methods

See Also:

GeoUniq.setCustomEndpoint(CustomEndpoint)

setCustomData

public GeoUniq.CustomEndpoint.Builder setCustomData(org.json.JSONObject data)

Sets a JSON object to be added to all location updates sent to the GeoUniq.CustomEndpoint.

Parameters:

data - the custom data to be added

Returns:

This Builder object to allow for chaining of calls to set methods

See Also:

GeoUniq.setCustomEndpoint(CustomEndpoint)

removeCustomData

public GeoUniq.CustomEndpoint.Builder removeCustomData()

Removes custom data for the GeoUniq.CustomEndpoint.

Returns:

This Builder object to allow for chaining of calls to set methods

See Also:

GeoUniq.setCustomEndpoint(CustomEndpoint)

build

public GeoUniq.CustomEndpoint build()
                             throws GeoUniq.CustomEndpoint.NoUrlDefinedException

Creates a GeoUniq.CustomEndpoint with the parameters supplied to this Builder.
Calling this method does not set the CustomEndpoint. GeoUniq.setCustomEndpoint(CustomEndpoint) (GeoFence)} must be called to set the created CustomEndpoint.

Returns:

The CustomEndpoint

Throws:

GeoUniq.CustomEndpoint.NoUrlDefinedException - if no URL has been set (@see setUrl(String))