desmoj.core.simulator

Class QueueListStandard<E extends Entity>

java.lang.Object

desmoj.core.simulator.QueueList<E>

desmoj.core.simulator.QueueListStandard<E>

All Implemented Interfaces:

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

Direct Known Subclasses:

QueueListFifo, QueueListLifo, QueueListRandom

public abstract class QueueListStandard<E extends Entity>
extends QueueList<E>
implements java.beans.PropertyChangeListener

Is the class summing up all the collective implementation of different queueing strategies for a queue list. 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 e.g. in the classes QueueListFifo and QueueListLifo.

Version:

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

Author:

Justin Neumann, based upon ideas from Tim Lechler, Soenke Claassen, Johannes Göbel 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
QueueListStandard() Constructs an empty QueueList with no reference to its client QueueBased.

Method Summary

Modifier and Type	Method and Description
boolean	contains(E e) Returns true if the given Entity is contained in the list, false otherwise.
E	first() Returns the first entity stored in the list.
int	get(E element) Returns the position of the named Entity.
E	get(int index) Returns the Entity queued at the named position.
java.lang.String	getAbbreviation() Returns an abbreviation as a String to identify the sort of queueing discipline (like FIFO or LIFO or ...).
abstract void	insert(E e) Adds a new Entity to the QueueList.
boolean	isEmpty() Returns true, if no elements are inside the QueueList,false otherwise
E	last() Returns the last Entity stored in the QueueList.
void	propertyChange(java.beans.PropertyChangeEvent evt) This method will be called every time the Stock (the number of available units) has changed.
boolean	remove(E e) Removes the first occurrence of the given Entity from the QueueList.
boolean	remove(int index) Removes the Entity queued at the named position.
E	succ(E e) Returns the successor to the given Entity in the QueueList.
java.lang.String	toString() Returns a string representation of the QueueList.

Methods inherited from class desmoj.core.simulator.QueueList

iterator, setQueueBased, size

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

QueueListStandard

public QueueListStandard()

Constructs an empty QueueList with no reference to its client QueueBased. This no-arg constructor is necessary to instantiate an object of this class by calling the java.lang.Class.newInstance() method. The reference to the QueueBased object making use of this queue-functionality must be provided later by calling the setQueueBased() method. The initial length is always zero.

Method Detail

contains

public boolean contains(E e)

Returns true if the given Entity is contained in the list, false otherwise.

Specified by:

contains in class QueueList<E extends Entity>

Parameters:

e - Entity : The Entity assumed to be in the list

Returns:

boolean : True if the given Entity is contained in the list, false otherwise

first

public E first()

Returns the first entity stored in the list. If the queue is empty, null is returned.

Specified by:

first in class QueueList<E extends Entity>

Returns:

Entity : The first entity in the list or null if list is empty

get

public int get(E element)

Returns the position of the named Entity. The first position is 0, the last one size()-1.

Specified by:

get in class QueueList<E extends Entity>

Returns:

: The position of the Entity or -1 if no such exists.

get

public E get(int index)

Returns the Entity queued at the named position. The first position is 0, the last one size()-1.

Specified by:

get in class QueueList<E extends Entity>

Returns:

Entity : The Entity at the position of int or null if no such position exists.

getAbbreviation

public java.lang.String getAbbreviation()

Returns 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.

Specified by:

getAbbreviation in class QueueList<E extends Entity>

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)

Adds a new Entity to the QueueList. Entities are inserted according to their priority in descending order. The highest priority Entity will always be first in the queue. Entities with same priority are inserted in specified order. Do not forget to call the statisticalInsert() and to set the queue for each entity as you define this method.

Specified by:

insert in class QueueList<E extends Entity>

Parameters:

e - Entity : The Entity to add to the QueueList

isEmpty

public boolean isEmpty()

Returns true, if no elements are inside the QueueList,false otherwise

Specified by:

isEmpty in class QueueList<E extends Entity>

Returns:

boolean : true, if no elements are inside the QueueList, false otherwise

last

public E last()

Returns the last Entity stored in the QueueList. If the QueueList is empty, null is returned.

Specified by:

last in class QueueList<E extends Entity>

Returns:

Entity : The last Entity in the list or null if QueueList is empty

propertyChange

public void propertyChange(java.beans.PropertyChangeEvent evt)

This method will be called every time the Stock (the number of available units) has changed.

Specified by:

propertyChange in interface java.beans.PropertyChangeListener

Parameters:

evt - java.beans.PropertyChangeEvent : The event specifying the property that has changed ans its old and new value.

remove

public boolean remove(E e)

Removes the first occurrence of the given Entity from the QueueList. Checks if the given Entity to be removed does apply to all restrictions on this operation. These are :

• The given reference to an entity must not be null
• This QueueList must not be empty, otherwise there's nothing to remove
If all these restrictions apply, true is returned and the Entity is removed, otherwise false is the return value because the given Entity could not be removed since one of the restrictions above was not met.

Specified by:

remove in class QueueList<E extends Entity>

Parameters:

e - Entity : The Entity to be removed from the QueueList

Returns:

boolean : Is true if the given Entity is contained in the QueueList, false otherwise

remove

public boolean remove(int index)

Removes the Entity queued at the named position. The first position is 0, the last one size()-1.

Specified by:

remove in class QueueList<E extends Entity>

Returns:

: The method returns true as the Entity was deleted or false> if otherwise.

succ

public E succ(E e)

Returns the successor to the given Entity in the QueueList. If there is no successor or no Entity in the QueueList, null is returned.

Specified by:

succ in class QueueList<E extends Entity>

Parameters:

e - Entity : The Entity contained in the QueueList

Returns:

Entity : The Entity before the given parameter in the QueueList or null if the given Entity parameter 'e' has no successor in the QueueList or e itself is not contained in the QueueList

toString

public java.lang.String toString()

Returns a string representation of the QueueList. The string is built by concatenating all string representations of the contained entities, calling their toString() methods.

Specified by:

toString in class QueueList<E extends Entity>

Returns:

java.lang.String : The string representation of the QueueList