org.javades.jsimulation.r5

Class AbstractSimEventList<E extends SimEvent>

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractSet<E>

java.util.TreeSet<E>

org.javades.jsimulation.r5.AbstractSimEventList<E>

Type Parameters:

E - The type of SimEvents supported.

All Implemented Interfaces:

Serializable, Cloneable, Iterable<E>, Runnable, Collection<E>, NavigableSet<E>, Set<E>, SortedSet<E>, SimEventList<E>

Direct Known Subclasses:

DefaultSimEventList_IOEL, DefaultSimEventList_ROEL

public abstract class AbstractSimEventList<E extends SimEvent>
extends TreeSet<E>
implements SimEventList<E>

A TreeSet-based implementation of SimEventList.

Note that in the default implementation, events that have the same time, are processed in random order!

The implementation is not thread-safe. An event list is really meant to be processed and operated upon by a single thread only.

Last javadoc Review: Jan de Jongh, TNO, 20180402, r5.1.0.

See Also:

SimEventList, DefaultSimEventList, DefaultSimEventList_ROEL, DefaultSimEventList_IOEL, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected static boolean	USE_ARRAY_OPTIMIZATION When true, this class and possibly some sub-classes maintain various array copies of collections often iterated over, like listeners, and uses array iteration instead of Collection iteration.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractSimEventList(Comparator comparator, double defaultResetTime, Class<E> eventClass) Creates a new (abstract) event list (main constructor).

Method Summary

Modifier and Type	Method and Description
boolean	addAll(Collection<? extends E> collection) Overridden in order (ensure) the setting the de-conflict value on the event added.
void	addListener(SimEventListResetListener l) Adds a listener to this event list.
protected void	checkUpdate(double newTime) Checks the progress of time and notifies listeners when an update has taken place.
protected void	checkUpdate(E e) Checks the progress of time when processing a given event and notifies listeners when an update has taken place.
protected void	fireEmpty() Fires an empty-event-list notification to registered listeners.
protected void	fireNextEvent() Fires a next-event notification to registered listeners.
protected void	fireReset() Fires a reset notification to registered listeners.
protected void	fireUpdate() Fires an update notification to registered listeners.
double	getDefaultResetTime() Gets the default reset time, the time on the event list after it is reset (without explicit time argument).
Class<E>	getSimEventClass() Returns the Class of allowable SimEvents in this event list.
SimEventFactory<? extends E>	getSimEventFactory() Gets the factory for SimEvents created by this SimEventList.
double	getTime() Returns the current time during processing of the event list.
Function<SimEventList,String>	getToStringFunction() Gets the function that generates the string for toString().
void	removeListener(SimEventListResetListener l) Removes a listener from this event list.
void	reset(double time) Resets the event list to a specific time.
void	run() Overridden to make the default method final.
void	runSingleStep() Runs a single (the first) event from the event list ("single-stepping").
void	runUntil(double endTime, boolean inclusive, boolean setTimeToEndTime) Runs the event list until it is empty, interrupted, or until a specific point in time has been reached.
void	setDefaultResetTime(double defaultResetTime) Sets the default reset time, the time on the event list after it is reset (without explicit time argument).
void	setSimEventFactory(SimEventFactory<? extends E> eventFactory) Sets the factory for SimEvents created by this SimEventList.
void	setToStringFunction(Function<SimEventList,String> toStringFunction) Sets the function that generates the string for toString().
String	toString() Returns a string representation of this event list (final, but customizable).

Methods inherited from class java.util.TreeSet

add, ceiling, clear, clone, comparator, contains, descendingIterator, descendingSet, first, floor, headSet, headSet, higher, isEmpty, iterator, last, lower, pollFirst, pollLast, remove, size, spliterator, subSet, subSet, tailSet, tailSet

Methods inherited from class java.util.AbstractSet

equals, hashCode, removeAll

Methods inherited from class java.util.AbstractCollection

containsAll, retainAll, toArray, toArray

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

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

print, print, reschedule, reset, schedule, schedule, schedule, schedule, scheduleNow, scheduleNow, scheduleNow

Methods inherited from interface java.util.SortedSet

comparator, first, headSet, last, spliterator, subSet, tailSet

Methods inherited from interface java.util.Set

add, clear, contains, containsAll, equals, hashCode, isEmpty, iterator, remove, removeAll, retainAll, size, toArray, toArray

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Field Detail

USE_ARRAY_OPTIMIZATION

protected static final boolean USE_ARRAY_OPTIMIZATION

When true, this class and possibly some sub-classes maintain various array copies of collections often iterated over, like listeners, and uses array iteration instead of Collection iteration.

See Also:

Constant Field Values

Constructor Detail

AbstractSimEventList

protected AbstractSimEventList(Comparator comparator,
                               double defaultResetTime,
                               Class<E> eventClass)

Creates a new (abstract) event list (main constructor).

Unless an event-factory is registered after construction, the base class for SimEvents supported (E) must feature a constructor with no arguments, see setSimEventFactory(org.javades.jsimulation.r5.SimEventFactory<? extends E>).

Parameters:

comparator - The comparator for SimEvents.

defaultResetTime - The default reset time.

eventClass - The base class SimEvents supported.

Throws:

IllegalArgumentException - If eventClass is null.

See Also:

TreeSet.TreeSet(java.util.Comparator)

Method Detail

getToStringFunction

public final Function<SimEventList,String> getToStringFunction()

Gets the function that generates the string for toString().

Note that this class turns toString() final.

If this method returns null, which is the default after construction, the toString() method returns a compile-time default string.

Returns:

The function that generates the string for toString().

See Also:

toString(), setToStringFunction(java.util.function.Function<org.javades.jsimulation.r5.SimEventList, java.lang.String>)

setToStringFunction

public final void setToStringFunction(Function<SimEventList,String> toStringFunction)

Sets the function that generates the string for toString().

Note that this class turns toString() final.

If the function is set to null, the toString() method returns a compile-time default string.

Parameters:

toStringFunction - The function returning the appropriate print string when this is supplied as argument.

See Also:

toString(), getToStringFunction()

toString

public final String toString()

Returns a string representation of this event list (final, but customizable).

Since we intend to create one of more final sub-classes, but still want end-users to be able to customize the printed output, this method applies the getToStringFunction() if present. Otherwise, it returns a compile-time default string.

Overrides:

toString in class AbstractCollection<E extends SimEvent>

Returns:

A string representation of this event list.

See Also:

getToStringFunction(), setToStringFunction(java.util.function.Function<org.javades.jsimulation.r5.SimEventList, java.lang.String>)

getDefaultResetTime

public final double getDefaultResetTime()

Description copied from interface: SimEventList

Gets the default reset time, the time on the event list after it is reset (without explicit time argument).

The default value (i.e., the default reset time if not set explicitly through SimEventList.setDefaultResetTime(double)) is negative infinity.

Specified by:

getDefaultResetTime in interface SimEventList<E extends SimEvent>

Returns:

The default reset time (default minus infinity).

See Also:

SimEventList.reset(), SimEventList.reset(double)

setDefaultResetTime

public final void setDefaultResetTime(double defaultResetTime)

Description copied from interface: SimEventList

Sets the default reset time, the time on the event list after it is reset (without explicit time argument).

The value supplied (obviously) survives resets; the last value set through this method is only used by SimEventList.reset().

This method can be called at any time; the default reset time is only used while actually performing a reset.

Specified by:

setDefaultResetTime in interface SimEventList<E extends SimEvent>

Parameters:

defaultResetTime - The new default reset time (minus and positive infinity are allowed).

See Also:

SimEventList.reset(), SimEventList.reset(double)

getTime

public final double getTime()

Description copied from interface: SimEventList

Returns the current time during processing of the event list.

Specified by:

getTime in interface SimEventList<E extends SimEvent>

Returns:

The current time.

getSimEventClass

public final Class<E> getSimEventClass()

Description copied from interface: SimEventList

Returns the Class of allowable SimEvents in this event list.

Specified by:

getSimEventClass in interface SimEventList<E extends SimEvent>

Returns:

The Class of allowable SimEvents in this event list.

getSimEventFactory

public final SimEventFactory<? extends E> getSimEventFactory()

Description copied from interface: SimEventList

Gets the factory for SimEvents created by this SimEventList.

Specified by:

getSimEventFactory in interface SimEventList<E extends SimEvent>

Returns:

The event factory; may be null.

setSimEventFactory

public final void setSimEventFactory(SimEventFactory<? extends E> eventFactory)

Description copied from interface: SimEventList

Sets the factory for SimEvents created by this SimEventList.

Specified by:

setSimEventFactory in interface SimEventList<E extends SimEvent>

Parameters:

eventFactory - The event factory; may be null to stop using it.

addAll

public final boolean addAll(Collection<? extends E> collection)

Overridden in order (ensure) the setting the de-conflict value on the event added.

Overridden and made final to ensure this method uses the abstract TreeSet.add(E) method.

You do not have to override this method in case you want to change setting the de-conflict value; override TreeSet.add(E) instead.

Specified by:

addAll in interface Collection<E extends SimEvent>

Specified by:

addAll in interface Set<E extends SimEvent>

Overrides:

addAll in class TreeSet<E extends SimEvent>

Parameters:

collection - See TreeSet.addAll(java.util.Collection<? extends E>).

Returns:

See TreeSet.addAll(java.util.Collection<? extends E>).

See Also:

SimEvent.setSimEventListDeconflictValue(long)

reset

public void reset(double time)

Description copied from interface: SimEventList

Resets the event list to a specific time.

Removes all events, and sets time to the given value. An exception is thrown if the event list is currently running.

This method ignores the default reset time, as given by SimEventList.getDefaultResetTime(), but does not change that value.

Specified by:

reset in interface SimEventList<E extends SimEvent>

Parameters:

time - The new time of the event list.

See Also:

SimEventList.run()

checkUpdate

protected final void checkUpdate(double newTime)

Checks the progress of time and notifies listeners when an update has taken place. An update is defined as the processing of the first event or an increase in the current time. If needed, this method updates the current time.

Parameters:

newTime - The new time.

Throws:

IllegalArgumentException - If this is not the first update (after construction or after a reset) and the new time is strictly smaller than the current time.

See Also:

getTime(), fireUpdate()

checkUpdate

protected final void checkUpdate(E e)

Checks the progress of time when processing a given event and notifies listeners when an update has taken place. An update is defined as the processing of the first event or an increase in the current time. If needed, this method updates the current time.

Parameters:

e - The event being processed.

Throws:

IllegalArgumentException - If the event is null or if this is not the first update (after construction or after a reset) and the new time on the event is strictly smaller than the current time.

See Also:

getTime(), fireUpdate()

run

public final void run()

Overridden to make the default method final.

Specified by:

run in interface Runnable

Specified by:

run in interface SimEventList<E extends SimEvent>

See Also:

SimEventList.run()

runUntil

public final void runUntil(double endTime,
                           boolean inclusive,
                           boolean setTimeToEndTime)

Description copied from interface: SimEventList

Runs the event list until it is empty, interrupted, or until a specific point in time has been reached.

After returning from this method, it can be invoked later, but the end time passed must not decrease in this sequence. See also SimEventList.reset(double).

Optionally, but only if inclusive == true, the time on the event list is increased to the endTime argument. Otherwise, not that the current time on the event list may be smaller than the end time provided!

Specified by:

runUntil in interface SimEventList<E extends SimEvent>

Parameters:

endTime - The time until which to run the event list.

inclusive - Whether to include events at the end time parameter.

setTimeToEndTime - Whether to increase the current time to the end time given after processing the applicable events (ignored if inclusive == false).

See Also:

SimEventList.getTime(), SimEvent.getTime(), SimEventList.run()

runSingleStep

public final void runSingleStep()

Runs a single (the first) event from the event list ("single-stepping").

Specified by:

runSingleStep in interface SimEventList<E extends SimEvent>

addListener

public final void addListener(SimEventListResetListener l)

Description copied from interface: SimEventList

Adds a listener to this event list.

Specified by:

addListener in interface SimEventList<E extends SimEvent>

Parameters:

l - The listener to be added, ignored if null.

removeListener

public final void removeListener(SimEventListResetListener l)

Description copied from interface: SimEventList

Removes a listener from this event list.

Specified by:

removeListener in interface SimEventList<E extends SimEvent>

Parameters:

l - The listener to be removed, ignored if null or not present.

fireReset

protected final void fireReset()

Fires a reset notification to registered listeners.

See Also:

SimEventListResetListener.notifyEventListReset(org.javades.jsimulation.r5.SimEventList)

fireUpdate

protected final void fireUpdate()

Fires an update notification to registered listeners.

See Also:

SimEventListListener.notifyEventListUpdate(org.javades.jsimulation.r5.SimEventList, double)

fireEmpty

protected final void fireEmpty()

Fires an empty-event-list notification to registered listeners.

See Also:

SimEventListListener.notifyEventListEmpty(org.javades.jsimulation.r5.SimEventList, double)

fireNextEvent

protected final void fireNextEvent()

Fires a next-event notification to registered listeners.

See Also:

SimEventListListener.Fine.notifyNextEvent(org.javades.jsimulation.r5.SimEventList, double)