SyncQueue (Java Utilities 2.4 API)

java.lang.Object
- net.pwall.util.SyncQueue<T>

```
public class SyncQueue<T>
extends Object
```
Class to represent a synchronized first-in first-out queue. Objects may be added to the end or inserted at the beginning of the queue, and reads will cause the thread to wait until data is available. An optional maximum capacity may be specified; in that case the thread trying to add to the queue will block until space is available.

Author:

Peter Wall

Field Summary

Fields
Modifier and Type Field and Description

static int defaultInitialCapacity

static int defaultMaxLength

Fields
Modifier and Type	Field and Description
`static int`	`defaultInitialCapacity`
`static int`	`defaultMaxLength`

Constructor Summary

Constructors
Constructor and Description
`SyncQueue()` Construct a `SyncQueue` with the default initial capacity.
`SyncQueue(int initialCapacity)` Construct a `SyncQueue` with the specified initial capacity.
`SyncQueue(int initialCapacity, int maxLength)` Construct a `SyncQueue` with the specified initial capacity and maximum size.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`add(T object)` Add an object to the end of the queue and wake up all threads currently waiting for this queue.
`boolean`	`addUnique(T object)` Add an object to the end of the queue and wake up all threads currently waiting for this queue.
`T`	`get()` Get the next object from the queue, blocking if none is available.
`int`	`getMaxLength()` Get the maximum queue length.
`int`	`getSize()` Determine the current length of the queue.
`boolean`	`insert(T object)` Insert an object at the beginning of the queue and wake up all threads currently waiting for this queue.
`boolean`	`insertUnique(T object)` Insert an object at the beginning of the queue and wake up all threads currently waiting for this queue.
`boolean`	`remove(T object)` Remove the specified object from the queue.
`void`	`setMaxLength(int maxLength)` Get the maximum queue length.

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

- Field Detail
  - defaultInitialCapacity
```
public static final int defaultInitialCapacity
```
    See Also:
    
    Constant Field Values
  - defaultMaxLength
```
public static final int defaultMaxLength
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - SyncQueue
```
public SyncQueue(int initialCapacity,
                 int maxLength)
```
    Construct a SyncQueue with the specified initial capacity and maximum size.
    
    Parameters:
    
    initialCapacity - the initial capacity of the queue
    
    maxLength - the maximum length of the queue
  - SyncQueue
```
public SyncQueue(int initialCapacity)
```
    Construct a SyncQueue with the specified initial capacity.
    
    Parameters:
    
    initialCapacity - the initial capacity of the queue
  - SyncQueue
```
public SyncQueue()
```
    Construct a SyncQueue with the default initial capacity.
- Method Detail
  - add
```
public boolean add(T object)
```
    Add an object to the end of the queue and wake up all threads currently waiting for this queue.
    
    Parameters:
    
    object - the object to be added
    
    Returns:
    
    true if the operation was successful
  - addUnique
```
public boolean addUnique(T object)
```
    Add an object to the end of the queue and wake up all threads currently waiting for this queue. If there is already an object in the queue identical to the one supplied, don't add the new one.
    
    Parameters:
    
    object - the object to be added
    
    Returns:
    
    true if the operation was successful
  - insert
```
public boolean insert(T object)
```
    Insert an object at the beginning of the queue and wake up all threads currently waiting for this queue.
    
    Parameters:
    
    object - the object to be added
    
    Returns:
    
    true if the operation was successful
  - insertUnique
```
public boolean insertUnique(T object)
```
    Insert an object at the beginning of the queue and wake up all threads currently waiting for this queue. If there is already an object in the queue identical to the one supplied, delete it first and insert the new one at the start.
    
    Parameters:
    
    object - the object to be added
    
    Returns:
    
    true if the operation was successful
  - remove
```
public boolean remove(T object)
```
    Remove the specified object from the queue.
    
    Parameters:
    
    object - the object to be removed
    
    Returns:
    
    true if the object was removed
  - get
```
public T get()
```
    Get the next object from the queue, blocking if none is available. The method will return null if the thread is interrupted.
    
    Returns:
    
    the next object, or null
  - getSize
```
public int getSize()
```
    Determine the current length of the queue.
    
    Returns:
    
    the number of objects currently in the queue
  - getMaxLength
```
public int getMaxLength()
```
    Get the maximum queue length.
    
    Returns:
    
    the maximum queue length
  - setMaxLength
```
public void setMaxLength(int maxLength)
```
    Get the maximum queue length.
    
    Parameters:
    
    maxLength - the maximum queue length

Class SyncQueue<T>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

defaultInitialCapacity

defaultMaxLength

Constructor Detail

SyncQueue

SyncQueue

SyncQueue

Method Detail

add

addUnique

insert

insertUnique

remove

get

getSize

getMaxLength

setMaxLength