Pacote io.realm

Class RealmSchema

java.lang.Object

io.realm.RealmSchema

public abstract class RealmSchema
extends Object

Classe para interagir com o esquema Realm. Isso torna possível inspecionar, adicionar, excluir e alterar as classes no Realm.

Realm.getSchema() retorna um RealmSchema imutável que só pode ser usado para inspeção. Use DynamicRealm.getSchema() para obter um esquema mutável.

Todas as alterações devem ocorrer dentro de uma transação de escrita para o Realm específico.

Veja também:

RealmMigration

Resumo do método

Modificador e tipo	Método	Descrição
boolean	contains(String className)	Verifica se uma determinada classe já existe no esquema.
abstract RealmObjectSchema	create(String className)	Adiciona uma nova classe ao Realm.
void	createKeyPathMapping()	Crie o mapeamento de caminho chave subjacente.
abstract RealmObjectSchema	createWithPrimaryKeyField(String className, String primaryKeyFieldName, Class<?> fieldType, FieldAttribute... attributes)	Adiciona uma nova classe ao Realm com um campo de chave primária definido.
abstract RealmObjectSchema	get(String className)	Retorna o RealmObjectSchema para uma determinada classe.
abstract Set<RealmObjectSchema>	getAll()	Retorna os RealmObjectSchemas para todas as classes RealmObject que podem ser salvas neste Realm.
abstract void	remove(String className)	Remove uma classe do Realm.
abstract RealmObjectSchema	rename(String oldClassName, String newClassName)	Renomeia uma classe que já está no Realm.

Métodos herdados da classe java.lang.objeto

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

Detalhes do método

obter

@Nullable
public abstract RealmObjectSchema get(String className)

Retorna o RealmObjectSchema para uma determinada classe. Se este RealmSchema for imutável, um RealmObjectSchema imutável será retornado. Caso contrário, ele retorna um RealmObjectSchema mutável.

Parâmetros:

className - nome da classe

Retorna:

objeto de esquema para esta classe ou null se a classe não existir.

getAll

public abstract Set<RealmObjectSchema> getAll()

Retorna os RealmObjectSchemas para todas as classes RealmObject que podem ser salvas neste Realm. Se este RealmSchema for imutável, um conjunto RealmObjectSchema imutável será retornado. Caso contrário, ele retornará um conjunto RealmObjectSchema mutável.

Retorna:

o conjunto de todas as classes neste Realm ou nenhuma classe RealmObject pode ser salva no Realm.

criar

public abstract RealmObjectSchema create(String className)

Adiciona uma nova classe ao Realm.

Parâmetros:

className - nome da classe.

Retorna:

um objeto de esquema de Realm para essa classe.

Lançamentos:

UnsupportedOperationException - se este RealmSchema for imutável.

createWithPrimaryKeyField

public abstract RealmObjectSchema createWithPrimaryKeyField(String className,
                                                            String primaryKeyFieldName,
                                                            Class<?> fieldType,
                                                            FieldAttribute... attributes)

Adiciona uma nova classe ao Realm com um campo de chave primária definido.

Parâmetros:

className - nome da classe.

primaryKeyFieldName - nome do campo de chave primária.

fieldType - tipo de campo a ser adicionado. Somente byte, short, int, long e seus tipos de caixa ou o String são suportados.

attributes - conjunto de atributos para este campo. Este método adiciona implicitamente os atributos FieldAttribute.PRIMARY_KEY e FieldAttribute.INDEXED ao campo.

Retorna:

um objeto de esquema de Realm para essa classe.

Lançamentos:

UnsupportedOperationException - se este RealmSchema for imutável.

remover

public abstract void remove(String className)

Remove uma classe do Realm. Todos os dados serão removidos. Remover uma classe enquanto outras classes ponto para ela lançará um IllegalStateException. Remove essas classes ou campos primeiro.

Parâmetros:

className - nome da classe a ser removida.

Lançamentos:

UnsupportedOperationException - se este RealmSchema for imutável ou de um Realm sincronizado.

renomear

public abstract RealmObjectSchema rename(String oldClassName,
                                         String newClassName)

Renomeia uma classe que já está no Realm.

Parâmetros:

oldClassName - nome da classe antiga.

newClassName - novo nome da classe.

Retorna:

um objeto de esquema para classe renomeada.

Lançamentos:

UnsupportedOperationException - se este RealmSchema for imutável ou de um Realm sincronizado.

contém

boolean público contém (String className)

Verifica se uma determinada classe já existe no esquema.

Parâmetros:

className - nome da classe a ser verificado.

Retorna:

true se a turma já existir. false caso contrário.

createKeyPathMapping

public void createKeyPathMapping()

Crie o mapeamento de caminho chave subjacente. Só deve ser chamado por Realms digitados.