ScannerFilter.Builder¶

public static class Builder¶

Builder class. Allows the creation of a valid ScannerFilter.

Follows the Builder pattern for an easy configuration:

ScannerFilter mScannerFilter = new ScannerFilter.Builder()
  .includeDeviceWhoseNameContains("mydevice")
  .excludeDeviceWithMac("d8:c2:8c:5a:d6:d3")
  .build();

Constructors¶

Builder¶

public Builder()¶: Builder constructor.

Methods¶

build¶

public ScannerFilter build()¶

Builds a new instance of a ScannerFilter using the configured parameters.

Returns: A valid ScannerFilter.

buildDefault¶

public ScannerFilter buildDefault()¶

Builds a new instance of a ScannerFilter using the default parameters.

Every list will be empty so every device will be allowed.

Returns: A valid ScannerFilter.

excludeDeviceWhoseNameContains¶

public ScannerFilter.Builder excludeDeviceWhoseNameContains(String str)¶

Adds a string to the name exclude list.

See ScannerFilter.filter(String,String) for more information.

Parameters

str – A string.

Returns

This Builder instance.

excludeDeviceWhoseNameContains¶

public ScannerFilter.Builder excludeDeviceWhoseNameContains(List<String> strs)¶

Adds a string to the name exclude list.

See ScannerFilter.filter(String,String) for more information.

Parameters

strs – A string.

Returns

This Builder instance.

excludeDeviceWithMac¶

public ScannerFilter.Builder excludeDeviceWithMac(String mac)¶

Adds a MAC address to the exclude list.

See ScannerFilter.filter(String,String) for more information.

Parameters

mac – The MAC address. Should follow the MAC_PATTERN.

Returns

This Builder instance.

excludeDeviceWithMacIn¶

public ScannerFilter.Builder excludeDeviceWithMacIn(List<String> macs)¶

Adds a list of MAC addresses to the exclude list.

See ScannerFilter.filter(String,String) for more information.

Parameters

macs – A MAC address list. Each address should follow the MAC_PATTERN.

Returns

This Builder instance.

includeDeviceWhoseNameContains¶

public ScannerFilter.Builder includeDeviceWhoseNameContains(String str)¶

Adds a string to the name include list.

See ScannerFilter.filter(String,String) for more information.

Parameters

str – A string.

Returns

This Builder instance.

includeDeviceWhoseNameContains¶

public ScannerFilter.Builder includeDeviceWhoseNameContains(List<String> strs)¶

Adds a string list to the name include list.

See ScannerFilter.filter(String,String) for more information.

Parameters

strs – A string list.

Returns

This Builder instance.

includeDeviceWithMac¶

public ScannerFilter.Builder includeDeviceWithMac(String mac)¶

Adds a MAC address to the include list.

See ScannerFilter.filter(String,String) for more information.

Parameters

mac – The MAC address. Should follow the MAC_PATTERN.

Returns

This Builder instance.

includeDeviceWithMacIn¶

public ScannerFilter.Builder includeDeviceWithMacIn(List<String> macs)¶

Adds a list of MAC addresses to the include list.

See ScannerFilter.filter(String,String) for more information.

Parameters

macs – A MAC address list. Each address should follow the MAC_PATTERN.

Returns

This Builder instance.