org.javades.jqueues.r5.entity.jq.queue.composite.collector

Class DropCol<DJ extends AbstractSimJob,DQ extends SimQueue,J extends SimJob,Q extends DropCol>

java.lang.Object

org.javades.jqueues.r5.entity.AbstractSimEntity

org.javades.jqueues.r5.entity.jq.AbstractSimJQ<J,Q>

org.javades.jqueues.r5.entity.jq.queue.AbstractSimQueue<J,Q>

org.javades.jqueues.r5.entity.jq.queue.composite.AbstractSimQueueComposite<DJ,DQ,J,Q>

org.javades.jqueues.r5.entity.jq.queue.composite.AbstractSimQueueComposite_LocalStart<DJ,DQ,J,Q>

org.javades.jqueues.r5.entity.jq.queue.composite.collector.AbstractCollectorSimQueue<DJ,DQ,J,Q>

org.javades.jqueues.r5.entity.jq.queue.composite.collector.DropCol<DJ,DQ,J,Q>

Type Parameters:

DJ - The delegate-job type.

DQ - The queue-type for delegate jobs.

J - The job type.

Q - The queue type for jobs.

All Implemented Interfaces:

SimQueueComposite<DJ,DQ,J,Q>, SimQueueSelector<J,DQ>, SimQueue<J,Q>, SimQoS<J,Q>, SimEntity, SimEntityListener, org.javades.jsimulation.r5.SimEventListResetListener

public class DropCol<DJ extends AbstractSimJob,DQ extends SimQueue,J extends SimJob,Q extends DropCol>
extends AbstractCollectorSimQueue<DJ,DQ,J,Q>

A composite queue with two queues, a main one and one collecting all dropped jobs from the main queue.

The main and drop arguments may be equal.

This queue uses the LocalStart model as explained with AbstractSimQueueComposite_LocalStart.

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 class org.javades.jqueues.r5.entity.jq.queue.composite.AbstractSimQueueComposite

AbstractSimQueueComposite.RealDelegateJobMapper<J extends SimJob,DJ extends SimJob>

Nested classes/interfaces inherited from class org.javades.jqueues.r5.entity.AbstractSimEntity

AbstractSimEntity.Notifier, AbstractSimEntity.PreNotificationHook

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

Field Summary

Fields inherited from class org.javades.jqueues.r5.entity.jq.queue.composite.AbstractSimQueueComposite

realDelegateJobMapper

Fields inherited from class org.javades.jqueues.r5.entity.jq.queue.AbstractSimQueue

eventsScheduled, SANITY

Fields inherited from class org.javades.jqueues.r5.entity.AbstractSimEntity

USE_ARRAY_OPTIMIZATION

Constructor Summary

Constructors

Constructor and Description
DropCol(org.javades.jsimulation.r5.SimEventList eventList, SimQueue<DJ,DQ> mainQueue, SimQueue<DJ,DQ> dropQueue, DelegateSimJobFactory delegateSimJobFactory) Creates a drop-collector queue given an event list, a main queue and a drop (collector) queue.

Method Summary

Modifier and Type	Method and Description
DropCol<DJ,DQ,J,Q>	getCopySimQueue() Returns a new DropCol object on the same SimEventList with copies of the main and drop queues and the same delegate-job factory.
protected DQ	getDropQueue() Returns the drop (second, last) queue.
String	toStringDefault() Returns "DropCol[mainQueue->dropQueue]".

Methods inherited from class org.javades.jqueues.r5.entity.jq.queue.composite.collector.AbstractCollectorSimQueue

getCollectorQueue, getMainQueue, isCollectAutoRevocations, isCollectDepartures, isCollectDrops, processSubQueueNotifications, resetEntitySubClass

Methods inherited from class org.javades.jqueues.r5.entity.jq.queue.composite.AbstractSimQueueComposite_LocalStart

getQoS, getQoSClass, getServiceTimeForJob, insertJobInQueueUponArrival, insertJobInQueueUponStart, isStartArmed, queueAccessVacationDropSubClass, removeJobFromQueueUponDeparture, removeJobFromQueueUponDrop, removeJobFromQueueUponRevokation, rescheduleAfterArrival, rescheduleAfterDeparture, rescheduleAfterDrop, rescheduleAfterRevokation, rescheduleAfterStart, rescheduleForNewServerAccessCredits, setServerAccessCreditsSubClass

Methods inherited from class org.javades.jqueues.r5.entity.jq.queue.composite.AbstractSimQueueComposite

addRealJobLocal, getCopySimQueues, getCopySubSimQueues, getDelegateJob, getDelegateJobMild, getDelegateSimJobFactory, getIndex, getIndex, getQueue, getQueue, getQueues, getRealJob, getRealJob, getSimQueueSelector, isDelegateJob, isRealJob, notifyResetEntity, notifyStateChanged, notifyUpdate, removeJobsFromQueueLocal, resetSimQueueSelector, selectFirstQueue, selectNextQueue, setDelegateSimJobFactory

Methods inherited from class org.javades.jqueues.r5.entity.jq.queue.AbstractSimQueue

arrive, autoRevoke, cancelDepartureEvent, cancelDepartureEvent, depart, departureFromEventList, drop, getAutoRevocationPolicy, getDepartureEvents, getDepartureEvents, getFirstJob, getFirstJobInServiceArea, getFirstJobInWaitingArea, getJobs, getJobsInServiceArea, getJobsInWaitingArea, getNumberOfJobs, getNumberOfJobsInServiceArea, getNumberOfJobsInWaitingArea, getServerAccessCredits, hasJobs, hasJobsInServiceArea, hasJobsInWaitingArea, hasServerAcccessCredits, isJob, isJobInServiceArea, isJobInWaitingArea, isQueueAccessVacation, registerStdOutSimQueueListener, revoke, revoke, scheduleDepartureEvent, scheduleJobArrival, setAutoRevocationPolicy, setQueueAccessVacation, setServerAccessCredits, start, takeServerAccessCredit, triggerPotentialNewStartArmed, unregisterStdOutSimQueueListener

Methods inherited from class org.javades.jqueues.r5.entity.AbstractSimEntity

addPendingNotification, addPendingNotification, clearAndUnlockPendingNotificationsIfLocked, delegateOperation, doAfterNotifications, doOperation, fireAndLockPendingNotifications, getEventList, getLastUpdateTime, getRegisteredDelegatedOperations, getRegisteredNotificationTypes, getRegisteredOperations, getSimEntityListeners, getUnknownNotificationTypePolicy, getUnknownOperationPolicy, isIgnoreEventListReset, notifyEventListReset, registerDelegatedOperation, registerNotificationType, registerOperation, registerPreEventHook, registerPreNotificationHook, registerPreUpdateHook, registerSimEntityListener, registerStdOutSimEntityListener, removeDelegationForOperation, resetEntity, setIgnoreEventListReset, setName, setUnknownNotificationTypePolicy, setUnknownOperationPolicy, toString, unregisterSimEntityListener, unregisterStdOutSimEntityListener, update

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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, 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, unregisterSimEntityListener, update

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

notifyEventListReset

Constructor Detail

DropCol

public DropCol(org.javades.jsimulation.r5.SimEventList eventList,
               SimQueue<DJ,DQ> mainQueue,
               SimQueue<DJ,DQ> dropQueue,
               DelegateSimJobFactory delegateSimJobFactory)

Creates a drop-collector queue given an event list, a main queue and a drop (collector) queue.

Note that the mainQueue and the dropQueue arguments may be equal!

Parameters:

eventList - The event list to use.

mainQueue - The main queue.

dropQueue - The drop queue.

delegateSimJobFactory - An optional factory for the delegate SimJobs.

Throws:

IllegalArgumentException - If the event list is null, one of or both queues are null.

See Also:

DelegateSimJobFactory, DefaultDelegateSimJobFactory

Method Detail

getCopySimQueue

public DropCol<DJ,DQ,J,Q> getCopySimQueue()

Returns a new DropCol object on the same SimEventList with copies of the main and drop queues and the same delegate-job factory.

Returns:

A new DropCol object on the same SimEventList with copies of the main and drop queues and the same delegate-job factory.

Throws:

UnsupportedOperationException - If the main or drop queues could not be copied through SimQueue.getCopySimQueue().

See Also:

AbstractSimEntity.getEventList(), AbstractCollectorSimQueue.getMainQueue(), getDropQueue(), AbstractSimQueueComposite.getDelegateSimJobFactory()

getDropQueue

protected final DQ getDropQueue()

Returns the drop (second, last) queue.

Returns:

The drop (second, last) queue.

toStringDefault

public String toStringDefault()

Returns "DropCol[mainQueue->dropQueue]".

Specified by:

toStringDefault in interface SimEntity

Overrides:

toStringDefault in class AbstractSimQueue<J extends SimJob,Q extends DropCol>

Returns:

"DropCol[mainQueue->dropQueue]".

See Also:

SimEntity.setName(java.lang.String), Object.toString()