Package com.alachisoft.ncache.client.datastructures

Interface DistributedQueue<T>

Type Parameters:

T - The type of elements in the Queue.

All Superinterfaces:

java.util.Collection<T>, DistributedDataStructure, java.lang.Iterable<T>, Lockable, Notifiable, java.util.Queue<T>

public interface DistributedQueue<T>
extends java.util.Queue<T>, DistributedDataStructure, Notifiable

This interface contains methods and parameters for Distrubited Queue.

Method Summary

Modifier and Type	Method	Description
void	clear()	Removes all the elements from this collection (optional operation).
void	copyTo(T[] array, int arrayIndex)	Copies the Queue elements to the specified array, starting at the specified index.
T	peek()	Returns the object at the beginning of the Queue without removing it.
java.lang.Object[]	toArray()	Copies the Queue elements to a new array.

Methods inherited from interface java.util.Collection

addAll, contains, containsAll, equals, hashCode, isEmpty, iterator, parallelStream, remove, removeAll, removeIf, retainAll, size, spliterator, stream, toArray

Methods inherited from interface com.alachisoft.ncache.client.datastructures.DistributedDataStructure

getKey, getWriteThruOptions, setWriteThruOptions

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface com.alachisoft.ncache.client.datastructures.Lockable

lock, unlock

Methods inherited from interface com.alachisoft.ncache.client.datastructures.Notifiable

addChangeListener, removeChangeListener

Methods inherited from interface java.util.Queue

add, element, offer, poll, remove

Method Detail

clear

void clear()

Removes all the elements from this collection (optional operation). The collection will be empty after this method returns.

Specified by:

clear in interface java.util.Collection<T>

Throws:

java.lang.UnsupportedOperationException - if the clear operation is not supported by this collection.

copyTo

void copyTo(T[] array,
            int arrayIndex)

Copies the Queue elements to the specified array, starting at the specified index.

Parameters:

array - The destination array of the elements copied from Queue.

arrayIndex - The zero-based index in array at which copying begins.

peek

T peek()

Returns the object at the beginning of the Queue without removing it.

Specified by:

peek in interface java.util.Queue<T>

Returns:

The object at the beginning of the Queue.

toArray

java.lang.Object[] toArray()

Copies the Queue elements to a new array.

Specified by:

toArray in interface java.util.Collection<T>

Returns:

A new array containing elements copied from the Queue.