QueueItem (org.pipecraft.pipes:pipes-core 0.92 API)

java.lang.Object
- org.pipecraft.pipes.utils.QueueItem<T>

Type Parameters:

T - The wrapped item type
```
public class QueueItem<T>
extends Object
```
A wrapper on queue items. To be used with QueueReaderPipe and QueueWriterPipe.

Author:

Eyal Schneider

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static <T> QueueItem<T>`	`end()`
`static <T> QueueItem<T>`	`error(Throwable e)`
`T`	`getItem()`
`Throwable`	`getThrowable()`
`boolean`	`isEndOfData()`
`boolean`	`isSuccessfulEndOfData()`
`static <T> QueueItem<T>`	`of(T item)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - of
```
public static <T> QueueItem<T> of(T item)
```
    Parameters:
    
    item - The item to wrap
    
    Returns:
    
    The queue item wrapping the given value
  - error
```
public static <T> QueueItem<T> error(Throwable e)
```
    Parameters:
    
    e - The error to wrap
    
    Returns:
    
    A queue item indicating an abnormal termination with the given error
  - end
```
public static <T> QueueItem<T> end()
```
    Returns:
    
    a queue item indicating successful end of data
  - getItem
```
public T getItem()
```
    Returns:
    
    The item to wrap. Null value serves as an end of data marker (successful if and only if throwable parameter is also null)
  - getThrowable
```
public Throwable getThrowable()
```
    Returns:
    
    An error indicating abnormal end of data. Null when the queue item doesn't indicate an error.
  - isEndOfData
```
public boolean isEndOfData()
```
    Returns:
    
    true if and only if the queue item indicates end of data (either successful or with error)
  - isSuccessfulEndOfData
```
public boolean isSuccessfulEndOfData()
```
    Returns:
    
    true if and only if the queue item indicates a successful end of data