DataStoreObserver.java

/*
 * Copyright 2015 Petr Bouda
 *
 * 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 org.joyrest.examples.combiner.store;

import java.io.Serializable;
import java.util.Collection;

/**
 * Instances of this interface are able to receive the notification from {@link org.joyrest.examples.combiner.store
 * .ObservableDataStore}.
 *
 * @author Petr Bouda
 **/
public interface DataStoreObserver {

    /**
     * Method updates an inner state of an instance of this interface using a provided saved entity.
     *
     * @param entity newly saved entity
     **/
    void save(Serializable entity);

    /**
     * Method updates an inner state of an instance of this interface using a provided collection of saved entities.
     *
     * @param entities list of newly saved entities
     **/
    void saveAll(Collection<Serializable> entities);

    /**
     * Method updates an inner state of an instance of this interface using a provided key of the removed entity.
     *
     * @param key removed entity
     **/
    void remove(String key);

    /**
     * Method updates an inner state of an instance of this interface using a provided collection of keys of the removed entities.
     *
     * @param keys collection of removed entities
     **/
    void removeAll(Collection<String> keys);
}