Pacote io.realm

Class RealmConfiguration

  • Subclasses diretas conhecidas:
    SyncConfiguration
    public class RealmConfiguration
extends Object
    Uma RealmConfiguration é usada para configurar uma Instância de Realm específica.

    As instâncias de um RealmConfiguration só podem ser criadas usando o RealmConfiguration.Builder e chamando seu método RealmConfiguration.Builder.build() .

    Um RealmConfiguration comumente usado pode ser facilmente acessado salvando-o primeiro como Realm.setDefaultConfiguration(RealmConfiguration) e, em seguida, usando Realm.getDefaultInstance().

    Uma configuração mínima pode ser criada usando:

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

    Isso criará um RealmConfiguration com as seguintes propriedades.

    • Arquivo de Realm é chamado de "default.realm"
    • Ele é salvo em Context.getFilesDir()
    • Ela tem sua versão do esquema definida como 0.

    • Detalhes do método

      • getRealmDirectory

        arquivo público getRealmDirectory()

      • getRealmFileName

        string pública getRealmFileName()

      • getEncryptionKey

        byte público[] getEncryptionKey()

      • getSchemaVersion

        público longo getSchemaVersion()

      • shouldDeleteRealm IfMigrationNeeded

        public boolean shouldDeleteRealm IfMigrationNeeded()

      • getDuribility

        public io.realm.internal.OsRealmConfig.Durability getDurability()

      • hasAssetFile

        public boolean hasAssetFile()
        Indica se um arquivo de ativo foi configurado para esta configuração.
        Retorna:
        true se houver um arquivo de ativo, caso contrário, false .

      • getAssetFilePath

        @Nullable
public String getAssetFilePath()
        Retorna o caminho para o arquivo de ativo do Realm.
        Retorna:
        caminho para o arquivo de ativo relativo ao diretório de ativo ou null se nenhum arquivo de ativo foi especificado.

      • getCompactOnLaunchCallback

        compactaOnLaunchCallback getCompactOnLaunchCallback()
        Retorna um chamada de resposta para determinar se o Arquivo de Realm deve ser compactado antes de ser devolvido ao usuário.
        Retorna:
        uma chamada de resposta chamada ao abrir um realm pela primeira vez durante a vida útil de um processo para determinar se ele deve ser compactado antes de ser retornado ao usuário. É passado o tamanho total do arquivo (dados + espaço livre) e o total de bytes usados pelos dados no arquivo.

      • getRealmObjectClasses

        public Set<Class<? extends RealmModel>> getRealmObjectClasses()
        Retorna o Set não modificável de classes de modelo que compõem o esquema para este Realm.
        Retorna:
        Set não modificável de classes de modelo.

      • getPath

        string pública getPath()
        Retorna o caminho absoluto para onde o Arquivo de Realm será salvo.
        Retorna:
        o caminho absoluto para o Arquivo de Realm definido por esta configuração.

      • getFlowFactory

        public FlowFactory getFlowFactory()
        Retorna o FlowFactory que é usado para criar Kotlin Flows a partir de Objeto de Realm.
        Retorna:
        a instância de fábrica usada para criar Fluxos.
        Lançamentos:
        UnsupportedOperationException - se a estrutura de corrotina necessária não estiver no classpath.

      • isReadOnly

        boolean público isReadOnly()
        Retorna se este Realm é somente leitura ou não. Os domínios somente leitura não podem ser modificados e lançarão um IllegalStateException se BaseRealm.beginTransaction() for chamado nele.
        Retorna:
        true se este Realm for somente leitura, false caso contrário.

      • isRecuperaçãoConfiguração

        public boolean isRecuperaçãoConfiguration()
        Retorna:
        true se essa configuração for destinada a abrir um Realm (como resultado de um reinício do cliente).

      • getMaxNumberOfAtiveVersions

        público longo getMaxNumberOfAtiveVersions()
        Retorna:
        o número máximo de versões ativas permitidas antes que uma exceção seja lançada.

      • isAllowWritesOnUiThread

        booleano público isAllowWritesOnUiThread()
        Retorna se as chamadas para Realm.executeTransaction(io.realm.Realm.Transaction) podem ser feitas no thread da interface do usuário.

        Observação: o Realm não permite que transações de bloqueio sejam executadas no thread principal, a menos que os usuários aceitem explicitamente RealmConfiguration.Builder.allowWritesOnUiThread(boolean) ou sua contraparte do construtor Realm Sync.

        Retorna:
        se as operações de gravação podem ou não ser executadas a partir do thread de UI.

      • isAllowQueriesOnUiThread

        boolean público isAllowQueriesOnUiThread()
        Retorna se um RealmQuery tem permissão para ser iniciado a partir do thread da interface do usuário.

        Por padrão, o Realm permite query na thread principal. Para proibir isso, os usuários precisam optar explicitamente por RealmConfiguration.Builder.allowQueriesOnUiThread(boolean) ou seu equivalente no construtor Realm Sync.

        Retorna:
        se as queries podem ou não ser executadas a partir do thread da UI.