Package org.djutils.event

Class Event

java.lang.Object

org.djutils.event.Event

All Implemented Interfaces:

Serializable, EventInterface

Direct Known Subclasses:

TimedEvent

public class Event
extends Object
implements EventInterface

The Event class forms the reference implementation for the EventInterface. Because events are often sent over the network, the interface demands that source of the event and its content are serializable. It is the responsibility of the programmer, though, that the fields of the sourceId and content are serializable as well.

Copyright (c) 2002-2020 Delft University of Technology, Jaffalaan 5, 2628 BX Delft, the Netherlands. All rights reserved. See for project information https://djutils.org. The DJUTILS project is distributed under a three-clause BSD-style license, which can be found at https://djutils.org/docs/license.html. This class was originally part of the DSOL project, see https://simulation.tudelft.nl/dsol/manual.

Author:

Peter Jacobs , Alexander Verbraeck

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
Event(EventType type, Serializable sourceId, Serializable content)	Construct a new Event.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
Serializable	getContent()	Return the content (payload) of this event.
Serializable	getSourceId()	Return the id of the source of the event.
EventType	getType()	Return the type of the event.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

Event

public Event(EventType type, Serializable sourceId, Serializable content)

Construct a new Event.

Parameters:

type - EventType; the name of the Event.

sourceId - Serializable; the source id of the sender

content - Serializable; the content of the event

Method Details

getSourceId

public final Serializable getSourceId()

Return the id of the source of the event. The source is, or identifies the sender of the event

Specified by:

getSourceId in interface EventInterface

Returns:

Serializable; the id of the source of the event

getContent

public final Serializable getContent()

Return the content (payload) of this event.

Specified by:

getContent in interface EventInterface

Returns:

Serializable; the content (payload) of this event

getType

public final EventType getType()

Return the type of the event.

Specified by:

getType in interface EventInterface

Returns:

EventType; the type of the event

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object