com.hazelcast.map.impl.mapstore.writebehind.WriteBehindQueue Maven / Gradle / Ivy
/*
* Copyright (c) 2008-2016, 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.mapstore.writebehind;
import java.util.Collection;
import java.util.List;
/**
* A specific queue implementation which is used for write-behind-store operations.
* Also supports filtering via {@link #filter(IPredicate, Collection)}
*
* @param the type of element to be stored in this queue.
*/
public interface WriteBehindQueue {
/**
* Inserts collection of elements to the front of this queue.
*
* @param collection collection of elements to be inserted in front of this queue.
*/
void addFirst(Collection collection);
/**
* Inserts to the end of this queue.
*
* @param e element to be offered
*/
void addLast(E e);
/**
* Retrieves, but does not remove, the head of this queue,
* or returns {@code null} if this queue is empty.
*
* @return the head of this queue, or {@code null} if this queue is empty
*/
E peek();
/**
* Removes the first occurrence of the specified element in this queue
* when searching it by starting from the head of this queue.
*
* @param e element to be removed.
* @return true if removed successfully, false otherwise
*/
boolean removeFirstOccurrence(E e);
/**
* Removes all elements from this queue and adds them to the given collection.
*
* @param collection all elements to be added to this collection.
* @return number of removed items from this queue.
*/
int drainTo(Collection collection);
/**
* Checks whether an element exist in this queue.
*
* @param e item to be checked
* @return true if exists, false otherwise
*/
boolean contains(E e);
/**
* Returns the number of elements in this {@link WriteBehindQueue}.
*
* @return the number of elements in this {@link WriteBehindQueue}.
*/
int size();
/**
* Removes all of the elements in this {@link WriteBehindQueue}
* Queue will be empty after this method returns.
*/
void clear();
/**
* Returns a read-only list representation of this queue.
*
* @return read-only list representation of this queue.
*/
List asList();
/**
* Filters this queue according to supplied predicate.
*
* @param predicate used to filter this queue
* @param collection filtered entries will be added to this collection
*/
void filter(IPredicate predicate, Collection collection);
}