/ /

/ /

SDK de dispositivos Atlas

SDK de Java

Referencia de API

io.realm

Configuración del reino de la clase

Los SDK de dispositivos Atlas están obsoletos. Consulte Página de desuso para más detalles.

io.realm

java.lang.Object

io.realm.RealmConfiguration

Una RealmConfiguration se utiliza para configurar una instancia de Realm específica. Las instancias de una RealmConfiguration solo se pueden crear utilizando io.realm.RealmConfiguration.Builder y llamando a su método io.realm.RealmConfiguration.Builder.build().

Se puede acceder fácilmente a una RealmConfiguration de uso común guardándola primero como Realm.setDefaultConfiguration(RealmConfiguration) y luego usando io.realm.Realm.getDefaultInstance().

Se puede crear una configuración mínima utilizando:

RealmConfiguration config = new RealmConfiguration.Builder().build()

Esto creará una RealmConfiguration con las siguientes propiedades.

El archivo Realm se llama "default.realm"
Se guarda en Context.getFilesDir()
Tiene su versión de esquema establecida en 0.

Resumen de clases anidadas

Modificador y Tipo	Clase y descripción
`public static`	Configuración del reino.Builder

Resumen del campo

Modificador y Tipo	Campo y descripción
Cadenafinal estática pública	NOMBRE DEL REINO PREDETERMINADO

Resumen del método

Modificador y Tipo	Método y descripción
RealmProxyMediator estático protegido	createSchemaMediator ( java.util.Set<java.lang.Object> modules, java.util.Set<java.lang.Class<? extends io.realm.RealmModel>> debugSchema, boolean excludeDebugSchema )
booleanopúblico	equals ( Object obj )
Configuración de reino estática protegida	forRecovery ( String canonicalPath, byte[] encryptionKey, RealmProxyMediator schemaMediator )
cadena pública	getAssetFilePath () Devuelve la ruta al archivo de activos de Realm.
CompactOnLaunchCallback público	getCompactOnLaunchCallback () Devuelve una devolución de llamada para determinar si el archivo Realm debe compactarse antes de devolverlo al usuario.
público OsRealmConfig.Durability	getDurability ()
public byte	getEncryptionKey ()
FlowFactorypúblico	getFlowFactory () Devuelve el FlowFactory que se utiliza para crear flujos Kotlin a partir de objetos Realm.
Transacción dereino protegido	getInitialDataTransaction () Devuelve la instancia de transacción con datos iniciales.
Reino protegido	getInstance ( OsSharedRealm.VersionID version )
public long	getMaxNumberOfActiveVersions ()
público RealmMigration	getMigration ()
cadena pública	getPath () Devuelve la ruta absoluta donde se guardará el archivo Realm.
Archivo público	getRealmDirectory ()
cadena pública	getRealmFileName ()
conjunto público	getRealmObjectClasses () Devuelve el conjunto no modificable de clases de modelo que conforman el esquema para este reino.
Fábricapública de RxObservables	getRxFactory () Devuelve el RxObservableFactory que se utiliza para crear Rx Observables a partir de objetos Realm.
RealmProxyMediator protegido	getSchemaMediator () Devuelve la instancia del mediador del esquema que está definido por esta configuración.
public long	getSchemaVersion ()
booleanopúblico	hasAssetFile () Indica si se ha configurado un archivo de activos para esta configuración.
entero público	hashCode ()
booleanopúblico	isAllowQueriesOnUiThread () Devuelve si un RealmQuery puede lanzarse desde el hilo de la Interfaz de Usuario.
booleanopúblico	isAllowWritesOnUiThread () Devuelve si las llamadas a Realm.executeTransaction se pueden realizar en el hilo de UI.
booleanopúblico	isReadOnly () Devuelve si este reino es de solo lectura o no.
booleanopúblico	isRecoveryConfiguration ()
booleano protegido	isSyncConfiguration ()
booleano protegido	realmExists () Verifica si el archivo Realm definido por esta configuración ya existe.
booleanopúblico	shouldDeleteRealmIfMigrationNeeded ()
cadena pública	toString ()

Métodos heredados

Métodos heredados de la clase getClasshashCodeequalsclonetoStringnotifynotifyAllwaitwaitwaitjava.lang.Object:,,,,,,,,,, finalize

Detalle del Campo

`DEFAULT_REALM_NAME`

Detalle del método

createSchemaMediator

protected static RealmProxyMediator createSchemaMediator ( java.util.Set<java.lang.Object> modules, java.util.Set<java.lang.Class<? extends io.realm.RealmModel>> debugSchema, boolean excludeDebugSchema )

equals

public boolean equals ( Object obj )
Anulaciones `equals` en la clase Objeto

para la recuperación

protected static RealmConfiguration forRecovery ( String canonicalPath, byte[] encryptionKey, RealmProxyMediator schemaMediator )

getAssetFilePath

public String getAssetFilePath ()
Devuelve la ruta al archivo de activos de Realm. Devuelve ruta al archivo de activos en relación con el directorio de activos o `null` si no se especificó ningún archivo de activos.

obtenerCompactOnLaunchCallback

public CompactOnLaunchCallback getCompactOnLaunchCallback ()

Devuelve una devolución de llamada para determinar si el archivo Realm debe compactarse antes de devolverlo al usuario.

Devuelve

una función de retorno que se llama al abrir un Realm por primera vez durante la vida de un proceso para determinar si debe compactarse antes de devolverse al usuario. Se le pasa el tamaño total del archivo (datos + espacio libre) y el total de bytes utilizados por los datos en el archivo.

obtenerDurabilidad

public OsRealmConfig.Durability getDurability ()

obtenerClaveDeCifrado

public byte getEncryptionKey ()

obtenerFlowFactory

public FlowFactory getFlowFactory ()
Devuelve el FlowFactory que se utiliza para crear flujos Kotlin a partir de objetos Realm. Devuelve la instancia de fábrica utilizada para crear flujos. Lanzamientos UnsupportedOperationException: si el marco de corrutinas requerido no está en la ruta de clase.

getInitialDataTransaction

protected Realm.Transaction getInitialDataTransaction ()
Devuelve la instancia de transacción con datos iniciales. Devuelve la transacción de datos inicial.

obtenerInstancia

protected Realm getInstance ( OsSharedRealm.VersionID version )

obtenerNúmeroMáximoDeVersionesActivas

public long getMaxNumberOfActiveVersions ()
Devuelve el número máximo de versiones activas permitidas antes de que se lance una excepción.

obtenerMigración

public RealmMigration getMigration ()

obtenerRuta

public String getPath ()
Devuelve la ruta absoluta donde se guardará el archivo Realm. Devuelve la ruta absoluta al archivo Realm definido por esta configuración.

obtenerDirectorioReal

public File getRealmDirectory ()

getRealmFileName

public String getRealmFileName ()

obtenerClasesDeObjetoDeReino

public Set getRealmObjectClasses ()
Devuelve el conjunto no modificable de clases de modelo que conforman el esquema para este reino. Devuelve Conjunto inmodificable de clases modelo.

obtenerRxFactory

public RxObservableFactory getRxFactory ()
Devuelve el RxObservableFactory que se utiliza para crear Rx Observables a partir de objetos Realm. Devuelve la instancia de fábrica utilizada para crear Observables Rx. Lanzamientos UnsupportedOperationException - si el framework RxJava requerido no está en el classpath.

obtenerMediador de Esquema

protected RealmProxyMediator getSchemaMediator ()
Devuelve la instancia del mediador del esquema que está definido por esta configuración. Devuelve el mediador del esquema.

obtenerVersión del esquema

public long getSchemaVersion ()

tieneArchivoDeActivos

public boolean hasAssetFile ()
Indica si se ha configurado un archivo de activos para esta configuración. Devuelve `true` si hay archivo de activos, `false` en caso contrario.

código hash

public int hashCode ()
Anulaciones `hashCode` en la clase Objeto

isAllowQueriesOnUiThread

public boolean isAllowQueriesOnUiThread ()
Devuelve si un RealmQuery puede lanzarse desde el hilo de la Interfaz de Usuario. Realm permite consultas en el hilo principal de forma predeterminada. Para deshabilitarlas, los usuarios deben habilitarlas explícitamente con Builder.allowQueriesOnUiThread(boolean) o su equivalente en Realm Sync. Devuelve si se permite o no ejecutar consultas desde el hilo de UI.

se permite escritura en hilo de interfaz de usuario

public boolean isAllowWritesOnUiThread ()
Devuelve si las llamadas a Realm.executeTransaction se pueden realizar en el hilo de UI. Nota: Realm no permite ejecutar transacciones bloqueantes en el hilo principal, a menos que los usuarios lo elijan explícitamente con Builder.allowWritesOnUiThread(boolean) o su equivalente en Realm sincronizar builder. Devuelve si se permite o no ejecutar operaciones de escritura desde el hilo de UI.

es de solo lectura

public boolean isReadOnly ()
Indica si este dominio es de solo lectura. Los dominios de solo lectura no se pueden modificar y generarán una excepción IllegalStateException si se llama a Realm.beginTransaction(). Devuelve `true` si este reino es de sólo lectura, `false` si no.

esRecoveryConfiguration

public boolean isRecoveryConfiguration ()
Devuelve `true` Si esta configuración está destinada a abrir un Reino de respaldo (como resultado de un reinicio del cliente). Tip {@link Error de restablecimiento del cliente requerido}

Configuración de isSync

protected boolean isSyncConfiguration ()

realmExiste

protected boolean realmExists ()
Comprueba si el archivo Realm definido por esta configuración ya existe. ADVERTENCIA: Este método es solo una comprobación puntual. A menos que esté protegido por sincronización externa, otro hilo o proceso podría haber creado o eliminado el archivo Realm justo después de que este método haya regresado. Devuelve `true` si el archivo Realm existe, `false` en caso contrario.

shouldDeleteRealmIfMigrationNeeded

public boolean shouldDeleteRealmIfMigrationNeeded ()

aCadena

public String toString ()
Anulaciones `toString` en la clase Objeto

Volver

Colección Realm

Configuración del reino.Builder

io.realm

Resumen de clases anidadas

Resumen del campo

Resumen del método

Métodos heredados

Detalle del Campo

DEFAULT_REALM_NAME

Detalle del método

createSchemaMediator

equals

para la recuperación

getAssetFilePath

obtenerCompactOnLaunchCallback

obtenerDurabilidad

obtenerClaveDeCifrado

obtenerFlowFactory

getInitialDataTransaction

obtenerInstancia

obtenerNúmeroMáximoDeVersionesActivas

obtenerMigración

obtenerRuta

obtenerDirectorioReal

getRealmFileName

obtenerClasesDeObjetoDeReino

obtenerRxFactory

obtenerMediador de Esquema

obtenerVersión del esquema

tieneArchivoDeActivos

código hash

isAllowQueriesOnUiThread

se permite escritura en hilo de interfaz de usuario

es de solo lectura

esRecoveryConfiguration

Tip

Configuración de isSync

realmExiste

shouldDeleteRealmIfMigrationNeeded

aCadena

`DEFAULT_REALM_NAME`