Package org.robolectric.shadows

Class WifiScanResultBuilder

java.lang.Object

org.robolectric.shadows.WifiScanResultBuilder

public final class WifiScanResultBuilder
extends Object

Builder class for ScanResult allowing for more accurate construction of Wi-Fi scan results in test code.

Constructor Summary

Constructors

Constructor	Description
WifiScanResultBuilder()

Method Summary

Modifier and Type	Method	Description
ScanResult	build()	Returns a new ScanResult instance as configured in this builder.
WifiScanResultBuilder	setBssid(String bssid)	Sets the value of the ScanResult.BSSID field.
WifiScanResultBuilder	setCapabilities(String capabilities)	Sets the value of the ScanResult.capabilities field.
WifiScanResultBuilder	setCenterFreq0(int centerFreq0)	Sets the center frequency, in MHz, of the first segment (see ScanResult.centerFreq0).
WifiScanResultBuilder	setCenterFreq1(int centerFreq1)	Sets the center frequency, in MHz, of the second segment (see ScanResult.centerFreq1).
WifiScanResultBuilder	setChannelWidth(int channelWidth)	Sets the value returned by ScanResult.channelWidth.
WifiScanResultBuilder	setFrequency(int frequency)	Sets the value of the frequency, in MHz, returned by the ScanResult.frequency field.
WifiScanResultBuilder	setIs80211azNtbRttResponder(boolean is80211azNtbRttResponder)	Sets the return value of ScanResult.is80211azNtbResponder().
WifiScanResultBuilder	setIs80211McRttResponder(boolean is80211McRttResponder)	Sets the return value of ScanResult.is80211mcResponder().
WifiScanResultBuilder	setIsTwtResponder(boolean isTwtResponder)	Sets the return value of ScanResult.isTwtResponder().
WifiScanResultBuilder	setRssi(int rssi)	Sets the value of the ScanResult.level field (aka RSSI).
WifiScanResultBuilder	setSsid(String ssid)	Sets the value of the ScanResult.SSID field.
WifiScanResultBuilder	setTimeSinceSeen(Duration timeSinceSeen)	Sets the duration since boot since the result was seen.
WifiScanResultBuilder	setWifiSsid(WifiSsid wifiSsid)	Sets the value returned by ScanResult.getWifiSsid(), additionally setting the deprecated ScanResult.SSID field.

Methods inherited from class java.lang.Object

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

Constructor Details

WifiScanResultBuilder

public WifiScanResultBuilder()

Method Details

setCapabilities

@CanIgnoreReturnValue
public WifiScanResultBuilder setCapabilities(@Nullable
 String capabilities)

Sets the value of the ScanResult.capabilities field.

Returns:

this builder, for chaining

setBssid

@CanIgnoreReturnValue
public WifiScanResultBuilder setBssid(@Nullable
 String bssid)

Sets the value of the ScanResult.BSSID field.

Returns:

this builder, for chaining

setRssi

@CanIgnoreReturnValue
public WifiScanResultBuilder setRssi(int rssi)

Sets the value of the ScanResult.level field (aka RSSI).

Returns:

this builder, for chaining

setFrequency

@CanIgnoreReturnValue
public WifiScanResultBuilder setFrequency(int frequency)

Sets the value of the frequency, in MHz, returned by the ScanResult.frequency field.

Returns:

this builder, for chaining

setSsid

@CanIgnoreReturnValue
public WifiScanResultBuilder setSsid(@Nullable
 String ssid)

Sets the value of the ScanResult.SSID field. On API 33 and above, this also sets the return value of ScanResult.getWifiSsid().

Parameters:

ssid - the name of the network, or null; this should be either a UTF-8 encoded string, surrounded by quotes (e.g. '"Network name"'), or an unquoted hex-encoded string (e.g. '0a8b2c1f').

Returns:

this builder, for chaining

setTimeSinceSeen

@CanIgnoreReturnValue
public WifiScanResultBuilder setTimeSinceSeen(Duration timeSinceSeen)

Sets the duration since boot since the result was seen.

Returns:

this builder, for chaining

See Also:

• ScanResult.timestamp

setWifiSsid

@RequiresApi(33)
@CanIgnoreReturnValue
public WifiScanResultBuilder setWifiSsid(@Nullable
 WifiSsid wifiSsid)

Sets the value returned by ScanResult.getWifiSsid(), additionally setting the deprecated ScanResult.SSID field.

Returns:

this builder, for chaining

setChannelWidth

@RequiresApi(23)
@CanIgnoreReturnValue
public WifiScanResultBuilder setChannelWidth(int channelWidth)

Sets the value returned by ScanResult.channelWidth. This should be one of the constants in ScanResult such as ScanResult.CHANNEL_WIDTH_20MHZ.

Returns:

this builder, for chaining

setCenterFreq0

@RequiresApi(23)
@CanIgnoreReturnValue
public WifiScanResultBuilder setCenterFreq0(int centerFreq0)

Sets the center frequency, in MHz, of the first segment (see ScanResult.centerFreq0).

Returns:

this builder, for chaining

setCenterFreq1

@CanIgnoreReturnValue
@RequiresApi(23)
public WifiScanResultBuilder setCenterFreq1(int centerFreq1)

Sets the center frequency, in MHz, of the second segment (see ScanResult.centerFreq1).

Returns:

this builder, for chaining

setIs80211McRttResponder

@CanIgnoreReturnValue
@RequiresApi(23)
public WifiScanResultBuilder setIs80211McRttResponder(boolean is80211McRttResponder)

Sets the return value of ScanResult.is80211mcResponder().

Returns:

this builder, for chaining

setIs80211azNtbRttResponder

@CanIgnoreReturnValue
@RequiresApi(35)
public WifiScanResultBuilder setIs80211azNtbRttResponder(boolean is80211azNtbRttResponder)

Sets the return value of ScanResult.is80211azNtbResponder().

Returns:

this builder, for chaining

setIsTwtResponder

@CanIgnoreReturnValue
@RequiresApi(35)
public WifiScanResultBuilder setIsTwtResponder(boolean isTwtResponder)

Sets the return value of ScanResult.isTwtResponder().

Returns:

this builder, for chaining

build

public ScanResult build()

Returns a new ScanResult instance as configured in this builder.