ObservableDataStore.java

/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 2015 Oracle and/or its affiliates. All rights reserved.
 *
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common Development
 * and Distribution License("CDDL") (collectively, the "License").  You
 * may not use this file except in compliance with the License.  You can
 * obtain a copy of the License at
 * http://glassfish.java.net/public/CDDL+GPL_1_1.html
 * or packager/legal/LICENSE.txt.  See the License for the specific
 * language governing permissions and limitations under the License.
 *
 * When distributing the software, include this License Header Notice in each
 * file and include the License file at packager/legal/LICENSE.txt.
 *
 * GPL Classpath Exception:
 * Oracle designates this particular file as subject to the "Classpath"
 * exception as provided by Oracle in the GPL Version 2 section of the License
 * file that accompanied this code.
 *
 * Modifications:
 * If applicable, add the following below the License Header, with the fields
 * enclosed by brackets [] replaced by your own identifying information:
 * "Portions Copyright [year] [name of copyright owner]"
 *
 * Contributor(s):
 * If you wish your version of this file to be governed by only the CDDL or
 * only the GPL Version 2, indicate your decision by adding "[Contributor]
 * elects to include this software in this distribution under the [CDDL or GPL
 * Version 2] license."  If you don't indicate a single choice of license, a
 * recipient has the option to distribute your version of this file under
 * either the CDDL, the GPL Version 2 or to extend the choice of license to
 * its licensees as provided above.  However, if you add GPL Version 2 code
 * and therefore, elected the GPL Version 2 license, then the option applies
 * only if the new code is made subject to such option by the copyright
 * holder.
 */

package org.glassfish.jersey.examples.feedcombiner.store;

/**
 * A Datastore which implements this interface is able to notify all
 * {@link DataStoreObserver observers} and react to an adding or a removing
 * entities.
 * <p>
 * The order in which notifications will be delivered to multiple
 * observers is not specified.
 * </p>
 *
 * @author Petr Bouda (petr.bouda at oracle.com)
 */
public interface ObservableDataStore extends InMemoryDataStore {

    /**
     * Adds an {@link DataStoreObserver observer}
     * to the set of observers for this observable object
     * {@link ObservableDataStore}.
     *
     * @param observer an observer to be added.
     * @throws NullPointerException if the parameter o is null.
     */
    void addObserver(DataStoreObserver observer);

    /**
     * Deletes an {@link DataStoreObserver observer}
     * from the set of observers of this object.
     * <p/>
     * Passing {@code null} to this method will have no effect.
     *
     * @param observer the observer to be deleted.
     */
    void deleteObserver(DataStoreObserver observer);

}