QueueList (DESMO-J 2.5.1c API)

java.lang.Object
- desmoj.core.simulator.QueueList<E>

All Implemented Interfaces:

java.beans.PropertyChangeListener, java.lang.Iterable<E>, java.util.EventListener

Direct Known Subclasses:

QueueListStandard
```
public abstract class QueueList<E extends Entity>
extends java.lang.Object
implements java.beans.PropertyChangeListener, java.lang.Iterable<E>
```
Is the abstract superclass for all the classes implementing different queueing strategies for a waiting-queue. It provides all the basic methods for inserting objects in a queue, retrieving objects from a queue and getting basic informations about the queue. It is used in many kinds of queue implementations where collective functionalities are implemented by QueueListStandard and are specified e.g. in QueueListFifo or QueueListLifo.

Version:

DESMO-J, Ver. 2.5.1c copyright (c) 2015

Author:

Soenke Claassen, based upon ideas from Tim Lechler Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

See Also:

QueueBased, Queue, ProcessQueue, QueueListFifo, QueueListLifo

Constructor Summary

Constructors
Constructor and Description

QueueList()

Constructors
Constructor and Description
`QueueList()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`abstract boolean`	`contains(E e)` Should return `true` if the given `Entity` is contained in the queue; `false` otherwise.
`abstract E`	`first()` Should return the first entity in the queue.
`abstract int`	`get(E element)` Returns the position of the named `Entity`.
`abstract E`	`get(int index)` Returns the `Entity` queued at the named position.
`abstract java.lang.String`	`getAbbreviation()` Should return an abbreviation as a String to identify the sort of queueing discipline (like FIFO or LIFO or ...).
`abstract void`	`insert(E e)` Should add a new Entity to the queue.
`abstract boolean`	`isEmpty()` Should return `true` if no entities are stored in the queue at the moment, `false` otherwise.
`java.util.Iterator<E>`	`iterator()` Returns an iterator over the entities enqueued.
`abstract E`	`last()` Should return the last `Entity` in the queue.
`abstract boolean`	`remove(E e)` Should remove the given `Entity` "e" from the queue.
`abstract boolean`	`remove(int index)` Removes the `Entity` queued at the named position
`void`	`setQueueBased(QueueBased queueBase)` Sets the client queue for which the entities are stored.
`int`	`size()` Returns the actual size of the QueueList.
`abstract E`	`succ(E e)` Should return the successor of the given `Entity` "e" in the queue.
`abstract java.lang.String`	`toString()` Should return a string representation of the queue.

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

Methods inherited from interface java.beans.PropertyChangeListener
propertyChange

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Constructor Detail
  - QueueList
```
public QueueList()
```
- Method Detail
  - contains
```
public abstract boolean contains(E e)
```
    Should return true if the given Entity is contained in the queue; false otherwise.
    
    Parameters:
    
    e - E : The Entity we are looking for in the queue.
    
    Returns:
    
    boolean : Should be true if the given Entity is contained in the queue; false otherwise.
  - first
```
public abstract E first()
```
    Should return the first entity in the queue.
    
    Returns:
    
    E : The first entity in the queue
  - get
```
public abstract E get(int index)
```
    Returns the Entity queued at the named position. The first position is 0, the last one size()-1.
    
    Returns:
    
    E : The Entity at the position of int or null if no such position exists.
  - get
```
public abstract int get(E element)
```
    Returns the position of the named Entity. The first position is 0, the last one size()-1.
    
    Returns:
    
    : The position of the Entity or -1 if no such exists.
  - getAbbreviation
```
public abstract java.lang.String getAbbreviation()
```
    Should return an abbreviation as a String to identify the sort of queueing discipline (like FIFO or LIFO or ...). Is used to display the queueing discipline in the report of the QueueBased objects.
    
    Returns:
    
    java.lang.String : An abbreviation to identify the sort of queueing discipline (like FIFO or LIFO or ...)
  - insert
```
public abstract void insert(E e)
```
    Should add a new Entity to the queue.
    
    Parameters:
    
    e - E : The Entity which will be added to the queue
  - isEmpty
```
public abstract boolean isEmpty()
```
    Should return true if no entities are stored in the queue at the moment, false otherwise.
    
    Returns:
    
    boolean : Is true if no entities are stored in the queue at the moment, false otherwise.
  - last
```
public abstract E last()
```
    Should return the last Entity in the queue.
    
    Returns:
    
    E : The last Entity in the queue.
  - remove
```
public abstract boolean remove(E e)
```
    Should remove the given Entity "e" from the queue. If this is done successfully true is returned, false otherwise.
    
    Parameters:
    
    e - E : The Entity which is to be removed from the queue.
    
    Returns:
    
    boolean : Is true if the given Entity is removed successfully, false otherwise.
  - remove
```
public abstract boolean remove(int index)
```
    Removes the Entity queued at the named position. * The first position is 0, the last one size()-1.
    
    Returns:
    
    : The method returns true as the Entity exists or false> if otherwise.
  - setQueueBased
```
public void setQueueBased(QueueBased queueBase)
```
    Sets the client queue for which the entities are stored. Is needed, because this can not be done in the no-arg constructor.
    
    Parameters:
    
    queueBase - desmoj.QueueBased : The QueueBased using this queueing system.
  - size
```
public int size()
```
    Returns the actual size of the QueueList.
    
    Returns:
    
    : The method returns the size as an int. The value is 0 if no Entity is in line.
  - succ
```
public abstract E succ(E e)
```
    Should return the successor of the given Entity "e" in the queue.
    
    Parameters:
    
    e - E : The successor of this Entity will be returned.
    
    Returns:
    
    E : The Entity after the given Entity "e" in the queue.
  - toString
```
public abstract java.lang.String toString()
```
    Should return a string representation of the queue.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    String : The string representation of the queue.
  - iterator
```
public java.util.Iterator<E> iterator()
```
    Returns an iterator over the entities enqueued.
    
    Specified by:
    
    iterator in interface java.lang.Iterable<E extends Entity>
    
    Returns:
    
    java.lang.Iterator<E> : An iterator over the entities enqueued.

Class QueueList<E extends Entity>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.beans.PropertyChangeListener

Methods inherited from interface java.lang.Iterable

Constructor Detail

QueueList

Method Detail

contains

first

get

get

getAbbreviation

insert

isEmpty

last

remove

remove

setQueueBased

size

succ

toString

iterator