AltBeacon.java

/**
 * Radius Networks, Inc.
 * http://www.radiusnetworks.com
 *
 * @author David G. Young
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
package org.altbeacon.beacon;

import android.os.Parcel;
import android.os.Parcelable;
import android.util.Log;

import java.util.ArrayList;

/**
 * <p>The <code>AltBeacon</code> class represents a single hardware AltBeacon detected by
 * an Android device.  It is more specific than the <code>Beacon</code> class in that it provides
 * access to the #mfgReserved field.</p>
 *
 * <p>An <code>AltBeacon</code> is identified by a unique three part identifier.  The first
 * identifier Id1 is normally used across an organization, the second identifier Id2 is used to
 * group beacons and the third identifier Id3 is used to uniquely identify a specific beacon (in
 * combination with the other two identifiers.)
 *
 * @author  David G. Young
 */
public class AltBeacon extends Beacon {
    private static final String TAG = "AltBeacon";

    /**
     * Required for making object Parcelable.  If you override this class, you must provide an
     * equivalent version of this method.
     */
    public static final Parcelable.Creator<AltBeacon> CREATOR
            = new Parcelable.Creator<AltBeacon>() {
        public AltBeacon createFromParcel(Parcel in) {
            return new AltBeacon(in);
        }

        public AltBeacon[] newArray(int size) {
            return new AltBeacon[size];
        }
    };

    /**
     * Copy constructor from base class
     * @param beacon
     */
    protected AltBeacon(Beacon beacon) {
        super();
        this.mBluetoothAddress = beacon.mBluetoothAddress;
        this.mIdentifiers = beacon.mIdentifiers;
        this.mBeaconTypeCode = beacon.mBeaconTypeCode;
        this.mDataFields = beacon.mDataFields;
        this.mDistance = beacon.mDistance;
        this.mRssi = beacon.mRssi;
        this.mTxPower = beacon.mTxPower;
    }

    /**
     * @see AltBeacon.Builder to make AltBeacon instances
     */
    protected AltBeacon() {
    }

    /**
     * Required for making object Parcelable
     **/
    protected AltBeacon(Parcel in) {
        super(in);
    }

    /**
     * Returns a field with a value from 0-255 that can be used for the purposes specified by the
     * manufacturer.  The manufacturer specifications for the beacon should be checked before using
     * this field, and the manufacturer should be checked against the Beacon#mManufacturer
     * field
     * @return mfgReserved
     */
    public int getMfgReserved() {
        return mDataFields.get(0).intValue();
    }

    /**
     * Required for making object Parcelable
     * @return
     */
    @Override
    public int describeContents() {
        return 0;
    }

    /**
     * Required for making object Parcelable
     **/
     @Override
    public void writeToParcel(Parcel out, int flags) {
        super.writeToParcel(out, flags);
    }


    /**
     * Builder class for AltBeacon objects. Provides a convenient way to set the various fields of a
     * Beacon
     *
     * <p>Example:
     *
     * <pre>
     * Beacon beacon = new Beacon.Builder()
     *         .setId1("2F234454-CF6D-4A0F-ADF2-F4911BA9FFA6")
     *         .setId2("1")
     *         .setId3("2")
     *         .setMfgReserved(3);
     *         .build();
     * </pre>
     */
    public static class Builder extends Beacon.Builder {
        @Override
        public Beacon build() {
            return new AltBeacon(super.build());
        }
        public Builder setMfgReserved(int mfgReserved) {
            if (mBeacon.mDataFields.size() != 0) {
                mBeacon.mDataFields = new ArrayList<Long>();
            }
            mBeacon.mDataFields.add((long)mfgReserved);
            return this;
        }
    }

}