com.hazelcast.map.impl.querycache.subscriber.InternalQueryCache Maven / Gradle / Ivy

/*
 * Copyright (c) 2008-2018, Hazelcast, Inc. All Rights Reserved.
 *
 * 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 com.hazelcast.map.impl.querycache.subscriber;

import com.hazelcast.core.EntryEventType;
import com.hazelcast.core.IMap;
import com.hazelcast.map.QueryCache;
import com.hazelcast.query.impl.Indexes;

/**
 * Internal interface which adds some internally used methods
 * to {@code QueryCache} interface.
 *
 * @param  the key type for this {@code QueryCache}
 * @param  the value type for this {@code QueryCache}
 */
public interface InternalQueryCache extends QueryCache {

    void setInternal(K key, V value, boolean callDelegate, EntryEventType eventType);

    void deleteInternal(Object key, boolean callDelegate, EntryEventType eventType);

    /**
     * Scans all entries in this {@link QueryCache} to remove matching ones
     * with supplied {@code partitionId}
     *
     * @return number of entries removed
     */
    int removeEntriesOf(int partitionId);

    IMap getDelegate();

    Indexes getIndexes();

    void clear();

    void setPublisherListenerId(String publisherListenerId);

    /**
     * @return internally used ID for this query cache
     */
    String getCacheId();
}