Save the date! Android Dev Summit is coming to Mountain View, CA on November 7-8, 2018.

LowpanIdentity

public class LowpanIdentity
extends Object

java.lang.Object
   ↳ com.google.android.things.lowpan.LowpanIdentity


Describes an instance of a LoWPAN network.

Summary

Nested classes

class LowpanIdentity.Builder

Builder class for constructing instances of LowpanIdentity. 

Constants

int UNSPECIFIED_CHANNEL

Value returned from getChannel() when no channel was specified.

int UNSPECIFIED_PANID

Value returned from getPanid() when no PANID was specified.

Public methods

boolean equals(Object rhs)

Indicates whether some other object is "equal to" this one.

int getChannel()

Returns the channel index for this LowpanIdentity.

String getName()

Returns the name of the network.

int getPanid()

Returns the PANID for this LowpanIdentity.

byte[] getRawName()

Returns the raw bytes for the network name.

byte[] getXpanid()

Returns the XPANID for this LowpanIdentity.

int hashCode()

Returns a hash code value for the object.

boolean isNameValid()

Indicates if the raw network name is a valid and normalized UTF8 encoding.

String toString()

Returns a string representation of the object.

Inherited methods

From class java.lang.Object

Constants

UNSPECIFIED_CHANNEL

int UNSPECIFIED_CHANNEL

Value returned from getChannel() when no channel was specified.

Constant Value: -1 (0xffffffff)

UNSPECIFIED_PANID

int UNSPECIFIED_PANID

Value returned from getPanid() when no PANID was specified.

Constant Value: -1 (0xffffffff)

Public methods

equals

boolean equals (Object rhs)

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any non-null reference values x and y, this method returns true if and only if x and y refer to the same object (x == y has the value true).

Note that it is generally necessary to override the hashCode method whenever this method is overridden, so as to maintain the general contract for the hashCode method, which states that equal objects must have equal hash codes.

Parameters
rhs Object: the reference object with which to compare.

Returns
boolean true if this object is the same as the obj argument; false otherwise.

getChannel

int getChannel ()

Returns the channel index for this LowpanIdentity.

If not set, will return UNSPECIFIED_CHANNEL.

Returns
int

getName

String getName ()

Returns the name of the network.

Note that if the name of this network is not considered normal or ambiguous, the returned string will be escaped into a non-ambigous form. To get the actual byte values for the network name, use getRawName().

Returns
String

getPanid

int getPanid ()

Returns the PANID for this LowpanIdentity.

If not set, will return UNSPECIFIED_PANID.

Returns
int

See also:

getRawName

byte[] getRawName ()

Returns the raw bytes for the network name.

These bytes may differ from the UTF8 encoding of the result from getName() if the network name is not considered normal or ambiguous.

Returns
byte[]

getXpanid

byte[] getXpanid ()

Returns the XPANID for this LowpanIdentity.

If not set, will return an empty array.

Returns
byte[]

hashCode

int hashCode ()

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals(Object) method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals(java.lang.Object) method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

As much as is reasonably practical, the hashCode method defined by class Object does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the Java™ programming language.)

Returns
int a hash code value for this object.

isNameValid

boolean isNameValid ()

Indicates if the raw network name is a valid and normalized UTF8 encoding.

Returns
boolean true if the network name is valid and normalized UTF8. false otherwise.

toString

String toString ()

Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.

The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:

 getClass().getName() + '@' + Integer.toHexString(hashCode())
 

Returns
String a string representation of the object.