Pipe (Hazelcast Root 3.9 API)

Type Parameters:

E - type of items in the pipe.

All Known Subinterfaces:

QueuedPipe<E>

All Known Implementing Classes:

ManyToOneConcurrentArrayQueue, OneToOneConcurrentArrayQueue
```
public interface Pipe<E>
```
A container of items processed in sequence. The point of this interface to be a mix-in to the API of JDK's standard Queue adding methods that make sense for a queue which is concurrent, bounded, and supports draining in batches.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`long`	`addedCount()` Returns the number of items added to this pipe since creation.
`int`	`capacity()` Returns the number of items this pipe can hold at a time.
`int`	`drain(Predicate<? super E> itemHandler)` Drains the items available in the pipe to the supplied item handler.
`int`	`drainTo(Collection<? super E> target, int limit)` Drains at most `limit` available items into the provided `Collection`.
`int`	`remainingCapacity()` Returns the number of items this pipe has still room for.
`long`	`removedCount()` Returns the number of items removed from this pipe since creation.

- Method Detail
  - addedCount
```
long addedCount()
```
    Returns the number of items added to this pipe since creation.
  - removedCount
```
long removedCount()
```
    Returns the number of items removed from this pipe since creation.
  - capacity
```
int capacity()
```
    Returns the number of items this pipe can hold at a time.
  - remainingCapacity
```
int remainingCapacity()
```
    Returns the number of items this pipe has still room for.
  - drain
```
int drain(Predicate<? super E> itemHandler)
```
    Drains the items available in the pipe to the supplied item handler. The handler returns a boolean which decides whether to continue draining. If it returns false, this method refrains from draining further items and returns.
    Implementation note: this method is expected to take advantage of the fact that many items are being drained at once and minimize the per-item cost of housekeeping.
    
    Parameters:
    
    itemHandler - the item handler
    
    Returns:
    
    the number of drained items
  - drainTo
```
int drainTo(Collection<? super E> target,
            int limit)
```
    Drains at most limit available items into the provided Collection.
    Implementation note: this method is expected to take advantage of the fact that many items are being drained at once and minimize the per-item cost of housekeeping.
    
    Parameters:
    
    target - destination for the drained items
    
    limit - the maximum number of items to drain
    
    Returns:
    
    the number of drained items

Interface Pipe<E>

Method Summary

Method Detail

addedCount

removedCount

capacity

remainingCapacity

drain

drainTo