Package fr.univ_artois.lgi2a.similar.microkernel.dynamicstate

Interface IPublicDynamicStateMap

All Known Implementing Classes:

DynamicStateFilteredMap, DynamicStateMap

public interface IPublicDynamicStateMap

Models a map containing public local dynamic states.

Usage

This interface and its subsequent classes are defined to facilitate the use of dynamic states in the perception and natural methods, without having to create map duplicates.

Author:

Yoann Kubera

Method Summary

Modifier and Type	Method	Description
IPublicLocalDynamicState	get(LevelIdentifier level)	Gets the dynamic state of a level contained in this map.
Set<LevelIdentifier>	keySet()	Gets the levels which dynamic state is contained in this map.
void	put(IPublicLocalDynamicState state)	Puts a dynamic state into this map.

Method Detail

keySet

Set<LevelIdentifier> keySet()

Gets the levels which dynamic state is contained in this map.

This method has to ensure that two consecutive iterations over this set always return its items in the same order.

Returns:

The identifier of the levels contained in this map.

get

IPublicLocalDynamicState get(LevelIdentifier level)

Gets the dynamic state of a level contained in this map.

Parameters:

level - The level of the dynamic state.

Returns:

The dynamic state of the level.

Throws:

IllegalArgumentException - If the argument is null.

NoSuchElementException - If the level identifier is not a key in this map.

put

void put(IPublicLocalDynamicState state)

Puts a dynamic state into this map.

Parameters:

state - The public local dynamic state of to add to this map.