com.digi.xbee.api.models

Class AccessPoint

java.lang.Object

com.digi.xbee.api.models.AccessPoint

public class AccessPoint
extends Object

This class represents an Access Point for the Wi-Fi protocol. It contains SSID, the encryption type and the link quality between the Wi-Fi module and the access point.

This class is used within the XBee Java Library to list the access points and connect to a specific one in the Wi-Fi protocol.

Since:

1.2.0

Constructor Summary

Constructors

Constructor and Description
AccessPoint(String ssid, WiFiEncryptionType encryptionType) Class constructor.
AccessPoint(String ssid, WiFiEncryptionType encryptionType, int channel, int signalQuality) Class constructor.

Method Summary

Modifier and Type	Method and Description
int	getChannel() Returns the operating channel of the access point.
WiFiEncryptionType	getEncryptionType() Returns the encryption type of the access point.
int	getSignalQuality() Returns the signal quality with the access point in %.
String	getSSID() Returns the SSID of the access point.
void	setChannel(int channel) Sets the new channel of the access point.
void	setSignalQuality(int signalQuality) Sets the new signal quality with the access point.
String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

AccessPoint

public AccessPoint(String ssid,
                   WiFiEncryptionType encryptionType)

Class constructor. Instantiates a new object of type AccessPoint with the given parameters.

Parameters:

ssid - The SSID of the access point.

encryptionType - The encryption type configured in the access point.

Throws:

IllegalArgumentException - if ssid.length < 0.

NullPointerException - if ssid == null or if encryptionType == null.

See Also:

AccessPoint(String, WiFiEncryptionType, int, int), WiFiEncryptionType

AccessPoint

public AccessPoint(String ssid,
                   WiFiEncryptionType encryptionType,
                   int channel,
                   int signalQuality)

Class constructor. Instantiates a new object of type AccessPoint with the given parameters.

Parameters:

ssid - The SSID of the access point.

encryptionType - The encryption type configured in the access point.

channel - Operating channel of the access point.

signalQuality - Signal quality with the access point in %.

Throws:

IllegalArgumentException - if ssid.length < 0 or if channel < 0 or if signalQuality < 0 or if signalQuality > 100.

NullPointerException - if ssid == null or if encryptionType == null.

See Also:

AccessPoint(String, WiFiEncryptionType), WiFiEncryptionType

Method Detail

getChannel

public int getChannel()

Returns the operating channel of the access point.

Returns:

The operating channel of the access point.

See Also:

setChannel(int)

getEncryptionType

public WiFiEncryptionType getEncryptionType()

Returns the encryption type of the access point.

Returns:

The encryption type of the access point.

See Also:

WiFiEncryptionType

getSignalQuality

public int getSignalQuality()

Returns the signal quality with the access point in %.

Returns:

The signal quality with the access point in %.

See Also:

setSignalQuality(int)

getSSID

public String getSSID()

Returns the SSID of the access point.

Returns:

The SSID of the access point.

setChannel

public void setChannel(int channel)

Sets the new channel of the access point.

Parameters:

channel - The new channel of the access point.

See Also:

getChannel()

setSignalQuality

public void setSignalQuality(int signalQuality)

Sets the new signal quality with the access point.

Parameters:

signalQuality - The new signal quality with the access point.

See Also:

getSignalQuality()

toString

public String toString()

Overrides:

toString in class Object