io.realm

Class Realm

java.lang.Object

io.realm.Realm

public class Realm
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_REALM_NAME

Method Summary

Methods

Modifier and Type	Method and Description
void	addChangeListener(RealmChangeListener listener) Add a change listener to the Realm
<E extends RealmObject> RealmResults<E>	allObjects(java.lang.Class<E> clazz) Get all objects of a specific Class
void	beginTransaction() Starts a write transaction, this must be closed with commitTransaction()
void	clear(java.lang.Class<?> classSpec) Remove all objects of the specified class
void	commitTransaction() Commits a write transaction
static Realm	create(java.io.File writableFolder, java.lang.String filename, byte[] key) Realm static constructor
<E extends RealmObject> E	createObject(java.lang.Class<E> clazz) Instantiates and adds a new object to the realm
static boolean	deleteRealmFile(android.content.Context context) Delete the Realm file from the filesystem for the default Realm (named "default.realm").
static boolean	deleteRealmFile(android.content.Context context, java.lang.String fileName) Delete the Realm file from the filesystem for a custom named Realm.
protected void	finalize()
static Realm	getInstance(android.content.Context context) Realm static constructor for the default realm "default.realm"
static Realm	getInstance(android.content.Context context, byte[] key) Realm static constructor
static Realm	getInstance(android.content.Context context, java.lang.String fileName) Realm static constructor
static Realm	getInstance(android.content.Context context, java.lang.String fileName, byte[] key) Realm static constructor
static Realm	getInstance(java.io.File writableFolder, byte[] key) Realm static constructor
Table	getTable(java.lang.Class<?> clazz)
static void	migrateRealmAtPath(java.lang.String realmPath, byte[] key, RealmMigration migration)
static void	migrateRealmAtPath(java.lang.String realmPath, RealmMigration migration)
void	removeAllChangeListeners() Remove all user-defined change listeners
void	removeChangeListener(RealmChangeListener listener) Remove the specified change listener
<E extends RealmObject> RealmQuery<E>	where(java.lang.Class<E> clazz) Returns a typed RealmQuery, which can be used to query for specific objects of this type

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_REALM_NAME

public static final java.lang.String DEFAULT_REALM_NAME

See Also:

Constant Field Values

Method Detail

finalize

protected void finalize()
                 throws java.lang.Throwable

Overrides:

finalize in class java.lang.Object

Throws:

java.lang.Throwable

getTable

public Table getTable(java.lang.Class<?> clazz)

getInstance

public static Realm getInstance(android.content.Context context)

Realm static constructor for the default realm "default.realm"

Parameters:

context - an Android context

Returns:

an instance of the Realm class

getInstance

public static Realm getInstance(android.content.Context context,
                java.lang.String fileName)

Realm static constructor

Parameters:

context - an Android context

fileName - the name of the file to save the Realm to

Returns:

an instance of the Realm class

getInstance

public static Realm getInstance(android.content.Context context,
                byte[] key)

Realm static constructor

Parameters:

context - an Android context

key - a 32-byte encryption key

Returns:

an instance of the Realm class

getInstance

public static Realm getInstance(android.content.Context context,
                java.lang.String fileName,
                byte[] key)

Realm static constructor

Parameters:

context - an Android context

fileName - the name of the file to save the Realm to

key - a 32-byte encryption key

Returns:

an instance of the Realm class

getInstance

public static Realm getInstance(java.io.File writableFolder,
                byte[] key)

Realm static constructor

Parameters:

writableFolder - absolute path to a writable directory

key - a 32-byte encryption key

Returns:

an instance of the Realm class

create

public static Realm create(java.io.File writableFolder,
           java.lang.String filename,
           byte[] key)

Realm static constructor

Parameters:

writableFolder - absolute path to a writable directory

filename - the name of the file to save the Realm to

key - a 32-byte encryption key

Returns:

an instance of the Realm class

createObject

public <E extends RealmObject> E createObject(java.lang.Class<E> clazz)

Instantiates and adds a new object to the realm

Parameters:

clazz - The Class of the object to create

Returns:

The new object

where

public <E extends RealmObject> RealmQuery<E> where(java.lang.Class<E> clazz)

Returns a typed RealmQuery, which can be used to query for specific objects of this type

Parameters:

clazz - The class of the object which is to be queried for

Returns:

A typed RealmQuery, which can be used to query for specific objects of this type

See Also:

RealmQuery

allObjects

public <E extends RealmObject> RealmResults<E> allObjects(java.lang.Class<E> clazz)

Get all objects of a specific Class

Parameters:

clazz - the Class to get objects of

Returns:

A RealmResult list containing the objects

See Also:

RealmResults

addChangeListener

public void addChangeListener(RealmChangeListener listener)

Add a change listener to the Realm

Parameters:

listener - the change listener

See Also:

RealmChangeListener

removeChangeListener

public void removeChangeListener(RealmChangeListener listener)

Remove the specified change listener

Parameters:

listener - the change listener to be removed

See Also:

RealmChangeListener

removeAllChangeListeners

public void removeAllChangeListeners()

Remove all user-defined change listeners

See Also:

RealmChangeListener

beginTransaction

public void beginTransaction()

Starts a write transaction, this must be closed with commitTransaction()

commitTransaction

public void commitTransaction()

Commits a write transaction

clear

public void clear(java.lang.Class<?> classSpec)

Remove all objects of the specified class

Parameters:

classSpec - The class which objects should be removed

migrateRealmAtPath

public static void migrateRealmAtPath(java.lang.String realmPath,
                      RealmMigration migration)

migrateRealmAtPath

public static void migrateRealmAtPath(java.lang.String realmPath,
                      byte[] key,
                      RealmMigration migration)

deleteRealmFile

public static boolean deleteRealmFile(android.content.Context context)

Delete the Realm file from the filesystem for the default Realm (named "default.realm"). The realm must be unused and closed before calling this method. WARNING: Your Realm must not be open (typically when your app launch).

Parameters:

context - an Android context.

Returns:

false if a file could not be deleted. The failing file will be logged.

See Also:

clear(Class)

deleteRealmFile

public static boolean deleteRealmFile(android.content.Context context,
                      java.lang.String fileName)

Delete the Realm file from the filesystem for a custom named Realm. The realm must be unused and closed before calling this method.

Parameters:

context - an Android context.

fileName - the name of the custom Realm (i.e. "myCustomRealm.realm").

Returns:

false if a file could not be deleted. The failing file will be logged.