io.realm

Class RealmSchema

java.lang.Object

io.realm.RealmSchema

public 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

Method Summary

Modifier and Type	Method and Description
void	close() Deprecated. RealmSchema doesn't have to be released manually.
boolean	contains(String className) Checks if a given class already exists in the schema.
RealmObjectSchema	create(String className) Adds a new class to the Realm.
RealmObjectSchema	get(String className) Returns the Realm schema for a given class.
Set<RealmObjectSchema>	getAll() Returns the RealmObjectSchemas for all RealmObject classes that can be saved in this Realm.
void	remove(String className) Removes a class from the Realm.
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

Method Detail

close

@Deprecated
public void close()

Deprecated. RealmSchema doesn't have to be released manually.

get

public 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 Set<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 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 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 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 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.