org.javades.jqueues.r5.extensions.visitscounter

Class SimQueueVisitsCounterStateHandler

java.lang.Object

org.javades.jqueues.r5.extensions.visitscounter.SimQueueVisitsCounterStateHandler

All Implemented Interfaces:

SimQueueStateHandler

public final class SimQueueVisitsCounterStateHandler
extends Object
implements SimQueueStateHandler

A SimQueueStateHandler for counting per-job visits to a SimQueue.

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:

SimQueuePredictor_FB_v, SimQueuePredictor_Pattern

Constructor Summary

Constructors

Constructor and Description
SimQueueVisitsCounterStateHandler()

Method Summary

Modifier and Type	Method and Description
boolean	containsJob(SimJob job) Checks whether the given job has visited the queue at least once.
String	getHandlerName() Returns "SimQueueVisitsCounterStateHandler".
int	getNumberOfVisitsForJob(SimJob job) Gets the number of visits recorded for the given job.
int	getTotalNumberOfVisits()
void	incNumberOfVisitsForJob(SimJob job) Increments the number of visits to the queue of the given job.
void	incTotalNumberOfVisits()
void	initHandler(DefaultSimQueueState queueState) Initializes the handler, and passes the DefaultSimQueueState object.
void	newJob(SimJob job) Adds a first-time visiting job, and sets its number of visits to unity.
void	removeJob(SimJob job) Removes the given job from the internal queue-visits administration, but insists it is known.
void	resetHandler(DefaultSimQueueState queueState) Resets the (state represented by) this handler.
void	resetTotalNumberOfVisits()

Methods inherited from class java.lang.Object

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

Constructor Detail

SimQueueVisitsCounterStateHandler

public SimQueueVisitsCounterStateHandler()

Method Detail

getHandlerName

public final String getHandlerName()

Returns "SimQueueVisitsCounterStateHandler".

Specified by:

getHandlerName in interface SimQueueStateHandler

Returns:

"SimQueueVisitsCounterStateHandler".

initHandler

public final void initHandler(DefaultSimQueueState queueState)

Description copied from interface: SimQueueStateHandler

Initializes the handler, and passes the DefaultSimQueueState object.

This method is called only once during registration at the DefaultSimQueueState object.

Specified by:

initHandler in interface SimQueueStateHandler

Parameters:

queueState - The DefaultSimQueueState at which we register, non-null.

See Also:

DefaultSimQueueState.registerHandler(org.javades.jqueues.r5.util.predictor.state.SimQueueStateHandler)

resetHandler

public void resetHandler(DefaultSimQueueState queueState)

Description copied from interface: SimQueueStateHandler

Resets the (state represented by) this handler.

Specified by:

resetHandler in interface SimQueueStateHandler

Parameters:

queueState - The DefaultSimQueueState at which we are registered, non-null.

See Also:

SimQueueState.reset(), DefaultSimQueueState.reset()

getTotalNumberOfVisits

public final int getTotalNumberOfVisits()

incTotalNumberOfVisits

public final void incTotalNumberOfVisits()

resetTotalNumberOfVisits

public final void resetTotalNumberOfVisits()

getNumberOfVisitsForJob

public final int getNumberOfVisitsForJob(SimJob job)

Gets the number of visits recorded for the given job.

Parameters:

job - The job, non-null.

Returns:

The number of visits recorded for the given job.

Throws:

IllegalArgumentException - If the job is null or if the job has not visited the queue (yet).

containsJob

public final boolean containsJob(SimJob job)

Checks whether the given job has visited the queue at least once.

Parameters:

job - The job, non-null.

Returns:

true if the given job has visited the queue at least once.

Throws:

IllegalArgumentException - If the job is null.

newJob

public final void newJob(SimJob job)

Adds a first-time visiting job, and sets its number of visits to unity.

Parameters:

job - The job, non-null.

Throws:

IllegalArgumentException - If the job is null or if the job has already visited the queue before.

incNumberOfVisitsForJob

public final void incNumberOfVisitsForJob(SimJob job)

Increments the number of visits to the queue of the given job.

Parameters:

job - The job, non-null.

Throws:

IllegalArgumentException - If the job is null or if the job has not visited the queue (yet).

removeJob

public final void removeJob(SimJob job)

Removes the given job from the internal queue-visits administration, but insists it is known.

Parameters:

job - The job, non-null.

Throws:

IllegalArgumentException - If the job is null or if the job has not visited the queue (yet).