com.polidea.rxandroidble2

Class LogOptions.Builder

java.lang.Object

com.polidea.rxandroidble2.LogOptions.Builder

Enclosing class:

LogOptions

public static class LogOptions.Builder
extends java.lang.Object

The builder for #LogOptions(Integer, Integer, Integer, Boolean, Boolean, Logger) If a particular setting will not be defined on the builder the produced #LogOptions(Integer, Integer, Integer, Boolean, Boolean, Logger) will not overwrite them in the library when passed to RxBleClient.updateLogOptions(LogOptions).

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
LogOptions	build()
LogOptions.Builder	setLogger(LogOptions.Logger logger) Set the logger to get the output
LogOptions.Builder	setLogLevel(java.lang.Integer logLevel) Set the log level of the library.
LogOptions.Builder	setMacAddressLogSetting(java.lang.Integer macAddressLogSetting) Set how to log mac addresses:
LogOptions.Builder	setShouldLogAttributeValues(java.lang.Boolean shouldLogAttributeValues) Set how to log byte array values:
LogOptions.Builder	setShouldLogScannedPeripherals(java.lang.Boolean shouldLogScannedPeripherals) Set if scan results should be logged.
LogOptions.Builder	setUuidsLogSetting(java.lang.Integer uuidsLogSetting) Set how to log uuids:

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

setLogLevel

public LogOptions.Builder setLogLevel(java.lang.Integer logLevel)

Set the log level of the library. General rule:

LogConstants.NONE — nothing will get logged

LogConstants.ERROR — only terminal library errors

LogConstants.WARN — the above plus all events that may be handled gracefully or wrong usage of the API

LogConstants.INFO — the above plus all info needed to understand the BLE interactions and debug user's application

LogConstants.DEBUG — the above plus information needed to debug the library

LogConstants.VERBOSE — the above plus some information about the internal working

Parameters:

logLevel - the log level

Returns:

the builder

setMacAddressLogSetting

public LogOptions.Builder setMacAddressLogSetting(java.lang.Integer macAddressLogSetting)

Set how to log mac addresses:

LogConstants.NONE — address will be omitted i.e. 'XX:XX:XX:XX:XX:XX'

LogConstants.MAC_ADDRESS_TRUNCATED — i.e. '00:11:22:33:44:XX'

LogConstants.MAC_ADDRESS_FULL — i.e. '00:11:22:33:44:55'

Parameters:

macAddressLogSetting - the setting

Returns:

the builder

setUuidsLogSetting

public LogOptions.Builder setUuidsLogSetting(java.lang.Integer uuidsLogSetting)

Set how to log uuids:

LogConstants.NONE — UUID will be omitted i.e. '...'

LogConstants.UUIDS_FULL — the full UUID will be logged

Parameters:

uuidsLogSetting - the setting

Returns:

the builder

setShouldLogAttributeValues

public LogOptions.Builder setShouldLogAttributeValues(java.lang.Boolean shouldLogAttributeValues)

Set how to log byte array values:

false — all byte arrays will be omitted i.e. '[...]'

true — all byte arrays will be printed in hex i.e. '[FF, FF, FF, FF]'

Parameters:

shouldLogAttributeValues - the setting

Returns:

the builder

setShouldLogScannedPeripherals

public LogOptions.Builder setShouldLogScannedPeripherals(java.lang.Boolean shouldLogScannedPeripherals)

Set if scan results should be logged.

Parameters:

shouldLogScannedPeripherals - the setting

Returns:

the builder

setLogger

public LogOptions.Builder setLogger(LogOptions.Logger logger)

Set the logger to get the output

Parameters:

logger - the logger

Returns:

the builder

build

public LogOptions build()