io.realm

Class RealmSchema

java.lang.Object

io.realm.RealmSchema

public abstract class RealmSchema
extends Object

Class for interacting with the Realm schema using a dynamic API. This makes it possible to add, delete and change the classes in the Realm.

All changes must happen inside a write transaction for the particular Realm.

See Also:

RealmMigration

Constructor Summary

Constructors

Constructor and Description
RealmSchema()

Method Summary

Modifier and Type	Method and Description
abstract void	close() Release the schema and any of native resources it might hold.
abstract boolean	contains(String className) Checks if a given class already exists in the schema.
abstract RealmObjectSchema	create(String className) Adds a new class to the Realm.
abstract RealmObjectSchema	get(String className) Returns the Realm schema for a given class.
abstract Set<? extends RealmObjectSchema>	getAll() Returns the RealmObjectSchemas for all RealmObject classes that can be saved in this Realm.
abstract void	remove(String className) Removes a class from the Realm.
abstract RealmObjectSchema	rename(String oldClassName, String newClassName) Renames a class already in the Realm.

Methods inherited from class java.lang.Object

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

Constructor Detail

RealmSchema

public RealmSchema()

Method Detail

close

public abstract void close()

Release the schema and any of native resources it might hold.

get

public abstract RealmObjectSchema get(String className)

Returns the Realm schema for a given class.

Parameters:

className - name of the class

Returns:

schema object for that class or null if the class doesn't exists.

getAll

public abstract Set<? extends RealmObjectSchema> getAll()

Returns the RealmObjectSchemas for all RealmObject classes that can be saved in this Realm.

Returns:

the set of all classes in this Realm or no RealmObject classes can be saved in the Realm.

create

public abstract RealmObjectSchema create(String className)

Adds a new class to the Realm.

Parameters:

className - name of the class.

Returns:

a Realm schema object for that class.

remove

public abstract void remove(String className)

Removes a class from the Realm. All data will be removed. Removing a class while other classes point to it will throw an IllegalStateException. Removes those classes or fields first.

Parameters:

className - name of the class to remove.

rename

public abstract RealmObjectSchema rename(String oldClassName,
                                         String newClassName)

Renames a class already in the Realm.

Parameters:

oldClassName - old class name.

newClassName - new class name.

Returns:

a schema object for renamed class.

contains

public abstract boolean contains(String className)

Checks if a given class already exists in the schema.

Parameters:

className - class name to check.

Returns:

true if the class already exists. false otherwise.