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

Class EncHS<DJ extends SimJob,DQ extends SimQueue,J extends SimJob,Q extends EncHS>

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.enc.AbstractEncapsulatorSimQueue<DJ,DQ,J,Q>

org.javades.jqueues.r5.entity.jq.queue.composite.enc.EncHS<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 EncHS<DJ extends SimJob,DQ extends SimQueue,J extends SimJob,Q extends EncHS>
extends AbstractEncapsulatorSimQueue<DJ,DQ,J,Q>

A SimQueueComposite encapsulating a single SimQueue of which job starts are hidden.

This composite queue (precisely) mimics the SimQueue interface of the encapsulated queue, including non-standard operations and notifications, but hides the start of (delegate) job on the encapsulated queue.

Refer to AbstractEncapsulatorSimQueue, AbstractSimQueueComposite and SimQueueComposite for more details on encapsulated queues.

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.

See Also:

SimQueueComposite, Enc

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
EncHS(org.javades.jsimulation.r5.SimEventList eventList, DQ queue, DelegateSimJobFactory delegateSimJobFactory) Creates an encapsulator queue that hides its sub-queue starts given an event list and a queue.

Method Summary

Modifier and Type	Method and Description
EncHS<DJ,DQ,J,Q>	getCopySimQueue() Returns a new EncHS object on the same SimEventList with a copy of the encapsulated queue and the same delegate-job factory.
Object	getQoS() Calls super method (in order to make implementation final).
Class	getQoSClass() Calls super method (in order to make implementation final).
protected double	getServiceTimeForJob(J job) Calls super method (in order to make implementation final).
protected void	insertJobInQueueUponArrival(J job, double time) Calls super method (in order to make implementation final).
protected void	insertJobInQueueUponStart(J job, double time) Throws an exception.
boolean	isStartArmed() Returns false, since (real) jobs cannot start.
protected void	processSubQueueNotifications(List<MultiSimQueueNotificationProcessor.Notification<DJ,DQ>> notifications) Removes all start notifications from the list and calls super method (and makes the implementation final).
protected void	queueAccessVacationDropSubClass(double time, J job) Calls super method (in order to make implementation final).
protected void	removeJobFromQueueUponDeparture(J departingJob, double time) Calls super method (in order to make implementation final).
protected void	removeJobFromQueueUponDrop(J job, double time) Calls super method (in order to make implementation final).
protected void	removeJobFromQueueUponRevokation(J job, double time, boolean auto) Calls super method (in order to make implementation final).
protected void	rescheduleAfterArrival(J job, double time) Calls super method (in order to make implementation final).
protected void	rescheduleAfterDeparture(J departedJob, double time) Calls super method (in order to make implementation final).
protected void	rescheduleAfterDrop(J job, double time) Calls super method (in order to make implementation final).
protected void	rescheduleAfterRevokation(J job, double time, boolean auto) Calls super method (in order to make implementation final).
protected void	rescheduleAfterStart(J job, double time) Throws an exception.
protected void	rescheduleForNewServerAccessCredits(double time) Calls super method (in order to make implementation final).
protected void	resetEntitySubClass() Calls super method (in order to make implementation final).
protected void	setServerAccessCreditsSubClass() Does nothing.
String	toStringDefault() Returns "EncHS[encapsulated queue]".

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

getEncapsulatedQueue

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

EncHS

public EncHS(org.javades.jsimulation.r5.SimEventList eventList,
             DQ queue,
             DelegateSimJobFactory delegateSimJobFactory)

Creates an encapsulator queue that hides its sub-queue starts given an event list and a queue.

Parameters:

eventList - The event list to use.

queue - The encapsulated queue.

delegateSimJobFactory - An optional factory for the delegate SimJobs.

Throws:

IllegalArgumentException - If the event list or the queue is null.

See Also:

DelegateSimJobFactory, DefaultDelegateSimJobFactory

Method Detail

getCopySimQueue

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

Returns a new EncHS object on the same SimEventList with a copy of the encapsulated queue and the same delegate-job factory.

Returns:

A new EncHS object on the same SimEventList with a copy of the encapsulated queue and the same delegate-job factory.

Throws:

UnsupportedOperationException - If the encapsulated queue could not be copied through SimQueue.getCopySimQueue().

See Also:

AbstractSimEntity.getEventList(), AbstractEncapsulatorSimQueue.getEncapsulatedQueue(), AbstractSimQueueComposite.getDelegateSimJobFactory()

toStringDefault

public String toStringDefault()

Returns "EncHS[encapsulated queue]".

Specified by:

toStringDefault in interface SimEntity

Overrides:

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

Returns:

"EncHS[encapsulated queue]".

See Also:

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

getQoS

public final Object getQoS()

Calls super method (in order to make implementation final).

Specified by:

getQoS in interface SimQoS<J extends SimJob,Q extends EncHS>

Overrides:

getQoS in class AbstractEncapsulatorSimQueue<DJ extends SimJob,DQ extends SimQueue,J extends SimJob,Q extends EncHS>

Returns:

The result from the super method.

getQoSClass

public final Class getQoSClass()

Calls super method (in order to make implementation final).

Specified by:

getQoSClass in interface SimQoS<J extends SimJob,Q extends EncHS>

Overrides:

getQoSClass in class AbstractEncapsulatorSimQueue<DJ extends SimJob,DQ extends SimQueue,J extends SimJob,Q extends EncHS>

Returns:

The result from the super method.

resetEntitySubClass

protected final void resetEntitySubClass()

Calls super method (in order to make implementation final).

Overrides:

resetEntitySubClass in class AbstractEncapsulatorSimQueue<DJ extends SimJob,DQ extends SimQueue,J extends SimJob,Q extends EncHS>

See Also:

AbstractSimQueue.removeJobFromQueueUponRevokation(J, double, boolean), AbstractSimQueue.rescheduleAfterRevokation(J, double, boolean), SimEntity.resetEntity(), SimQueueSelector.resetSimQueueSelector(), SimQueue.setServerAccessCredits(double, int), SimQueue.isStartArmed()

queueAccessVacationDropSubClass

protected final void queueAccessVacationDropSubClass(double time,
                                                     J job)

Calls super method (in order to make implementation final).

Overrides:

queueAccessVacationDropSubClass in class AbstractSimQueue<J extends SimJob,Q extends EncHS>

Parameters:

time - The time the job was dropped, i.e., the current time.

job - The dropped job.

See Also:

AbstractSimQueue.arrive(double, J), AbstractSimQueue.setQueueAccessVacation(double, boolean)

insertJobInQueueUponArrival

protected final void insertJobInQueueUponArrival(J job,
                                                 double time)

Calls super method (in order to make implementation final).

Overrides:

insertJobInQueueUponArrival in class AbstractEncapsulatorSimQueue<DJ extends SimJob,DQ extends SimQueue,J extends SimJob,Q extends EncHS>

Parameters:

job - The job that arrived.

time - The current time (i.e., arrival time of the job).

See Also:

AbstractSimQueueComposite.addRealJobLocal(J), AbstractEncapsulatorSimQueue.rescheduleAfterArrival(J, double)

rescheduleAfterArrival

protected final void rescheduleAfterArrival(J job,
                                            double time)

Calls super method (in order to make implementation final).

Overrides:

rescheduleAfterArrival in class AbstractEncapsulatorSimQueue<DJ extends SimJob,DQ extends SimQueue,J extends SimJob,Q extends EncHS>

Parameters:

job - The job that arrived (and is already present in AbstractSimQueue.getJobs()).

time - The current time (i.e., the arrival time of the job).

See Also:

SimQueue.arrive(double, J), AbstractEncapsulatorSimQueue.insertJobInQueueUponArrival(J, double)

removeJobFromQueueUponDrop

protected final void removeJobFromQueueUponDrop(J job,
                                                double time)

Calls super method (in order to make implementation final).

Overrides:

removeJobFromQueueUponDrop in class AbstractEncapsulatorSimQueue<DJ extends SimJob,DQ extends SimQueue,J extends SimJob,Q extends EncHS>

Parameters:

job - The job that is to be dropped.

time - The current time (i.e., drop time of the job).

See Also:

AbstractSimQueue.drop(J, double), AbstractEncapsulatorSimQueue.rescheduleAfterDrop(J, double), AbstractEncapsulatorSimQueue.removeJobFromQueueUponRevokation(J, double, boolean), AbstractSimQueueComposite.removeJobsFromQueueLocal(J, DJ), AbstractSimQueueComposite.getDelegateJob(SimJob), SimJob.getQueue()

rescheduleAfterDrop

protected final void rescheduleAfterDrop(J job,
                                         double time)

Calls super method (in order to make implementation final).

Overrides:

rescheduleAfterDrop in class AbstractEncapsulatorSimQueue<DJ extends SimJob,DQ extends SimQueue,J extends SimJob,Q extends EncHS>

Parameters:

job - The jobs that was dropped.

time - The current time (i.e., drop time of the job).

See Also:

AbstractEncapsulatorSimQueue.removeJobFromQueueUponDrop(J, double), AbstractEncapsulatorSimQueue.rescheduleAfterRevokation(J, double, boolean)

removeJobFromQueueUponRevokation

protected final void removeJobFromQueueUponRevokation(J job,
                                                      double time,
                                                      boolean auto)

Calls super method (in order to make implementation final).

Overrides:

removeJobFromQueueUponRevokation in class AbstractEncapsulatorSimQueue<DJ extends SimJob,DQ extends SimQueue,J extends SimJob,Q extends EncHS>

Parameters:

job - The job that is to be revoked.

time - The current time (i.e., revocation time of the job).

auto - Whether or not this applies to an auto-revocation.

See Also:

AbstractSimQueue.revoke(double, J, boolean), AbstractSimQueue.autoRevoke(double, J), SimJQEvent.Revocation, AbstractEncapsulatorSimQueue.rescheduleAfterRevokation(J, double, boolean), AbstractSimQueueComposite.getDelegateJob(SimJob), SimJob.getQueue(), AbstractSimQueueComposite.removeJobsFromQueueLocal(J, DJ)

rescheduleAfterRevokation

protected final void rescheduleAfterRevokation(J job,
                                               double time,
                                               boolean auto)

Calls super method (in order to make implementation final).

Overrides:

rescheduleAfterRevokation in class AbstractEncapsulatorSimQueue<DJ extends SimJob,DQ extends SimQueue,J extends SimJob,Q extends EncHS>

Parameters:

job - The jobs that was successfully revoked.

time - The current time (i.e., revocation time of the job).

auto - Whether or not this applies to an auto-revocation.

See Also:

SimJQEvent.Revocation, AbstractEncapsulatorSimQueue.removeJobFromQueueUponRevokation(J, double, boolean), AbstractEncapsulatorSimQueue.processSubQueueNotifications(java.util.List<org.javades.jqueues.r5.listener.MultiSimQueueNotificationProcessor.Notification<DJ, DQ>>)

isStartArmed

public final boolean isStartArmed()

Returns false, since (real) jobs cannot start.

Note: This overrides the default AbstractEncapsulatorSimQueue implementation.

Specified by:

isStartArmed in interface SimQueue<J extends SimJob,Q extends EncHS>

Overrides:

isStartArmed in class AbstractEncapsulatorSimQueue<DJ extends SimJob,DQ extends SimQueue,J extends SimJob,Q extends EncHS>

Returns:

false, since (real) jobs cannot start.

See Also:

SimQueue.isStartArmed()

setServerAccessCreditsSubClass

protected final void setServerAccessCreditsSubClass()

Does nothing.

Note: This overrides the default AbstractEncapsulatorSimQueue implementation.

In the EncHS queue, server-access credits on the encapsulated queue are left untouched. The composite queue has its own little private notion of the server-access credits, but since jobs do not start, these do not hurt. We have to do this in order to prevent all sorts of server-access-credits-related notifications to enter the composite queue and its listeners. They might fail to understand why server-access credits change in the absence of starting jobs.

Overrides:

setServerAccessCreditsSubClass in class AbstractEncapsulatorSimQueue<DJ extends SimJob,DQ extends SimQueue,J extends SimJob,Q extends EncHS>

See Also:

AbstractSimQueue.getServerAccessCredits(), AbstractSimEntity.getLastUpdateTime(), SimQueue.setServerAccessCredits(double, int), AbstractEncapsulatorSimQueue.rescheduleForNewServerAccessCredits(double)

rescheduleForNewServerAccessCredits

protected final void rescheduleForNewServerAccessCredits(double time)

Calls super method (in order to make implementation final).

Overrides:

rescheduleForNewServerAccessCredits in class AbstractEncapsulatorSimQueue<DJ extends SimJob,DQ extends SimQueue,J extends SimJob,Q extends EncHS>

Parameters:

time - The current time (i.e., the time at which new server-access credits became available).

See Also:

AbstractEncapsulatorSimQueue.setServerAccessCreditsSubClass()

insertJobInQueueUponStart

protected final void insertJobInQueueUponStart(J job,
                                               double time)

Throws an exception.

Note: This overrides the default AbstractEncapsulatorSimQueue implementation.

Overrides:

insertJobInQueueUponStart in class AbstractEncapsulatorSimQueue<DJ extends SimJob,DQ extends SimQueue,J extends SimJob,Q extends EncHS>

Parameters:

job - The job that starts.

time - The current time (i.e., start time of the job).

Throws:

IllegalStateException - Since jobs cannot start.

See Also:

AbstractSimQueue.isJob(org.javades.jqueues.r5.entity.jq.job.SimJob), AbstractSimQueue.isJobInServiceArea(org.javades.jqueues.r5.entity.jq.job.SimJob), AbstractSimQueueComposite.getDelegateJob(J), AbstractEncapsulatorSimQueue.rescheduleAfterStart(J, double)

rescheduleAfterStart

protected final void rescheduleAfterStart(J job,
                                          double time)

Throws an exception.

Note: This overrides the default AbstractEncapsulatorSimQueue implementation.

Overrides:

rescheduleAfterStart in class AbstractEncapsulatorSimQueue<DJ extends SimJob,DQ extends SimQueue,J extends SimJob,Q extends EncHS>

Parameters:

job - The job that started (and is already present in AbstractSimQueue.getJobsInServiceArea().

time - The current time (i.e., the start time of the job).

Throws:

IllegalStateException - Since jobs cannot start.

See Also:

AbstractSimQueue.isJob(org.javades.jqueues.r5.entity.jq.job.SimJob), AbstractSimQueue.isJobInServiceArea(org.javades.jqueues.r5.entity.jq.job.SimJob), AbstractSimQueueComposite.getDelegateJob(J), AbstractEncapsulatorSimQueue.insertJobInQueueUponStart(J, double)

getServiceTimeForJob

protected final double getServiceTimeForJob(J job)

Calls super method (in order to make implementation final).

Overrides:

getServiceTimeForJob in class AbstractEncapsulatorSimQueue<DJ extends SimJob,DQ extends SimQueue,J extends SimJob,Q extends EncHS>

Parameters:

job - The job, non-null.

Returns:

The result from the super method.

removeJobFromQueueUponDeparture

protected final void removeJobFromQueueUponDeparture(J departingJob,
                                                     double time)

Calls super method (in order to make implementation final).

Overrides:

removeJobFromQueueUponDeparture in class AbstractEncapsulatorSimQueue<DJ extends SimJob,DQ extends SimQueue,J extends SimJob,Q extends EncHS>

Parameters:

departingJob - The job that departs.

time - The departure (current) time.

See Also:

AbstractSimQueue.depart(double, J), AbstractEncapsulatorSimQueue.rescheduleAfterDeparture(J, double), AbstractEncapsulatorSimQueue.removeJobFromQueueUponRevokation(J, double, boolean), AbstractSimQueueComposite.removeJobsFromQueueLocal(J, DJ), AbstractSimQueueComposite.getDelegateJob(SimJob), SimJob.getQueue()

rescheduleAfterDeparture

protected final void rescheduleAfterDeparture(J departedJob,
                                              double time)

Calls super method (in order to make implementation final).

Overrides:

rescheduleAfterDeparture in class AbstractEncapsulatorSimQueue<DJ extends SimJob,DQ extends SimQueue,J extends SimJob,Q extends EncHS>

Parameters:

departedJob - The departed job.

time - The departure (current) time.

See Also:

AbstractEncapsulatorSimQueue.removeJobFromQueueUponDeparture(J, double), AbstractEncapsulatorSimQueue.rescheduleAfterRevokation(J, double, boolean)

processSubQueueNotifications

protected final void processSubQueueNotifications(List<MultiSimQueueNotificationProcessor.Notification<DJ,DQ>> notifications)

Removes all start notifications from the list and calls super method (and makes the implementation final).

Overrides:

processSubQueueNotifications in class AbstractEncapsulatorSimQueue<DJ extends SimJob,DQ extends SimQueue,J extends SimJob,Q extends EncHS>

Parameters:

notifications - The sub-queue notifications, will be modified; empty upon return.

See Also:

SimJQSimpleEventType.START