org.javades.jqueues.r5.extensions.qos

Interface SimQueueQoS<J extends SimJob,Q extends SimQueueQoS,P>

Type Parameters:

J - The type of SimJobs supported.

Q - The type of SimQueues supported.

P - The type used for QoS.

All Superinterfaces:

SimEntity, org.javades.jsimulation.r5.SimEventListResetListener, SimQoS<J,Q>, SimQueue<J,Q>, SimQueueOrJobQoS<J,Q,P>

All Known Implementing Classes:

AbstractPreemptiveSimQueueQoS, AbstractSimQueueQoS, HOL, HOL_PS, PQ

public interface SimQueueQoS<J extends SimJob,Q extends SimQueueQoS,P>
extends SimQueueOrJobQoS<J,Q,P>, SimQueue<J,Q>

A SimQueue with explicit QoS support.

Author:

Jan de Jongh, TNO

Copyright (C) 2005-2017 Jan de Jongh, TNO

This file is covered by the LICENSE file in the root of this project.

Nested Class Summary

Nested classes/interfaces inherited from interface org.javades.jqueues.r5.entity.jq.queue.SimQueue

SimQueue.AutoRevocationPolicy

Nested classes/interfaces inherited from interface org.javades.jqueues.r5.entity.SimEntity

SimEntity.Action, SimEntity.UnknownNotificationTypePolicy, SimEntity.UnknownOperationPolicy

Method Summary

Modifier and Type	Method and Description
SimQueueQoS<J,Q,P>	getCopySimQueue() Overridden in order to restrict the return type.
P	getDefaultJobQoS() Gets the default QoS value used by this queue for jobs that have null QoS value.
Map<P,Set<J>>	getJobsQoSMap() Gets the mapping QoS values onto jobs currently visiting this queue with that particular QoS value.

Methods inherited from interface org.javades.jqueues.r5.extensions.qos.SimQueueOrJobQoS

getQoS, getQoSClass, setQoS, setQoSClass

Methods inherited from interface org.javades.jqueues.r5.entity.jq.queue.SimQueue

arrive, getAutoRevocationPolicy, getJobs, getJobsInServiceArea, getJobsInWaitingArea, getNumberOfJobs, getNumberOfJobsInServiceArea, getNumberOfJobsInWaitingArea, getServerAccessCredits, isJob, isJobInServiceArea, isJobInWaitingArea, isQueueAccessVacation, isStartArmed, revoke, revoke, setAutoRevocationPolicy, setQueueAccessVacation, setServerAccessCredits

Methods inherited from interface org.javades.jqueues.r5.entity.SimEntity

doAfterNotifications, doOperation, getEventList, getLastUpdateTime, getRegisteredNotificationTypes, getRegisteredOperations, getSimEntityListeners, getUnknownNotificationTypePolicy, getUnknownOperationPolicy, isIgnoreEventListReset, registerSimEntityListener, resetEntity, setIgnoreEventListReset, setName, setUnknownNotificationTypePolicy, setUnknownOperationPolicy, toStringDefault, unregisterSimEntityListener, update

Methods inherited from interface org.javades.jsimulation.r5.SimEventListResetListener

notifyEventListReset

Method Detail

getCopySimQueue

SimQueueQoS<J,Q,P> getCopySimQueue()
                            throws UnsupportedOperationException

Overridden in order to restrict the return type. Creates a functional copy of this SimQueue.

The new object has the same (concrete) type as the original, but starts without jobs and without external listeners. Its initial state must be as if SimEntity.resetEntity() was invoked on the queue.

Note that the semantics of this method are much less strict than the Object.clone () method. Typically, concrete classes will implement this by returning a new SimQueue object. This way, we circumvent the problem of cloning objects with final (for good reasons) fields.

Specified by:

getCopySimQueue in interface SimQueue<J extends SimJob,Q extends SimQueueQoS>

Returns:

A functional copy of this SimQueue.

Throws:

UnsupportedOperationException - If the operation is not supported (yet); this should be considered a software error.

getJobsQoSMap

Map<P,Set<J>> getJobsQoSMap()

Gets the mapping QoS values onto jobs currently visiting this queue with that particular QoS value.

Each SimJob present returning (valid) non-null QoS value from SimQoS.getQoS() must be in present in only that value set, and the union of these value sets must exactly match SimQueue.getJobs(). Jobs returning null from SimQoS.getQoS() must be put in a value set corresponding to getDefaultJobQoS().

Note that many concrete subclasses will impose an ordering on the keys and/or on the value sets.

Returns:

The mapping QoS values onto jobs currently visiting this queue with that particular QoS value.

See Also:

SimQueue.getJobs(), SimQoS.getQoS(), getDefaultJobQoS()

getDefaultJobQoS

P getDefaultJobQoS()

Gets the default QoS value used by this queue for jobs that have null QoS value.

Returns:

The default QoS value used by this queue for jobs that have null QoS value.

See Also:

SimQoS.getQoS()