Package de.wuespace.telestion.extension.mavlink

Class MessageIndex

java.lang.Object

de.wuespace.telestion.extension.mavlink.MessageIndex

public final class MessageIndex
extends Object

Handling the linking processes of the MAVLink-message IDs to the right implementation.
Before being able to get the messages by id they must be registered here.

Note that this class should be used in a static context.

Method Summary

Modifier and Type	Method	Description
static Class<? extends MavlinkMessage>	get(long id)	Returns the MavlinkMessageClass linked to the given id. Basically HashMap.get(Object). Note that if the given id is not registered null will be returned.
static boolean	isRegistered(long id)	Returns if an id already has been linked to a MavlinkMessage.
static void	put(long id, Class<? extends MavlinkMessage> clazz)	Registers a new item by linking a new id to a class. Basically HashMap.put(Object, Object). Note that if an other MavlinkMessage has already been linked with the given id an will IllegalArgumentException be thrown.

Methods inherited from class java.lang.Object

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

Method Details

put

public static void put(long id,
 Class<? extends MavlinkMessage> clazz)

Registers a new item by linking a new id to a class.
Basically HashMap.put(Object, Object).

Note that if an other MavlinkMessage has already been linked with the given id an will IllegalArgumentException be thrown.

Parameters:

id - of the new MavlinkMessage-implementation

clazz - Class of the MavlinkMessage which should be linked

Throws:

IllegalArgumentException - if the given id is already in use

isRegistered

public static boolean isRegistered(long id)

Returns if an id already has been linked to a MavlinkMessage.

Parameters:

id - of the msg

Returns:

whether an id is already associated with a MavlinkMessage

get

public static Class<? extends MavlinkMessage> get(long id)

Returns the MavlinkMessageClass linked to the given id.
Basically HashMap.get(Object).

Note that if the given id is not registered null will be returned.

Parameters:

id - of the MavlinkMessage

Returns:

Class of the MavlinkMessage linked to the given id