org.altbeacon.beacon

Class Beacon.Builder

java.lang.Object

org.altbeacon.beacon.Beacon.Builder

Direct Known Subclasses:

AltBeacon.Builder

Enclosing class:

Beacon

public static class Beacon.Builder
extends Object

Builder class for Beacon objects. Provides a convenient way to set the various fields of a Beacon

Example:

 Beacon beacon = new Beacon.Builder()
         .setId1("2F234454-CF6D-4A0F-ADF2-F4911BA9FFA6")
         .setId2("1")
         .setId3("2")
         .build();
 

Field Summary

Fields

Modifier and Type	Field and Description
protected Beacon	mBeacon

Constructor Summary

Constructors

Constructor and Description
Builder() Creates a builder instance

Method Summary

Modifier and Type	Method and Description
Beacon	build() Builds an instance of this beacon based on parameters set in the Builder
Beacon.Builder	copyBeaconFields(Beacon beacon)
Beacon.Builder	setBeaconTypeCode(int beaconTypeCode)
Beacon.Builder	setBluetoothAddress(String bluetoothAddress)
Beacon.Builder	setBluetoothName(String name)
Beacon.Builder	setDataFields(List<Long> dataFields)
Beacon.Builder	setExtraDataFields(List<Long> extraDataFields)
Beacon.Builder	setId1(String id1String) Convenience method allowing the first beacon identifier to be set as a String.
Beacon.Builder	setId2(String id2String) Convenience method allowing the second beacon identifier to be set as a String.
Beacon.Builder	setId3(String id3String) Convenience method allowing the third beacon identifier to be set as a String.
Beacon.Builder	setIdentifiers(List<Identifier> identifiers)
Beacon.Builder	setManufacturer(int manufacturer)
Beacon.Builder	setMultiFrameBeacon(boolean multiFrameBeacon)
Beacon.Builder	setParserIdentifier(String id)
Beacon.Builder	setRssi(int rssi)
Beacon.Builder	setRunningAverageRssi(double rssi)
Beacon.Builder	setServiceUuid(int serviceUuid)
Beacon.Builder	setTxPower(int txPower)

Methods inherited from class java.lang.Object

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

Field Detail

mBeacon

protected final Beacon mBeacon

Constructor Detail

Builder

public Builder()

Creates a builder instance

Method Detail

build

public Beacon build()

Builds an instance of this beacon based on parameters set in the Builder

Returns:

beacon

copyBeaconFields

public Beacon.Builder copyBeaconFields(Beacon beacon)

Parameters:

beacon - the beacon whose fields we should copy to this beacon builder

Returns:

setIdentifiers

public Beacon.Builder setIdentifiers(List<Identifier> identifiers)

Parameters:

identifiers - identifiers to set

Returns:

builder

See Also:

Beacon.mIdentifiers

setId1

public Beacon.Builder setId1(String id1String)

Convenience method allowing the first beacon identifier to be set as a String. It will be parsed into an Identifier object

Parameters:

id1String - string to parse into an identifier

Returns:

builder

setId2

public Beacon.Builder setId2(String id2String)

Convenience method allowing the second beacon identifier to be set as a String. It will be parsed into an Identifier object

Parameters:

id2String - string to parse into an identifier

Returns:

builder

setId3

public Beacon.Builder setId3(String id3String)

Convenience method allowing the third beacon identifier to be set as a String. It will be parsed into an Identifier object

Parameters:

id3String - string to parse into an identifier

Returns:

builder

setRssi

public Beacon.Builder setRssi(int rssi)

Parameters:

rssi -

Returns:

builder

See Also:

Beacon.mRssi

setRunningAverageRssi

public Beacon.Builder setRunningAverageRssi(double rssi)

Parameters:

rssi -

Returns:

builder

See Also:

Beacon.mRssi

setTxPower

public Beacon.Builder setTxPower(int txPower)

Parameters:

txPower -

Returns:

builder

See Also:

Beacon.mTxPower

setBeaconTypeCode

public Beacon.Builder setBeaconTypeCode(int beaconTypeCode)

Parameters:

beaconTypeCode -

Returns:

builder

See Also:

Beacon.mBeaconTypeCode

setServiceUuid

public Beacon.Builder setServiceUuid(int serviceUuid)

Parameters:

serviceUuid -

Returns:

builder

See Also:

Beacon.mServiceUuid

setBluetoothAddress

public Beacon.Builder setBluetoothAddress(String bluetoothAddress)

Parameters:

bluetoothAddress -

Returns:

builder

See Also:

Beacon.mBluetoothAddress

setDataFields

public Beacon.Builder setDataFields(List<Long> dataFields)

Parameters:

dataFields -

Returns:

builder

See Also:

Beacon.mDataFields

setExtraDataFields

public Beacon.Builder setExtraDataFields(List<Long> extraDataFields)

Parameters:

extraDataFields -

Returns:

builder

See Also:

Beacon.mDataFields

setManufacturer

public Beacon.Builder setManufacturer(int manufacturer)

Parameters:

manufacturer -

Returns:

builder

See Also:

Beacon.mManufacturer

setBluetoothName

public Beacon.Builder setBluetoothName(String name)

Parameters:

name -

Returns:

builder

See Also:

Beacon.mBluetoothName

setParserIdentifier

public Beacon.Builder setParserIdentifier(String id)

Parameters:

id -

Returns:

builder

See Also:

Beacon.mParserIdentifier

setMultiFrameBeacon

public Beacon.Builder setMultiFrameBeacon(boolean multiFrameBeacon)

Parameters:

multiFrameBeacon -

Returns:

builder

See Also:

Beacon.mMultiFrameBeacon