Class RealmObjectSchema

Os Atlas Device SDKs estão obsoletos. Consulte apágina de descontinuação do para detalhes.

io.realm

java.lang.Object

io.realm.RealmObjectSchema

Classe para interagir com o esquema de uma determinada classe RealmObject . Isso torna possível inspecionar, adicionar, excluir ou alterar os campos de uma determinada classe. Se este RealmObjectSchema for recuperado de um RealmSchema imutável, este RealmObjectSchema também será imutável.

Dica

Veja também:

io.realm.RealmMigration

Resumo da classe aninhada

Modificador e tipo	Classe e descrição
`public static interface`	RealmObjectSchema.Function

Resumo do método

Modificador e tipo	Método e descrição
public abstract RealmObjectSchema	addField ( String fieldName, java.lang.Class<?> fieldType, io.realm.FieldAttribute[] attributes ) Adiciona um novo campo simples à classe RealmObject.
public abstract RealmObjectSchema	addIndex ( String fieldName ) Adiciona um índice a um determinado campo.
public abstract RealmObjectSchema	addPrimaryKey ( String fieldName ) Adiciona uma chave primária a um determinado campo.
public abstract RealmObjectSchema	addRealmDictionaryField ( String fieldName, java.lang.Class<?> primitiveType ) Adiciona um novo campo que faz referência a um RealmDictionary com valores primitivos.
public abstract RealmObjectSchema	addRealmDictionaryField ( String fieldName, RealmObjectSchema objectSchema ) Adiciona um novo campo que contém um RealmDictionary com referências a outras classes de modelo do Realm.
public abstract RealmObjectSchema	addRealmListField ( String fieldName, java.lang.Class<?> primitiveType ) Adiciona um novo campo que referencia um RealmList com valores primitivos.
public abstract RealmObjectSchema	addRealmListField ( String fieldName, RealmObjectSchema objectSchema ) Adiciona um novo campo que contém um RealmList com referências a outras classes de modelo do Realm.
public abstract RealmObjectSchema	addRealmObjectField ( String fieldName, RealmObjectSchema objectSchema ) Adiciona um novo campo que faz referência a outro RealmObject .
public abstract RealmObjectSchema	addRealmSetField ( String fieldName, java.lang.Class<?> primitiveType ) Adiciona um novo campo que referencia um RealmSet com valores primitivos.
public abstract RealmObjectSchema	addRealmSetField ( String fieldName, RealmObjectSchema objectSchema ) Adiciona um novo campo que contém um RealmSet com referências a outras classes de modelo do Realm.
string pública	getClassName () Retorna o nome da classe RealmObject que está sendo representada por este esquema.
conjunto público	getFieldNames () Retorna todos os campos desta classe.
Public RealmFieldType	getFieldType ( String fieldName ) Retorna o tipo usado pelo storage engine subjacente para representar este campo.
string pública	getPrimaryKey () Retorna o nome do campo de chave primária.
booleanopúblico	hasField ( String fieldName ) Testa se a classe tem um campo definido com o nome fornecido.
booleanopúblico	hasIndex ( String fieldName ) Verifica se um determinado campo tem um índice definido.
booleanopúblico	hasPrimaryKey () Verifica se a classe tem uma chave primária definida.
booleanopúblico	isEmbedded () Retorna `true` se objetos desse tipo forem considerados "incorporados".
booleanopúblico	isNullable ( String fieldName ) Verifica se um determinado campo é anulável, ou seja, ele é permitido conter valores `null` .
booleanopúblico	isPrimaryKey ( String fieldName ) Verifica se um determinado campo é o campo de chave primária.
booleanopúblico	isRequired ( String fieldName ) Verifica se um determinado campo é obrigatório, ou seja, não é permitido conter valores `null` .
public abstract RealmObjectSchema	removeField ( String fieldName ) Remove um campo da classe.
public abstract RealmObjectSchema	removeIndex ( String fieldName ) Remove um índice de um determinado campo.
public abstract RealmObjectSchema	removePrimaryKey () Remove a chave primária desta classe.
public abstract RealmObjectSchema	renameField ( String currentFieldName, String newFieldName ) Renomeia um campo de um nome para outro.
public abstract RealmObjectSchema	setClassName ( String className ) Define um novo nome para esta classe RealmObject.
public void	setEmbedded ( boolean embedded ) Converte a classe para ser incorporada ou não.
public abstract RealmObjectSchema	setNullable ( String fieldName, boolean nullable ) Define um campo como anulável, ou seja, ele deve ser capaz de manter `null` valores.
public abstract RealmObjectSchema	setRequired ( String fieldName, boolean required ) Define um campo como obrigatório, ou seja, ele não é permitido manter valores `null` .
public abstract RealmObjectSchema	transform ( RealmObjectSchema.Function function ) Executa uma função de transformação em cada instância RealmObject da classe atual.

Métodos herdados

Métodos herdados da classe java.lang.Object : getClass , hashCode , equals , clone , toString , notify , notifyAll , wait , wait , wait , finalize

Detalhes do método

addField

public abstract RealmObjectSchema addField (

String  fieldName,
java.lang.Class<?>  fieldType,
io.realm.FieldAttribute[]  attributes

)

Adiciona um novo campo simples à classe RealmObject. O tipo deve ser suportado pelo Realm. Consulte RealmObject para obter a lista de tipos suportados. Se o campo permitir valores null , use o tipo em caixa em vez disso, por exemplo, Integer.class em vez de int.class .

Para adicionar campos que fazem referência a outros RealmObjects ou RealmLists, use addRealmObjectField(string, RealmObjectSchema) ou addRealmListField(string, RealmObjectSchema) .

Parâmetros

fieldName - nome do campo a ser adicionado.
fieldType - tipo de campo a ser adicionado. Consulte RealmObject para obter a lista completa.
attributes - conjunto de atributos para este campo.

Devoluções

o esquema atualizado.

Lança

IllegalArgumentException - se o tipo não for suportado, o nome do campo é ilegal ou já existe um campo com esse nome.
UnsupportedOperationException - se este RealmObjectSchema for imutável ou se adicionar um campo com o atributo FieldAttribute.PRIMARY_KEY a um esquema de um Realm sincronizado.

AdicionarIndex

public abstract RealmObjectSchema addIndex (

String fieldName

)

Adiciona um índice a um determinado campo. Isto é equivalente a adicionar a anotação io.realm.annotations.Index no campo.

Parâmetros

fieldName - campo ao qual adicionar o índice.

Devoluções

o esquema atualizado.

Lança

IllegalArgumentException - se o nome do campo não existir, o campo não pode ser indexado ou já tem um índice definido.
UnsupportedOperationException - se este RealmObjectSchema for imutável.

addPrimaryKey

public abstract RealmObjectSchema addPrimaryKey (

String fieldName

)

Adiciona uma chave primária a um determinado campo. Isso é o mesmo que adicionar a anotação io.realm.annotations.PrimaryKey no campo. Além disso, isso também adiciona implicitamente a anotação io.realm.annotations.Index ao campo.

Parâmetros

fieldName - campo para definir como chave primária.

Devoluções

o esquema atualizado.

Lança

IllegalArgumentException - se o nome do campo não existir, o campo não pode ser uma chave primária ou já tem uma chave primária definida.
UnsupportedOperationException - se este RealmObjectSchema for imutável ou de um Realm sincronizado.

addRealmDictionaryField

public abstract RealmObjectSchema addRealmDictionaryField (

String fieldName,

java.lang.Class<?> primitiveType

)

Adiciona um novo campo que faz referência a um RealmDictionary com valores primitivos. Consulte RealmObject para obter a lista de tipos suportados.

A anulabilidade dos elementos é definida usando a classe correta, por exemplo, Integer.class em vez de int.class . Como alternativa , setRequired(string, boolean) pode ser usado.

Exemplo:

// Defines the dictionary of Strings as being non null.
RealmObjectSchema schema = schema.create("Person")
    .addRealmDictionaryField("parentAndChild", String.class)
    .setRequired("parentAndChild", true)

Se a lista contiver referências a outras classes Realm , use addRealmDictionaryField(string, RealmObjectSchema) .

Parâmetros

fieldName - nome do campo a ser adicionado.
primitiveType - tipo simples de elementos na array.

Devoluções

o esquema atualizado.

Lança

IllegalArgumentException - se o nome do campo for ilegal, já existe um campo com esse nome ou o tipo de elemento não é suportado.
UnsupportedOperationException - se este RealmObjectSchema for imutável.

public abstract RealmObjectSchema addRealmDictionaryField (

String fieldName,

RealmObjectSchema objectSchema

)

Adiciona um novo campo que contém um RealmDictionary com referências a outras classes de modelo do Realm.

Se o dicionário contiver tipos primitivos, use addRealmDictionaryField(string, Class) .

Parâmetros

fieldName - nome do campo a ser adicionado.
objectSchema - esquema para o tipo de Realm que está sendo referenciado.

Devoluções

o esquema atualizado.

Lança

IllegalArgumentException - se o nome do campo for ilegal ou já existir um campo com esse nome.
UnsupportedOperationException - se este RealmObjectSchema for imutável.

addRealmListField

public abstract RealmObjectSchema addRealmListField (

String fieldName,

java.lang.Class<?> primitiveType

)

Adiciona um novo campo que referencia um RealmList com valores primitivos. Consulte RealmObject para obter a lista de tipos suportados.

A anulabilidade dos elementos é definida usando a classe correta, por exemplo, Integer.class em vez de int.class . Como alternativa , setRequired(string, boolean) pode ser usado.

Exemplo:

// Defines the list of Strings as being non null.
RealmObjectSchema schema = schema.create("Person")
    .addRealmListField("children", String.class)
    .setRequired("children", true)

Se a lista contiver referências a outras classes Realm , use addRealmListField(string, RealmObjectSchema) .

Parâmetros

fieldName - nome do campo a ser adicionado.
primitiveType - tipo simples de elementos na array.

Devoluções

o esquema atualizado.

Lança

IllegalArgumentException - se o nome do campo for ilegal, já existe um campo com esse nome ou o tipo de elemento não é suportado.
UnsupportedOperationException - se este RealmObjectSchema for imutável.

public abstract RealmObjectSchema addRealmListField (

String fieldName,

RealmObjectSchema objectSchema

)

Adiciona um novo campo que contém um RealmList com referências a outras classes de modelo do Realm.

Se a lista contiver tipos primitivos, use addRealmListField(string, Class) .

Parâmetros

fieldName - nome do campo a ser adicionado.
objectSchema - esquema para o tipo de Realm que está sendo referenciado.

Devoluções

o esquema atualizado.

Lança

IllegalArgumentException - se o nome do campo for ilegal ou já existir um campo com esse nome.
UnsupportedOperationException - se este RealmObjectSchema for imutável.

addRealmObjectField

public abstract RealmObjectSchema addRealmObjectField (

String fieldName,

RealmObjectSchema objectSchema

)

Adiciona um novo campo que faz referência a outro RealmObject .

Parâmetros

fieldName - nome do campo a ser adicionado.
objectSchema - esquema para o tipo de Realm que está sendo referenciado.

Devoluções

o esquema atualizado.

Lança

IllegalArgumentException - se o nome do campo for ilegal ou já existir um campo com esse nome.
UnsupportedOperationException - se este RealmObjectSchema for imutável.

addRealmSetField

public abstract RealmObjectSchema addRealmSetField (

String fieldName,

java.lang.Class<?> primitiveType

)

Adiciona um novo campo que referencia um RealmSet com valores primitivos. Consulte RealmObject para obter a lista de tipos suportados.

A anulabilidade dos elementos é definida usando a classe correta, por exemplo, Integer.class em vez de int.class . Como alternativa , setRequired(string, boolean) pode ser usado.

Exemplo:

// Defines the set of Strings as being non null.
RealmObjectSchema schema = schema.create("Person")
    .addRealmSetField("children", String.class)
    .setRequired("children", true)

Se a lista contiver referências a outras classes Realm , use addRealmSetField(string, RealmObjectSchema) .

Parâmetros

fieldName - nome do campo a ser adicionado.
primitiveType - tipo simples de elementos na array.

Devoluções

o esquema atualizado.

Lança

IllegalArgumentException - se o nome do campo for ilegal, já existe um campo com esse nome ou o tipo de elemento não é suportado.
UnsupportedOperationException - se este RealmObjectSchema for imutável.

public abstract RealmObjectSchema addRealmSetField (

String fieldName,

RealmObjectSchema objectSchema

)

Adiciona um novo campo que contém um RealmSet com referências a outras classes de modelo do Realm.

Se o conjunto contiver tipos primitivos, use addRealmSetField(string, Class) .

Parâmetros

fieldName - nome do campo a ser adicionado.
objectSchema - esquema para o tipo de Realm que está sendo referenciado.

Devoluções

o esquema atualizado.

Lança

IllegalArgumentException - se o nome do campo for ilegal ou já existir um campo com esse nome.
UnsupportedOperationException - se este RealmObjectSchema for imutável.

getClassName

public String getClassName ()

Retorna o nome da classe RealmObject que está sendo representada por este esquema.

Ao usar um Realm normal, este nome é o mesmo que a classe RealmObject .
Ao usar um dynamicRealm , este é o nome usado em todos os métodos de API que exigem um nome de classe.

Devoluções

o nome da classe RealmObject representada por este esquema.

Lança

Exceção de estado ilegal - se esta definição de esquema não fizer mais parte do Realm.

getFieldNames

public Set getFieldNames ()
Retorna todos os campos desta classe. Devoluções uma lista de todos os campos nesta classe.

getFieldType

public RealmFieldType getFieldType ( String fieldName )
Retorna o tipo usado pelo storage engine subjacente para representar este campo. Parâmetros `fieldName` - nome do campo de destino. Devoluções o tipo subjacente usado pelo Realm para representar este campo.

getPrimaryKey

public String getPrimaryKey ()
Retorna o nome do campo de chave primária. Devoluções o nome do campo de chave primária. Lança Exceção de estado ilegal - se a classe não tiver uma chave primária definida.

hasField

public boolean hasField ( String fieldName )
Testa se a classe tem um campo definido com o nome fornecido. Parâmetros `fieldName` - nome do campo a ser testado. Devoluções `true` se o campo existir, `false` caso contrário.

hasIndex

public boolean hasIndex ( String fieldName )
Verifica se um determinado campo tem um índice definido. Parâmetros `fieldName` - nome do campo existente a ser verificado. Devoluções `true` se o campo estiver indexado, `false` caso contrário. Lança IllegalArgumentException - se o nome do campo não existir. Dica Veja também: io.realm.annotations.Index

hasPrimaryKey

public boolean hasPrimaryKey ()
Verifica se a classe tem uma chave primária definida. Devoluções `true` se uma chave primária for definida, `false` caso contrário. Dica Veja também: io.realm.annotations.PrimaryKey

está incorporado

public boolean isEmbedded ()
Retorna `true` se objetos desse tipo forem considerados "incorporados". Consulte RealmClass.embedded() para obter mais detalhes. Devoluções `true` se objetos desse tipo estiverem embarcados. `false` caso contrário.

isNullable

public boolean isNullable ( String fieldName )
Verifica se um determinado campo é anulável, ou seja, ele é permitido conter valores `null` . Parâmetros `fieldName` - campo para verificar. Devoluções `true` se for necessário, `false` caso contrário. Lança IllegalArgumentException - se o nome do campo não existir. Dica Veja também: setNullable(String, booleano)

isPrimaryKey

public boolean isPrimaryKey ( String fieldName )
Verifica se um determinado campo é o campo de chave primária. Parâmetros `fieldName` - campo para verificar. Devoluções `true` se for o campo de chave primária, `false` caso contrário. Lança IllegalArgumentException - se o nome do campo não existir. Dica Veja também: addPrimaryKey(String)

isRequired

public boolean isRequired ( String fieldName )
Verifica se um determinado campo é obrigatório, ou seja, não é permitido conter valores `null` . Parâmetros `fieldName` - campo para verificar. Devoluções `true` se for necessário, `false` caso contrário. Lança IllegalArgumentException - se o nome do campo não existir. Dica Veja também: setRequired(String, booleano)

removeField

public abstract RealmObjectSchema removeField ( String fieldName )
Remove um campo da classe. Parâmetros `fieldName` - nome do campo a ser removido. Devoluções o esquema atualizado. Lança IllegalArgumentException - se o nome do campo não existir. UnsupportedOperationException - se este RealmObjectSchema for imutável ou para um Realm sincronizado.

removeIndex

public abstract RealmObjectSchema removeIndex (

String fieldName

)

Remove um índice de um determinado campo. Isto é o mesmo que remover a anotação @Index no campo.

Parâmetros

fieldName - campo do qual remover o índice.

Devoluções

o esquema atualizado.

Lança

IllegalArgumentException - se o nome do campo não existir ou o campo não tiver um índice.
UnsupportedOperationException - se este RealmObjectSchema for imutável ou de um Realm sincronizado.

removePrimaryKey

public abstract RealmObjectSchema removePrimaryKey ()

Remove a chave primária desta classe. Isso é o mesmo que remover a anotação io.realm.annotations.PrimaryKey da classe. Além disso, isso remove implicitamente a anotação io.realm.annotations.Index do campo também.

Devoluções

o esquema atualizado.

Lança

IllegalArgumentException - se a classe não tiver uma chave primária definida.
UnsupportedOperationException - se este RealmObjectSchema for imutável ou de um Realm sincronizado.

Renomear campo

public abstract RealmObjectSchema renameField ( String currentFieldName, String newFieldName )
Renomeia um campo de um nome para outro. Parâmetros `currentFieldName` - nome do campo para renomear. `newFieldName` - o novo nome do campo. Devoluções o esquema atualizado. Lança IllegalArgumentException - se o nome do campo não existir ou se o novo nome do campo já existir. UnsupportedOperationException - se este RealmObjectSchema for imutável ou para um Realm sincronizado.

setClassName

public abstract RealmObjectSchema setClassName (

String className

)

Define um novo nome para esta classe RealmObject. Isso equivale a renomeá-lo.

Parâmetros

className - o novo nome para esta classe.

Lança

IllegalArgumentException - se className for null ou uma string vazia, ou seu comprimento exceder 56 caracteres.
UnsupportedOperationException - se este RealmObjectSchema for imutável ou de um Realm sincronizado.

Dica

Veja também:

RealmSchema.rename(String, Corda)

setEmbedded

public void setEmbedded (

boolean embedded

)

Converte a classe para ser incorporada ou não. Uma classe só pode ser marcada como incorporada se as seguintes invariantes estiverem satisfeitas:

A classe não pode ter uma chave primária definida.
Todos os objetos existentes desse tipo devem ter um e exatamente um objeto pai já apontando para ele. Se 0 ou mais de 1 objeto tiver uma referência a um objeto que está prestes a ser marcado como incorporado como uma IllegalStateException será lançado.

Lança

Exceção de estado ilegal - se a classe não pudesse ser convertida porque quebrou alguns dos invariantes dos Objetos embarcados.

Dica

Veja também:

RealmClass.embedded()

setNullable

public abstract RealmObjectSchema setNullable (

String fieldName,

boolean nullable

)

Define um campo como anulável, ou seja, ele deve ser capaz de manter null valores. Isso é equivalente a alternar entre tipos primitivos e sua variante em caixa, por exemplo, int a Integer .

Se o tipo de campo designado for uma lista de valores (não RealmObject s , a nulidade especificada afetará apenas seus elementos, não o campo em si. A lista de valores em si é sempre não anulável.

Parâmetros

fieldName - nome do campo na classe.
nullable - true se o campo deve ser anulável, false caso contrário.

Devoluções

o esquema atualizado.

Lança

IllegalArgumentException - se o nome do campo não existir ou não puder ser definido como anulável.
UnsupportedOperationException - se este RealmObjectSchema for imutável.

setRequired

public abstract RealmObjectSchema setRequired (

String fieldName,

boolean required

)

Define um campo como obrigatório, ou seja, ele não é permitido manter valores null . Isso é equivalente a alternar entre os tipos de caixa e sua variante primitiva, por exemplo, Integer para int .

Parâmetros

fieldName - nome do campo na classe.
required - true se o campo for obrigatório, false caso contrário.

Devoluções

o esquema atualizado.

Lança

IllegalArgumentException - se o nome do campo não existir, não pode ter a anotação Obrigatória ou o campo já tiver sido definido como obrigatório.
UnsupportedOperationException - se este RealmObjectSchema for imutável.

Dica

Veja também:

Obrigatório

transformação, transformação

public abstract RealmObjectSchema transform ( RealmObjectSchema.Function function )
Executa uma função de transformação em cada instância RealmObject da classe atual. O objeto será representado como um dynamicRealmObject . Não há garantias em que ordem os objetos serão retornados. Parâmetros `function` - função de transformação. Devoluções esse esquema. Lança UnsupportedOperationException - se este RealmObjectSchema for imutável.

Voltar

RealmObjectChangeListener

RealmObjectSchema.Function