grails.gorm.rx.PersistentObservable Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of grails-datastore-gorm-rx Show documentation

GORM - Grails Data Access Framework

The newest version!

package grails.gorm.rx;

import rx.Observable;
import rx.Subscriber;
import rx.Subscription;

/**
 * Common interface for persistent related observables to implement such as collections and proxies
 *
 * @since 6.0
 * @author Graeme Rocher
 */
public interface PersistentObservable {

    /**
     * Returns an Observable for the operation
     *
     * For more information on Observables see the
     * ReactiveX documentation.
     *
     *
     * @return the Observable for the operation
     */
    Observable toObservable();

    /**
     * A convenience method that subscribes to the Observable as provided by {@link #toObservable}.
     *
     * 
     * For more information on Subscriptions see the
     * ReactiveX documentation.
     *
     *
     * @param subscriber the Subscriber that will handle emissions and notifications from the Observable
     * @return a Subscription reference with which Subscribers that are Observers can
     *         unsubscribe from the Observable
     */
    Subscription subscribe(Subscriber subscriber);
}