Package microsim.event

Class EventGroup

java.lang.Object

microsim.event.Event

microsim.event.EventGroup

All Implemented Interfaces:

Comparable<Event>

public class EventGroup
extends Event

A special implementation of the Event family. It is not a real event, but a container for other events. When fired this object automatically fires the events contained. Each contained event is fired at the group time, any other time pointer is ignored.

Field Summary

Fields inherited from class microsim.event.Event

loop, ordering, time

Constructor Summary

Constructors

Constructor	Description
EventGroup()	Builds a new group event.

Method Summary

Modifier and Type	Method	Description
@NonNull EventGroup	addCollectionEvent(@NonNull Collection<?> elements, @NonNull Class<?> objectType, @NonNull String method)	readOnly defaults to true.
@NonNull EventGroup	addCollectionEvent(@NonNull Collection<?> elements, @NonNull Class<?> objectType, @NonNull String method, boolean readOnly)	Creates a new CollectionTargetEvent and adds the event to the list, using late binding method.
@NonNull EventGroup	addCollectionEvent(@NonNull Collection<?> elements, @NonNull Enum<?> actionType)	readOnly defaults to true.
@NonNull EventGroup	addCollectionEvent(@NonNull Collection<?> elements, @NonNull Enum<?> actionType, boolean readOnly)	Creates a new CollectionTargetEvent and adds the event to the list, using early binding method.
EventGroup	addEvent(@NonNull Object object, @NonNull Enum<?> actionType)	Creates a new SingleTargetEvent and adds the event to the list, using early binding method.
@NonNull EventGroup	addEvent(@NonNull Object object, @NonNull String method)	Creates a new SingleTargetEvent and adds the event to the list, using late binding method.
@NonNull EventGroup	addEvent(@NonNull Event newEvent)	Adds an event to the list.
EventGroup	addSystemEvent(@NonNull SimulationEngine engine, @NonNull SystemEventType actionType)	Creates a new SystemEvent and adds the event to the list.
void	clear()	Empties the event list.
@NonNull Event @NonNull []	eventsToArray()	Converts the list of actions to an array.
void	fireEvent()	Fires each event into the list.
void	removeEvent(@NonNull Event event)	Removes the given event from the list.

Methods inherited from class microsim.event.Event

compareTo, setTimeAtNextLoop, setTimeOrderingAndLoopPeriod

Methods inherited from class java.lang.Object

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

Constructor Details

EventGroup

public EventGroup()

Builds a new group event.

Method Details

clear

public void clear()

Empties the event list.

addEvent

@NonNull
public @NonNull EventGroup addEvent(@NonNull
 @NonNull Event newEvent)

Adds an event to the list.

Parameters:

newEvent - An Event object.

Throws:

NullPointerException - when newEvent is null.

addEvent

@NonNull
public @NonNull EventGroup addEvent(@NonNull
 @NonNull Object object,
 @NonNull
 @NonNull String method)
                             throws SimulationException

Creates a new SingleTargetEvent and adds the event to the list, using late binding method.

Parameters:

object - An Object.

method - The method name.

Throws:

SimulationException - when creation of SingleTargetEvent fails.

NullPointerException - when any of the input parameters is null.

See Also:

• CollectionTargetEvent

addEvent

public EventGroup addEvent(@NonNull
 @NonNull Object object,
 @NonNull
 @NonNull Enum<?> actionType)

Creates a new SingleTargetEvent and adds the event to the list, using early binding method.

Parameters:

object - An Object.

actionType - An action to invoke.

Throws:

NullPointerException - when any of the input parameters is null.

addSystemEvent

public EventGroup addSystemEvent(@NonNull
 @NonNull SimulationEngine engine,
 @NonNull
 @NonNull SystemEventType actionType)

Creates a new SystemEvent and adds the event to the list.

Parameters:

engine - A SimulationEngine object.

actionType - An action to invoke.

Throws:

NullPointerException - when any of the input parameters is null.

addCollectionEvent

@NonNull
public @NonNull EventGroup addCollectionEvent(@NonNull
 @NonNull Collection<?> elements,
 @NonNull
 @NonNull Class<?> objectType,
 @NonNull
 @NonNull String method)
                                       throws SimulationException

readOnly defaults to true.

Throws:

SimulationException

See Also:

• addCollectionEvent(Collection, Class, String, boolean)

addCollectionEvent

@NonNull
public @NonNull EventGroup addCollectionEvent(@NonNull
 @NonNull Collection<?> elements,
 @NonNull
 @NonNull Class<?> objectType,
 @NonNull
 @NonNull String method,
 boolean readOnly)
                                       throws SimulationException

Creates a new CollectionTargetEvent and adds the event to the list, using late binding method.

Parameters:

elements - A collection of elements of some nature.

objectType - The type of elements.

method - The method name.

readOnly - A boolean flag that makes elements an immutable object.

Throws:

SimulationException - when creation of CollectionTargetEvent fails.

NullPointerException - when any of the input object is null.

See Also:

• CollectionTargetEvent

addCollectionEvent

@NonNull
public @NonNull EventGroup addCollectionEvent(@NonNull
 @NonNull Collection<?> elements,
 @NonNull
 @NonNull Enum<?> actionType)

readOnly defaults to true.

See Also:

• addCollectionEvent(Collection, Enum, boolean)

addCollectionEvent

@NonNull
public @NonNull EventGroup addCollectionEvent(@NonNull
 @NonNull Collection<?> elements,
 @NonNull
 @NonNull Enum<?> actionType,
 boolean readOnly)

Creates a new CollectionTargetEvent and adds the event to the list, using early binding method.

Parameters:

elements - A collection of elements of some nature.

actionType - An action to invoke.

readOnly - A boolean flag that makes elements an immutable object.

Throws:

NullPointerException - when any of the input objects is null.

See Also:

• CollectionTargetEvent

removeEvent

public void removeEvent(@NonNull
 @NonNull Event event)

Removes the given event from the list.

Parameters:

event - An Event object.

Throws:

NullPointerException - when event is null.

fireEvent

public void fireEvent()
               throws SimulationException

Fires each event into the list.

Specified by:

fireEvent in class Event

Throws:

SimulationException - when one of the events fails to do so.

eventsToArray

@NonNull
public @NonNull Event @NonNull [] eventsToArray()

Converts the list of actions to an array.

Returns:

an array of Event objects.