io.realm.exceptions

Class RealmMigrationNeededException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

io.realm.exceptions.RealmMigrationNeededException

All Implemented Interfaces:

java.io.Serializable

public class RealmMigrationNeededException
extends java.lang.RuntimeException

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
RealmMigrationNeededException(java.lang.String canonicalRealmPath, java.lang.String detailMessage)
RealmMigrationNeededException(java.lang.String canonicalRealmPath, java.lang.String detailMessage, java.lang.Throwable throwable)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getPath() Returns the canonical path to the Realm file that needs to be migrated.

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

RealmMigrationNeededException

public RealmMigrationNeededException(java.lang.String canonicalRealmPath,
                                     java.lang.String detailMessage)

RealmMigrationNeededException

public RealmMigrationNeededException(java.lang.String canonicalRealmPath,
                                     java.lang.String detailMessage,
                                     java.lang.Throwable throwable)

Method Detail

getPath

public java.lang.String getPath()

Returns the canonical path to the Realm file that needs to be migrated. This can be used for easy reference during a migration:

 try {
   Realm.getInstance(context);
 } catch (RealmMigrationNeededException e) {
   Realm.migrateRealmAtPath(e.getRealmPath(), new CustomMigration());
 }
 

Returns:

Canonical path to the Realm file.

See Also:

File.getCanonicalPath()