public final Class Realm

Implements java.lang.Comparable.compareTo.

Compares to realms lexicographically based on their realmId.

Parameters

other:Realm

The Realm to be compared.

Returns:int

the value 0 if the realmId of the compared Realm is equal to the realmId of this Realm; a value less than 0 if the realmId of this Realm is lexicographically less than the realmId of the compared Realm; and a value greater than 0 if the realmId of this Realm is lexicographically greater than the realmId of the compared Realm.

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

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.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters

o:Object

the reference object with which to compare.

Returns:boolean

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

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.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 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 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.

Returns:int

a hash code value for this object

Register a new Realm. Used to allow the SDK to be forward compatible with unreleased realms.

Parameters

realmId:String

The realm id.

secondLevelDomain:String

The second level domain of the realm.

Returns:Realm

The registered Realm (or existing one if found).

Register a new Realm. Used to allow the SDK to be forward compatible with unreleased realms.

Parameters

realmId:String

The realm id.

secondLevelDomain:String

The second level domain of the realm.

isAlloyRealm:boolean

'true' if realm is from alloy configuration.

Returns:Realm

The registered Realm (or existing one if found).

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

Returns the Realm object matching the specified name. The name must match exactly. (Extraneous whitespace characters are not permitted.)

Parameters

name:String

The name of the realm

Returns:Realm

The Realm object matching the specified name, if available.

Exceptions

IllegalArgumentException:

if no realm exists with the specified name

All known Realms in this version of the SDK

Returns:Realm[]

Known realms