Docs 菜单
Docs 主页
/
MongoDB Atlas
/
Atlas Device SDKs
/
Java SDK
/
API 参考
/
io.realm

RealmSchema 类

在此页面上

  • io.realm
  • 方法摘要
  • 继承方法
  • 方法详细信息
  • contains
  • 创建
  • createKeyPathMapping
  • createWithPrimaryKeyField
  • 获取
  • getAll
  • getColumnInfo
  • 删除
  • 改名

io.realm

java.lang.Object
io.realm.RealmSchema

用于与 Realm 模式交互的类。 这样就可以检查、添加、删除和更改 Realm 中的类。:ref: Realm.getSchema() <io_realm_Realm_getSchema__> 返回一个不可变的RealmSchema ，只能用于检查。 使用DynamicRealm.getSchema()获取可变模式。

所有更改都必须在特定 Realm 的写事务中发生。

提示

另请参阅：

  • RealmMigration

方法摘要

修饰符和类型
方法和说明
公共布尔值
contains (
String className
)

检查给定类是否已存在于模式中。

public abstract RealmObjectSchema
create (
String className
)

向 Realm 添加一个新类。

public void
createKeyPathMapping ()

创建底层键路径映射。

public abstract RealmObjectSchema
createWithPrimaryKeyField (
String className,
String primaryKeyFieldName,
java.lang.Class<?> fieldType,
io.realm.FieldAttribute[] attributes
)

向 Realm 添加一个新类，并定义主键字段。

public abstract RealmObjectSchema
get (
String className
)

返回给定类的RealmObjectSchema 。

public abstract Set
getAll ()

返回可保存在此 Realm 中的所有 RealmObject 类的RealmObjectSchema 。

protected final ColumnInfo
getColumnInfo (
String className
)
public abstract void
remove (
String className
)

从 Realm 中删除类。

public abstract RealmObjectSchema
rename (
String oldClassName,
String newClassName
)

重命名 Realm 中已有的类。

继承方法

  • 从类 java.lang.Object 继承的方法 ：getClass 、hashCode 、equals 、clone 、toString 、notify 、notifyAll 、wait 、wait 、wait 、finalize

方法详细信息

contains

public boolean contains (
String className
)

检查给定类是否已存在于模式中。

参数

  • className — 要检查的类名。

返回：

true 如果该类已经存在。 否则false 。

创建

public abstract RealmObjectSchema create (
String className
)

向 Realm 添加一个新类。

参数

  • className - 类的名称。

返回：

该类的 Realm 模式对象。

抛出异常

createKeyPathMapping

public void createKeyPathMapping ()

创建底层键路径映射。 只能由类型化 Realm 调用。

createWithPrimaryKeyField

public abstract RealmObjectSchema createWithPrimaryKeyField (
String className,
String primaryKeyFieldName,
java.lang.Class<?> fieldType,
io.realm.FieldAttribute[] attributes
)

向 Realm 添加一个新类，并定义主键字段。

参数

  • className - 类的名称。

  • primaryKeyFieldName — 主键字段的名称。

  • fieldType — 要添加的字段类型。 仅支持byte 、 short 、 int 、 long及其装箱类型或String 。

  • attributes — 此字段的属性集。此方法隐式向字段添加FieldAttribute.PRIMARY_KEY和FieldAttribute.INDEXED属性。

返回：

该类的 Realm 模式对象。

抛出异常

获取

public abstract RealmObjectSchema get (
String className
)

返回给定类的RealmObjectSchema 。 如果此RealmSchema不可变，则返回不可变的RealmObjectSchema 。 否则，它将返回一个可变的RealmObjectSchema 。

参数

  • className - 类名

返回：

该类的模式对象，如果该类不存在，则为null 。

getAll

public abstract Set getAll ()

返回可保存在此 Realm 中的所有 RealmObject 类的RealmObjectSchema 。 如果此RealmSchema不可变，则返回一个不可变的RealmObjectSchema集。 否则，它将返回一个可变RealmObjectSchema集。

返回：

此 Realm 中所有类的集合，或者没有 RealmObject 类可以保存在 Realm 中。

getColumnInfo

protected final ColumnInfo getColumnInfo (
String className
)

删除

public abstract void remove (
String className
)

从 Realm 中删除类。 所有数据都将被删除。 当其他类指向一个类时，删除该类会抛出 IllegalStateException 。首先删除这些类或字段。

参数

  • className - 要删除的类的名称。

抛出异常

改名

public abstract RealmObjectSchema rename (
String oldClassName,
String newClassName
)

重命名 Realm 中已有的类。

参数

  • oldClassName — 旧类名。

  • newClassName — 新类名。

返回：

重命名的类的模式对象。

抛出异常

后退

RealmResults

来年

RealmSet