Queue (MultiLayerAlignment)

All Known Implementing Classes:

HashBackedPriorityQueue, SortedHashBackedPriorityQueue
```
public interface Queue
```

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`boolean`	`add(int marking)` add a new marking to the queue.
`boolean`	`checkInv()` Debugging method that checks the queue invariant on the queue
`boolean`	`contains(int markingId)` Checks if the the stored marking with ID markingId is contained in this queue.
`ReplayAlgorithm`	`getAlgorithm()` Return the algorithm for which this Queue is used.
`long`	`getEstimatedMemorySize()` returns the maximum memory use in bytes the queue ever had.
`boolean`	`isEmpty()` returns true if the queue is empty
`int`	`maxCapacity()` returns the maximum memory capacity the queue ever had.
`int`	`maxSize()` returns maximum number of elements the queue ever contained.
`int`	`peek()` Show the number of the marking at the head of the priority queue
`int`	`poll()` remove and return the head of the queue
`int`	`size()` Returns the current number of elements in the queue

- Method Detail
  - getAlgorithm
```
ReplayAlgorithm getAlgorithm()
```
    Return the algorithm for which this Queue is used.
    
    Returns:
  - peek
```
int peek()
```
    Show the number of the marking at the head of the priority queue
    
    Returns:
  - poll
```
int poll()
```
    remove and return the head of the queue
    
    Returns:
  - add
```
boolean add(int marking)
```
    add a new marking to the queue. If it exists and the new score is better, update the score.
    
    Parameters:
    
    marking -
    
    Returns:
    
    true if the marking was added to the priority queue
  - isEmpty
```
boolean isEmpty()
```
    returns true if the queue is empty
    
    Returns:
  - getEstimatedMemorySize
```
long getEstimatedMemorySize()
```
    returns the maximum memory use in bytes the queue ever had.
    
    Returns:
  - maxCapacity
```
int maxCapacity()
```
    returns the maximum memory capacity the queue ever had.
    
    Returns:
  - maxSize
```
int maxSize()
```
    returns maximum number of elements the queue ever contained.
    
    Returns:
  - size
```
int size()
```
    Returns the current number of elements in the queue
    
    Returns:
  - contains
```
boolean contains(int markingId)
```
    Checks if the the stored marking with ID markingId is contained in this queue.
    
    Parameters:
    
    markingId -
    
    Returns:
    
    true if the given marking is in the queue
  - checkInv
```
boolean checkInv()
```
    Debugging method that checks the queue invariant on the queue
    
    Returns:

Interface Queue

Method Summary

Method Detail

getAlgorithm

peek

poll

add

isEmpty

getEstimatedMemorySize

maxCapacity

maxSize

size

contains

checkInv