/*
 * Copyright 2014 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;

import io.realm.internal.Row;
import io.realm.annotations.RealmClass;

/**
 * In Realm you define your model classes by subclassing RealmObject and adding fields to be
 * persisted. You then create your objects within a Realm, and use your custom subclasses instead
 * of using the RealmObject class directly.
 * <br>
 * An annotation processor will create a proxy class for your RealmObject subclass. The getters and
 * setters should not contain any custom code of logic as they are overridden as part of the annotation
 * process.
 * <br>
 * @see Realm#createObject(Class)
 */

@RealmClass
public abstract class RealmObject {

    protected Row row;
    protected Realm realm;

    public void removeFromRealm() {
        if (row == null) {
            throw new IllegalStateException("Object malformed: missing Row. Make sure to instantiate RealmObjects with Realm.createObject()");
        }
        if (realm == null) {
            throw new IllegalStateException("Object malformed: missing Realm. Make sure to instantiate RealmObjects with Realm.createObject()");
        }
        row.getTable().remove(row.getIndex());
    }

    protected Realm getRealm() {
        return realm;
    }

    protected void setRealm(Realm realm) {
        this.realm = realm;
    }

    protected Row realmGetRow() {
        return row;
    }

    protected void realmSetRow(Row row) {
        this.row = row;
    }
}

@@ -1284,16 +1284,270 @@
 realm;%0A%0A
+    /**%0A     * Removes the object from the Realm it is currently associated to.%0A     *%0A     * After this method is called the object will be invalid and any operation (read or write)%0A     * performed on it will fail with an IllegalStateException%0A     */%0A
     publ

Add documentation to the deleteFromRealm method