パッケージ io.realm.annotations

注釈型プライマリキー

@Retention(RUNTIME)
@Target(FIELD)
public @interface PrimaryKey

@PrimaryKey 注釈により、Realm 内のフィールドがプライマリキーとしてマークされます。 RealmObject クラスの 1 つのフィールドのみがこの注釈を持つことができ、フィールドはオブジェクトを一意に識別する必要があります。 既存のプライマリキーを持つオブジェクトを挿入しようとすると、 io.realm.exceptions.RealmPrimaryKeyConstraintExceptionが返されます。 オブジェクトが作成された後は、プライマリキーを変更できません。

プライマリキーもIndex注釈を持つものとしてカウントされます。

この注釈は、バイト、短い、int、long 型のプリミティブ型に適用できます。 string、Byte、短縮、整数、long、ObjectId、UUID も許可され、さらにnullをプライマリキー値として持つことも許可されます。

この注釈は、 \@RealmClass(embedded = true)としてマークされた Realm クラス内では許可されません。