com.estimote.coresdk.observation.region.beacon

Class BeaconRegion

java.lang.Object

com.estimote.coresdk.observation.region.beacon.BeaconRegion

All Implemented Interfaces:

android.os.Parcelable, Region

Direct Known Subclasses:

SecureBeaconRegion

public class BeaconRegion
extends java.lang.Object
implements Region, android.os.Parcelable

Defines a region based on device's location to a beacon. BeaconRegion is defined by location UUID, major and minor numbers of targeting beacons. All of those can be nulls which means wildcard on that field.

BeaconRegion's identifier is introduced similarly to CLBeaconRegion's identifier to uniquely identify region. You can use this identifier in the app to differentiate beaconRegions.

Author:

wiktor@estimote.com (Wiktor Gworek)

Nested Class Summary

Nested classes/interfaces inherited from interface android.os.Parcelable

android.os.Parcelable.ClassLoaderCreator<T>, android.os.Parcelable.Creator<T>

Field Summary

Fields

Modifier and Type	Field and Description
static android.os.Parcelable.Creator<BeaconRegion>	CREATOR

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Constructor Summary

Constructors

Constructor and Description
BeaconRegion(java.lang.String identifier, java.util.UUID proximityUUID, java.lang.Integer major, java.lang.Integer minor)

Method Summary

Modifier and Type	Method and Description
int	describeContents()
boolean	equals(java.lang.Object o)
java.lang.String	getIdentifier()
java.lang.Integer	getMajor()
java.lang.Integer	getMinor()
java.util.UUID	getProximityUUID()
int	hashCode()
java.lang.String	toString()
void	writeToParcel(android.os.Parcel dest, int flags)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

CREATOR

public static final android.os.Parcelable.Creator<BeaconRegion> CREATOR

Constructor Detail

BeaconRegion

public BeaconRegion(java.lang.String identifier,
                    java.util.UUID proximityUUID,
                    java.lang.Integer major,
                    java.lang.Integer minor)

Parameters:

identifier - A unique identifier for a region. Cannot be null.

proximityUUID - Location UUID of beacons. Can be null. Null indicates all location UUIDs.

major - Major version of the beacons. Can be null. Null indicates all major versions.

minor - Minor version of the beacons. Can be null. Null indicates all minor versions.

Method Detail

getIdentifier

public java.lang.String getIdentifier()

Specified by:

getIdentifier in interface Region

Returns:

BeaconRegion's unique identifier. Cannot be null.

getProximityUUID

public java.util.UUID getProximityUUID()

Returns:

Location UUID of targeting beacons.

getMajor

public java.lang.Integer getMajor()

Returns:

Major version of targeting beacons.

getMinor

public java.lang.Integer getMinor()

Returns:

Minor version of targeting beacons.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

describeContents

public int describeContents()

Specified by:

describeContents in interface android.os.Parcelable

writeToParcel

public void writeToParcel(android.os.Parcel dest,
                          int flags)

Specified by:

writeToParcel in interface android.os.Parcelable