KSLCore/ksl.calendar/LinkedListEventCalendar

LinkedListEventCalendar

class LinkedListEventCalendar : CalendarIfc

LinkedListEventCalendar is a concrete implementation of the CalendarIfc for use with the Scheduler This class provides an event calendar by using a java.util.LinkedList to hold the underlying events.

Constructors

constructor()

Properties

isEmpty

open override val isEmpty: Boolean

Checks to see if the calendar is empty

isNotEmpty

open val isNotEmpty: Boolean

Checks to see if the calendar is not empty

Functions

add

open override fun add(event: KSLEvent<*>)

The add method will place the provided JSLEvent into the underlying data structure ensuring the ordering of the events to be processed

cancel

open fun cancel(event: KSLEvent<*>)

Cancels the supplied JSLEvent in the calendar. Canceling does not remove the event from the data structure. It simply indicates that the scheduled event must not be executed.

clear

open override fun clear()

Clears or cancels every event in the data structure. Removes all JSLEvents from the data structure.

nextEvent

open override fun nextEvent(): KSLEvent<*>?

Returns the next JSLEvent to be executed. The event is removed from the calendar if it exists

peekNext

open override fun peekNext(): KSLEvent<*>?

Peeks at the next event without removing it

size

open override fun size(): Int

Returns the number of events in the calendar

toString

open override fun toString(): String