BaseRealm (Realm 0.89.0)

java.lang.Object
- io.realm.BaseRealm

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

Direct Known Subclasses:

DynamicRealm, Realm
```
public abstract class BaseRealm
extends java.lang.Object
implements java.io.Closeable
```
Base class for all Realm instances.

See Also:

Realm, DynamicRealm

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addChangeListener(RealmChangeListener listener)` Adds a change listener to the Realm.
`abstract Observable`	`asObservable()` Returns an RxJava Observable that monitors changes to this Realm.
`void`	`beginTransaction()` Starts a transaction, this must be closed with `commitTransaction()` or aborted by `cancelTransaction()`.
`void`	`cancelTransaction()` Reverts all writes (created, updated, or deleted objects) made in the current write transaction and end the transaction.
`void`	`close()` Closes the Realm instance and all its resources.
`void`	`commitTransaction()` All changes since `beginTransaction()` are persisted to disk and the Realm reverts back to being read-only.
`void`	`deleteAll()` Deletes all objects from this Realm.
`RealmConfiguration`	`getConfiguration()` Returns the `RealmConfiguration` for this Realm.
`java.lang.String`	`getPath()` Returns the canonical path to where this Realm is persisted on disk.
`RealmSchema`	`getSchema()` Returns the schema for this Realm.
`long`	`getVersion()` Returns the schema version for this Realm.
`boolean`	`isAutoRefresh()` Retrieves the auto-refresh status of the Realm instance.
`boolean`	`isClosed()` Checks if the `Realm` instance has already been closed.
`boolean`	`isEmpty()` Checks if this `Realm` contains any objects.
`boolean`	`isInTransaction()` Checks if the Realm is currently in a transaction.
`void`	`refresh()` Refreshes the Realm instance and all the RealmResults and RealmObjects instances coming from it.
`void`	`removeAllChangeListeners()` Removes all user-defined change listeners.
`void`	`removeChangeListener(RealmChangeListener listener)` Removes the specified change listener.
`void`	`setAutoRefresh(boolean autoRefresh)` Sets the auto-refresh status of the Realm instance.
`void`	`writeCopyTo(java.io.File destination)` Writes a compacted copy of the Realm to the given destination File.
`void`	`writeEncryptedCopyTo(java.io.File destination, byte[] key)` Writes a compacted and encrypted copy of the Realm to the given destination File.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - setAutoRefresh
```
public void setAutoRefresh(boolean autoRefresh)
```
    Sets the auto-refresh status of the Realm instance.
    Auto-refresh is a feature that enables automatic update of the current Realm instance and all its derived objects (RealmResults and RealmObjects instances) when a commit is performed on a Realm acting on the same file in another thread. This feature is only available if the Realm instance lives is a Looper enabled thread.
    
    Parameters:
    
    autoRefresh - true will turn auto-refresh on, false will turn it off.
    
    Throws:
    
    java.lang.IllegalStateException - if called from a non-Looper thread.
  - isAutoRefresh
```
public boolean isAutoRefresh()
```
    Retrieves the auto-refresh status of the Realm instance.
    
    Returns:
    
    the auto-refresh status.
  - isInTransaction
```
public boolean isInTransaction()
```
    Checks if the Realm is currently in a transaction.
    
    Returns:
    
    true if inside a transaction, false otherwise.
  - addChangeListener
```
public void addChangeListener(RealmChangeListener listener)
```
    Adds a change listener to the Realm.
    The listeners will be executed:
    - Immediately if a change was committed by the local thread
    - On every loop of a Handler thread if changes were committed by another thread
    - On every call to refresh()
    Listeners are stored as a strong reference, you need to remove the added listeners using removeChangeListener(RealmChangeListener) or removeAllChangeListeners() which removes all listeners including the ones added via anonymous classes.
    Parameters:
    
    listener - the change listener.
    
    Throws:
    
    java.lang.IllegalStateException - if you try to register a listener from a non-Looper Thread.
    
    See Also:
    
    RealmChangeListener, removeChangeListener(RealmChangeListener), removeAllChangeListeners()
  - removeChangeListener
```
public void removeChangeListener(RealmChangeListener listener)
```
    Removes the specified change listener.
    
    Parameters:
    
    listener - the change listener to be removed.
    
    Throws:
    
    java.lang.IllegalStateException - if you try to remove a listener from a non-Looper Thread.
    
    See Also:
    
    RealmChangeListener, addChangeListener(RealmChangeListener)
  - asObservable
```
public abstract Observable asObservable()
```
    Returns an RxJava Observable that monitors changes to this Realm. It will emit the current state when subscribed to. Items will continually be emitted as the Realm is updated - onComplete will never be called. If you would like the asObservable() to stop emitting items you can instruct RxJava to only emit only the first item by using the first() operator:
```
 
 realm.asObservable().first().subscribe( ... ) // You only get the results once
 
 
```
    Returns:
    
    RxJava Observable that only calls onNext. It will never call onComplete or OnError.
    
    Throws:
    
    java.lang.UnsupportedOperationException - if the required RxJava framework is not on the classpath.
    
    See Also:
    
    RxJava and Realm
  - removeAllChangeListeners
```
public void removeAllChangeListeners()
```
    Removes all user-defined change listeners.
    
    Throws:
    
    java.lang.IllegalStateException - if you try to remove listeners from a non-Looper Thread.
    
    See Also:
    
    RealmChangeListener, addChangeListener(RealmChangeListener)
  - writeCopyTo
```
public void writeCopyTo(java.io.File destination)
                 throws java.io.IOException
```
    Writes a compacted copy of the Realm to the given destination File.
    The destination file cannot already exist.
    Note that if this is called from within a transaction it writes the current data, and not the data as it was when the last transaction was committed.
    
    Parameters:
    
    destination - file to save the Realm to.
    
    Throws:
    
    java.io.IOException - if any write operation fails.
  - writeEncryptedCopyTo
```
public void writeEncryptedCopyTo(java.io.File destination,
                                 byte[] key)
                          throws java.io.IOException
```
    Writes a compacted and encrypted copy of the Realm to the given destination File.
    The destination file cannot already exist.
    Note that if this is called from within a transaction it writes the current data, and not the data as it was when the last transaction was committed.
    
    Parameters:
    
    destination - file to save the Realm to.
    
    key - a 64-byte encryption key.
    
    Throws:
    
    java.io.IOException - if any write operation fails.
    
    java.lang.IllegalArgumentException - if destination argument is null.
  - refresh
```
public void refresh()
```
    Refreshes the Realm instance and all the RealmResults and RealmObjects instances coming from it. It also calls the listeners associated to the Realm instance.
    
    Throws:
    
    java.lang.IllegalStateException - if attempting to refresh from within a transaction.
  - beginTransaction
```
public void beginTransaction()
```
    Starts a transaction, this must be closed with commitTransaction() or aborted by cancelTransaction(). Transactions are used to atomically create, update and delete objects within a Realm.
    Before beginning the transaction, beginTransaction() updates the realm in the case of pending updates from other threads.
    Notice: it is not possible to nest transactions. If you start a transaction within a transaction an exception is thrown.
  - commitTransaction
```
public void commitTransaction()
```
    All changes since beginTransaction() are persisted to disk and the Realm reverts back to being read-only. An event is sent to notify all other Realm instances that a change has occurred. When the event is received, the other Realms will get their objects and RealmResults updated to reflect the changes from this commit.
  - cancelTransaction
```
public void cancelTransaction()
```
    Reverts all writes (created, updated, or deleted objects) made in the current write transaction and end the transaction.
    The Realm reverts back to read-only.
    Calling this when not in a transaction will throw an exception.
  - getPath
```
public java.lang.String getPath()
```
    Returns the canonical path to where this Realm is persisted on disk.
    
    Returns:
    
    the canonical path to the Realm file.
    
    See Also:
    
    File.getCanonicalPath()
  - getConfiguration
```
public RealmConfiguration getConfiguration()
```
    Returns the RealmConfiguration for this Realm.
    
    Returns:
    
    the RealmConfiguration for this Realm.
  - getVersion
```
public long getVersion()
```
    Returns the schema version for this Realm.
    
    Returns:
    
    the schema version for the Realm file backing this Realm.
  - close
```
public void close()
```
    Closes the Realm instance and all its resources.
    It's important to always remember to close Realm instances when you're done with it in order not to leak memory, file descriptors or grow the size of Realm file out of measure.
    
    Specified by:
    
    close in interface java.io.Closeable
    
    Specified by:
    
    close in interface java.lang.AutoCloseable
    
    Throws:
    
    java.lang.IllegalStateException - if attempting to close from another thread.
  - isClosed
```
public boolean isClosed()
```
    Checks if the Realm instance has already been closed.
    
    Returns:
    
    true if closed, false otherwise.
    
    Throws:
    
    java.lang.IllegalStateException - if attempting to close from another thread.
  - isEmpty
```
public boolean isEmpty()
```
    Checks if this Realm contains any objects.
    
    Returns:
    
    true if empty, @{code false} otherwise.
  - getSchema
```
public RealmSchema getSchema()
```
    Returns the schema for this Realm.
    
    Returns:
    
    The RealmSchema for this Realm.
  - deleteAll
```
public void deleteAll()
```
    Deletes all objects from this Realm.
    
    Throws:
    
    java.lang.IllegalStateException - if the corresponding Realm is closed or called from an incorrect thread.

Class BaseRealm

Method Summary

Methods inherited from class java.lang.Object

Method Detail

setAutoRefresh

isAutoRefresh

isInTransaction

addChangeListener

removeChangeListener

asObservable

removeAllChangeListeners

writeCopyTo

writeEncryptedCopyTo

refresh

beginTransaction

commitTransaction

cancelTransaction

getPath

getConfiguration

getVersion

close

isClosed

isEmpty

getSchema

deleteAll