commonMain.io.realm.kotlin.schema.RealmClassKind.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of library-base-jvm Show documentation

Library code for Realm Kotlin. This artifact is not supposed to be consumed directly, but through 'io.realm.kotlin:gradle-plugin:1.11.1' instead.

There is a newer version: 3.0.0

Show newest version

/*
 * Copyright 2023 Realm Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package io.realm.kotlin.schema

/**
 * Enum describing what kind of Realm object it is.
 */
public enum class RealmClassKind {
    /**
     * Standard Realm objects are the default kind of object in Realm, and they extend the
     * [io.realm.kotlin.types.RealmObject] interface.
     */
    STANDARD,
    /**
     * Embedded Realm objects extend the [io.realm.kotlin.types.EmbeddedRealmObject] interface.
     *
     * These kinds of classes must always have exactly one parent object when added to a realm. This
     * means they are deleted when the parent object is delete or the embedded object property is
     * overwritten.
     *
     * See [io.realm.kotlin.types.EmbeddedRealmObject] for more details.
     */
    EMBEDDED,
    /**
     * Asymmetric Realm objects extend the [io.realm.kotlin.types.mongodb.AsymmetricRealmObject] interface.
     *
     * These kind of classes can only be used in a synced realm and are "write-only", i.e. once
     * you written an asymmetric object to a Realm, it is no longer possible access or query them.
     *
     * See [io.realm.kotlin.types.mongodb.AsymmetricRealmObject] for more details.
     */
    ASYMMETRIC
}