net.sf.marineapi.nmea.event

Class AbstractSentenceListener<T extends Sentence>

java.lang.Object

net.sf.marineapi.nmea.event.AbstractSentenceListener<T>

Type Parameters:

T - Sentence interface to be listened.

All Implemented Interfaces:

EventListener, SentenceListener

public abstract class AbstractSentenceListener<T extends Sentence>
extends Object
implements SentenceListener

Abstract base class for typed listeners with automatic sentence type resolving and casting. Extend this class to create a listener/handler for a single sentence type and register it in SentenceReader.

Methods of SentenceListener interface implemented by this class are empty, except sentenceRead(SentenceEvent) which detects the incoming sentence parsers and casts them to correct interface before calling sentenceRead(Sentence) method.

Author:

Kimmo Tuukkanen

See Also:

SentenceReader

Constructor Summary

Constructors

Constructor and Description
AbstractSentenceListener()

Method Summary

Methods

Modifier and Type	Method and Description
void	readingPaused() Empty implementation.
void	readingStarted() Empty implementation.
void	readingStopped() Empty implementation.
void	sentenceRead(SentenceEvent event) Resolves the type of each received sentence parser and passes it to sentenceRead(T) if the type matches the expected type T.
abstract void	sentenceRead(T sentence) Invoked when sentence of type T has been read and parsed.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractSentenceListener

public AbstractSentenceListener()

Method Detail

readingPaused

public void readingPaused()

Empty implementation.

Specified by:

readingPaused in interface SentenceListener

See Also:

SentenceListener.readingPaused()

readingStarted

public void readingStarted()

Empty implementation.

Specified by:

readingStarted in interface SentenceListener

See Also:

SentenceListener.readingStarted()

readingStopped

public void readingStopped()

Empty implementation.

Specified by:

readingStopped in interface SentenceListener

See Also:

SentenceListener.readingStopped()

sentenceRead

public abstract void sentenceRead(T sentence)

Invoked when sentence of type T has been read and parsed.

Parameters:

sentence - Sentence of type T.

sentenceRead

public void sentenceRead(SentenceEvent event)

Resolves the type of each received sentence parser and passes it to sentenceRead(T) if the type matches the expected type T.

This method may be overridden, but be sure to call super.sentencerRead(SentenceEvent) before or after your additional event handling. However, for listeners that need to handle all incoming sentences, it's recommended to directly implement the SentenceListener interface.

Specified by:

sentenceRead in interface SentenceListener

Parameters:

event - SentenceEvent containing the data.

See Also:

SentenceListener.sentenceRead(net.sf.marineapi.nmea.event.SentenceEvent)