Fifo (SAFS API DOCUMENT)

java.lang.Object
- org.safs.staf.service.queue.Fifo<T>

Type Parameters:

T -
```
public class Fifo<T>
extends java.lang.Object
```
History:

Jul 18, 2014 (Lei Wang) Initial release.

Field Summary

Fields
Modifier and Type	Field and Description
`static boolean`	`DEBUG_ENABLE`
`static int`	`DEFAULT_MAX_SIZE` '10000' The default maximum size of this FIFO
`protected int`	`maxSize`
`static int`	`TIMEOUT_NO_WAIT` The constant of timeout, which means don't wait if FIFO is empty
`static int`	`TIMEOUT_WAIT_FOREVER` The constant of timeout, which means wait for ever if FIFO is empty

Constructor Summary

Constructors
Constructor and Description

Fifo()

Constructors
Constructor and Description
`Fifo()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`clear()`
`void`	`in(T object)` Put an object into the FIFO if the FIFO is not full.
`T`	`out(int timeout)` Get an object from the FIFO if it is not empty. If the FIFO is empty, this method may throw an Exception or wait for a certain-time or wait for ever, which depends on the timeout value.
`void`	`setMaxSize(int maxSize)` Set the maximum size of this FIFO, the default maximum size is `DEFAULT_MAX_SIZE`

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

- Field Detail
  - DEFAULT_MAX_SIZE
```
public static final int DEFAULT_MAX_SIZE
```
    '10000' The default maximum size of this FIFO
    
    See Also:
    
    Constant Field Values
  - TIMEOUT_NO_WAIT
```
public static final int TIMEOUT_NO_WAIT
```
    The constant of timeout, which means don't wait if FIFO is empty
    
    See Also:
    
    Constant Field Values
  - TIMEOUT_WAIT_FOREVER
```
public static final int TIMEOUT_WAIT_FOREVER
```
    The constant of timeout, which means wait for ever if FIFO is empty
    
    See Also:
    
    Constant Field Values
  - maxSize
```
protected int maxSize
```
  - DEBUG_ENABLE
```
public static boolean DEBUG_ENABLE
```
- Constructor Detail
  - Fifo
```
public Fifo()
```
- Method Detail
  - in
```
public void in(T object)
        throws SAFSException
```
    Put an object into the FIFO if the FIFO is not full.
    
    Parameters:
    
    object - T, the object to put into the FIFO
    
    Throws:
    
    SAFSException - if the FIFO is full
  - out
```
public T out(int timeout)
      throws SAFSException
```
    Get an object from the FIFO if it is not empty.
    If the FIFO is empty, this method may throw an Exception or wait for a certain-time or wait for ever, which
    depends on the timeout value.
    
    Parameters:
    
    timeout - int, the time to wait for FIFO is not empty, in milliseconds
    it can be TIMEOUT_NO_WAIT, this method will throw Exception if FIFO is empty. it can be TIMEOUT_WAIT_FOREVER, this method will wait for ever until the FIFO is not empty.
    
    Returns:
    
    T the first object got from FIFO
    
    Throws:
    
    SAFSException
  - setMaxSize
```
public void setMaxSize(int maxSize)
```
    Set the maximum size of this FIFO, the default maximum size is DEFAULT_MAX_SIZE
    
    Parameters:
    
    maxSize -
  - clear
```
public void clear()
```

Class Fifo<T>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_MAX_SIZE

TIMEOUT_NO_WAIT

TIMEOUT_WAIT_FOREVER

maxSize

DEBUG_ENABLE

Constructor Detail

Fifo

Method Detail

in

out

setMaxSize

clear