com.estimote.coresdk.observation.region

Class RegionDecorator

java.lang.Object

com.estimote.coresdk.observation.region.RegionDecorator

Direct Known Subclasses:

BeaconRegionDecorator, MirrorRegionDecorator

public abstract class RegionDecorator
extends java.lang.Object

Author:

Pawel Dylag (pawel.dylag@estimote.com)

Constructor Summary

Constructors

Constructor and Description
RegionDecorator()

Method Summary

Modifier and Type	Method and Description
boolean	didJustExit(long currentTimeMillis, long expiration) Checks if device had just exited the region.
abstract java.lang.String	getRegionIdentifier() Returns unique identifier of werapped Region objects;
boolean	isInside(long currentTimeMillis, long expiration)
boolean	markAsSeen(long currentTimeMillis) Marks current region as seen and checks if user entered this region.

Methods inherited from class java.lang.Object

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

Constructor Detail

RegionDecorator

public RegionDecorator()

Method Detail

markAsSeen

public boolean markAsSeen(long currentTimeMillis)

Marks current region as seen and checks if user entered this region.

Parameters:

currentTimeMillis - Current time in millis when region was seen.

Returns:

True if device had just entered into region.

isInside

public boolean isInside(long currentTimeMillis,
                        long expiration)

Parameters:

currentTimeMillis - Current time in millis.

expiration -

Returns:

True if device is inside the region.

didJustExit

public boolean didJustExit(long currentTimeMillis,
                           long expiration)

Checks if device had just exited the region. Device was seen in the region sometime ago and haven't been marked as seen since than.

Parameters:

currentTimeMillis - Current time in millis.

expiration -

Returns:

True if device had just exited the region.

getRegionIdentifier

public abstract java.lang.String getRegionIdentifier()

Returns unique identifier of werapped Region objects;

Returns:

inique region id