Docs Menu
Docs Home
/
MongoDB Atlas
/
Atlas Device SDK
/
Java SDK
/
API リファレンス
/
io.realm

クラス RealmSchema

項目一覧

  • io.realm
  • メソッドの概要
  • 継承されたメソッド
  • メソッドの詳細
  • に含まれる
  • create
  • createKeyPathMapping
  • createWithPrimaryKeyField
  • 得る
  • getAll
  • getDocumentInfo
  • delete
  • rename

io.realm

java.lang.Object
io.realm.RealmSchema

Realm スキーマを操作するためのクラス。 これにより、Realm.:ref: Realm.getSchema() <io_realm_Realm_getSchema__>内のクラスを検査、追加、削除、変更することができます。 は、検査目的でのみ使用できる不変のRealmSchemaを返します。 変更可能なスキーマを取得するには、 DescribeRealm.getSchema()を使用します。

すべての変更は、特定の Realm の書込みトランザクション (write transaction) 内で行われる必要があります。

Tip

以下も参照してください。

  • 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を返します。

保護された最終列Info
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

メソッドの詳細

に含まれる

public boolean contains (
String className
)

指定されたクラスがすでにスキーマに存在するかどうかを確認します。

パラメーター

  • className - 確認するクラス名。

戻り値

true クラスがすでに存在する場合。 それ以外の場合は、 false 。

create

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.プライマリ_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 内のすべてのクラスのセット、または Realm に保存できる RealmObject クラスはありません。

getDocumentInfo

protected final ColumnInfo getColumnInfo (
String className
)

delete

public abstract void remove (
String className
)

Realm からクラスを削除します。 すべてのデータが削除されます。 他のクラスがそのクラスを指している間にクラスを削除すると、 IllgealStateException がスローされます 。これらのクラスまたはフィールドは最初に削除されます。

パラメーター

  • className - 削除するクラスの名前。

スロー

rename

public abstract RealmObjectSchema rename (
String oldClassName,
String newClassName
)

Realm 内のすでに存在するクラスの名前を変更します。

パラメーター

  • oldClassName - 古いクラス名。

  • newClassName - 新しいクラス名。

戻り値

名前が変更されたクラスのスキーマ オブジェクト。

スロー

戻る

RealmResults

次へ

RealmSet