io.realm

Class RealmObject

java.lang.Object

io.realm.RealmObject

public abstract class RealmObject
extends java.lang.Object

In Realm you define your model 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 (no boxed types):

• boolean
• short
• int
• long
• float
• 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)

Field Summary

Fields

Modifier and Type	Field and Description
protected Realm	realm
protected Row	row

Constructor Summary

Constructors

Constructor and Description
RealmObject()

Method Summary

Modifier and Type	Method and Description
boolean	isValid() Check if the RealmObject is still valid to use ie.
void	removeFromRealm() Removes the object from the Realm it is currently associated to.

Methods inherited from class java.lang.Object

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

Field Detail

row

protected Row row

realm

protected Realm realm

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

isValid

public boolean isValid()

Check if the RealmObject is still valid to use ie. 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.