io.realm

Class RealmObject

java.lang.Object

io.realm.RealmObject

Direct Known Subclasses:

DynamicRealmObject

public abstract class RealmObject
extends java.lang.Object

In Realm you define your RealmObject classes by sub-classing RealmObject and adding fields to be persisted. You then create your objects within a Realm, and use your custom subclasses instead of using the RealmObject class directly.

An annotation processor will create a proxy class for your RealmObject subclass. The getters and setters should not contain any custom code of logic as they are overridden as part of the annotation process.

A RealmObject is currently limited to the following:

• Private fields.
• Getter and setters for these fields.
• Static methods.

The following field data types are supported:

• boolean/Boolean
• short/Short
• int/Integer
• long/Long
• float/Float
• double/Double
• byte[]
• String
• Date
• Any RealmObject subclass
• RealmList

The types short, int, and long are mapped to long when storing within a Realm.

Getter and setter names must have the name getXXX or setXXX if the field name is XXX. Getters for fields of type boolean can be called isXXX as well. Fields with a m-prefix must have getters and setters named setmXXX and getmXXX which is the default behavior when Android Studio automatically generates the getters and setters.

Fields annotated with Ignore don't have these restrictions and don't require either a getter or setter.

Realm will create indexes for fields annotated with Index. This will speedup queries but will have a negative impact on inserts and updates.

A RealmObject cannot be passed between different threads.

See Also:

Realm.createObject(Class), Realm.copyToRealm(RealmObject)

Constructor Summary

Constructors

Constructor and Description
RealmObject()

Method Summary

Modifier and Type	Method and Description
void	addChangeListener(RealmChangeListener listener) Adds a change listener to this RealmObject.
<E extends RealmObject> <any>	asObservable() Returns an Rx Observable that monitors changes to this RealmObject.
boolean	isLoaded() Determines if the current RealmObject is obtained synchronously or asynchronously (from a worker thread).
boolean	isValid() Checks if the RealmObject is still valid to use i.e.
boolean	load() Makes an asynchronous query blocking.
void	removeChangeListener(RealmChangeListener listener) Removes a previously registered listener.
void	removeChangeListeners() Removes all registered listeners.
void	removeFromRealm() Removes the object from the Realm it is currently associated to.

Methods inherited from class java.lang.Object

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

Constructor Detail

RealmObject

public RealmObject()

Method Detail

removeFromRealm

public void removeFromRealm()

Removes the object from the Realm it is currently associated to.

After this method is called the object will be invalid and any operation (read or write) performed on it will fail with an IllegalStateException

Throws:

java.lang.IllegalStateException - if the corresponding Realm is closed or in an incorrect thread.

isValid

public final boolean isValid()

Checks if the RealmObject is still valid to use i.e. the RealmObject hasn't been deleted nor has the Realm been closed. It will always return false for stand alone objects.

Returns:

true if the object is still accessible, false otherwise or if it is a standalone object.

isLoaded

public final boolean isLoaded()

Determines if the current RealmObject is obtained synchronously or asynchronously (from a worker thread). Synchronous RealmObjects are by definition blocking hence this method will always return true for them. This will return true if called for a standalone object (created outside of Realm).

Returns:

true if the query has completed and the data is available false if the query is in progress.

load

public final boolean load()

Makes an asynchronous query blocking. This will also trigger any registered listeners. Note: This will return true if called for a standalone object (created outside of Realm).

Returns:

true if it successfully completed the query, false otherwise.

addChangeListener

public final void addChangeListener(RealmChangeListener listener)

Adds a change listener to this RealmObject.

Parameters:

listener - the change listener to be notified.

removeChangeListener

public final void removeChangeListener(RealmChangeListener listener)

Removes a previously registered listener.

Parameters:

listener - the instance to be removed.

removeChangeListeners

public final void removeChangeListeners()

Removes all registered listeners.

asObservable

public <E extends RealmObject> <any> asObservable()

Returns an Rx Observable that monitors changes to this RealmObject. It will emit the current object when subscribed to. If chaining a RealmObject observable use obj.<MyRealmObjectClass>asObservable() to pass on type information, otherwise the type of the following observables will be RealmObject.

Type Parameters:

E - RealmObject class that is being observed. Must be this class or its super types.

Returns:

RxJava Observable.

Throws:

java.lang.UnsupportedOperationException - if the required RxJava framework is not on the classpath.

See Also:

RxJava and Realm