Module it.rebirthproject.ufoeb

Package it.rebirthproject.ufoeb.dto.registrations.maps.interfaces

Class EventsRegistrationsMap

java.lang.Object

it.rebirthproject.ufoeb.dto.registrations.maps.interfaces.EventsRegistrationsMap

Direct Known Subclasses:

PriorityEventsRegistrationsMap, UnorderedEventsRegistrationsMap

public abstract class EventsRegistrationsMap
extends Object

The base abstract class that implements the Registrations maps used by the EventBus' MemoryState.

See Also:

• EventBus
• MemoryState
• Registration

Field Summary

Fields

Modifier and Type	Field	Description
protected final Map<BusEventKey,List<Registration>>	registrations	The map used to store the Registrations of the bus

Constructor Summary

Constructors

Constructor	Description
EventsRegistrationsMap()

Method Summary

Modifier and Type	Method	Description
abstract void	addRegistration(BusEventKey eventKey, Registration registration)	The abstract method to add a new Registration to the Registrations map.
void	clear()	Clear all the BusEventKeys contained in the registrations map
boolean	containsKey(BusEventKey eventKey)	Check if the registrations map contains a BusEventKey
List<Registration>	get(BusEventKey eventKey)	Getter method to obtain the list of Registrations for a BusEventKey
boolean	isEmpty()	Check if the registrations map is empty or not
Set<BusEventKey>	keySet()	Obtains all the BusEventKeys contained in the registrations map as a java set of keys
int	size()	Check the size of the registrations map

Methods inherited from class java.lang.Object

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

Field Details

registrations

protected final Map<BusEventKey,List<Registration>> registrations

The map used to store the Registrations of the bus

Constructor Details

EventsRegistrationsMap

public EventsRegistrationsMap()

Method Details

get

public List<Registration> get(BusEventKey eventKey)

Getter method to obtain the list of Registrations for a BusEventKey

Parameters:

eventKey - A key for events used by the EventBus

Returns:

The list of Registrations for a BusEventKey

See Also:

• BusEventKey

isEmpty

public boolean isEmpty()

Check if the registrations map is empty or not

Returns:

A boolean value, which is true if the map 'registrations' is empty or false otherwise

size

public int size()

Check the size of the registrations map

Returns:

The size of the registrations map

containsKey

public boolean containsKey(BusEventKey eventKey)

Check if the registrations map contains a BusEventKey

Parameters:

eventKey - The passed BusEventKey to check if it's already defined into the registrations map

Returns:

A boolean value equals to 'true' if the passed BusEventKey is defined into the registrations map, or false otherwise

keySet

public Set<BusEventKey> keySet()

Obtains all the BusEventKeys contained in the registrations map as a java set of keys

Returns:

all the BusEventKeys contained in the registrations map as a java set of keys

clear

public void clear()

Clear all the BusEventKeys contained in the registrations map

addRegistration

public abstract void addRegistration(BusEventKey eventKey,
 Registration registration)

The abstract method to add a new Registration to the Registrations map.

Parameters:

eventKey - The BusEventKey used to add a new Registration.

registration - The Registration to add.