Package com.geouniq.android

Class GeoUniq.GeoFence.Builder

java.lang.Object

com.geouniq.android.GeoUniq.GeoFence.Builder

Enclosing class:

GeoUniq.GeoFence

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

Builder class to obtain GeoUniq.GeoFence objects

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
GeoUniq.GeoFence	create()	Creates a GeoUniq.GeoFence with the parameters supplied to this Builder. Calling this method does not set the GeoFence to be monitored.
GeoUniq.GeoFence.Builder	setArea(GeoUniq.CircularArea area)	Sets the area to be monitored
GeoUniq.GeoFence.Builder	setCallbackClass(java.lang.Class<? extends GeoUniq.GeoFenceListener> callbackClass)	Sets the callback class that will receive updates when the status of the GeoFence changes
GeoUniq.GeoFence.Builder	setExpirationDate(java.util.Date expirationDate)	Sets the expiration date for the GeoFence. The GeoFence will no longer be monitored and will be automatically deleted after this date. If not set, the GeoFence never expires.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

setArea

public GeoUniq.GeoFence.Builder setArea(GeoUniq.CircularArea area)

Sets the area to be monitored

Parameters:

area - The GeoUniq.CircularArea to be monitored

Returns:

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

setCallbackClass

public GeoUniq.GeoFence.Builder setCallbackClass(java.lang.Class<? extends GeoUniq.GeoFenceListener> callbackClass)

Sets the callback class that will receive updates when the status of the GeoFence changes

Parameters:

callbackClass - A class implementing GeoUniq.GeoFenceListener interface

Returns:

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

See Also:

GeoUniq.GeoFenceListener, GeoUniq.setGeoFence(GeoFence)

setExpirationDate

public GeoUniq.GeoFence.Builder setExpirationDate(java.util.Date expirationDate)

Sets the expiration date for the GeoFence.
The GeoFence will no longer be monitored and will be automatically deleted after this date.
If not set, the GeoFence never expires.

Parameters:

expirationDate - A Date corresponding to the desired expiration date

Returns:

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

create

public GeoUniq.GeoFence create()

Creates a GeoUniq.GeoFence with the parameters supplied to this Builder.
Calling this method does not set the GeoFence to be monitored. GeoUniq.setGeoFence(GeoFence) must be called to start monitoring the returned GeoFence.

Returns:

A new geofence