wonderly.jeaprs
Interface Client

All Known Implementing Classes:

ClientImpl

public interface Client

This interface should be implemented by all clients of the JeAPRS system. An APRSClient implementation can be plugged into JeAPRS and made to work easily with the system. There is an default implementation of this interface available to simplify the creation of new applications for JeAPRS use.

Version:

1.0

Author:

Gregg Wonderly - The information contained in this document is Copyright 2001-2003, Gregg Wonderly, all rights reserved.

See Also:

APRSClientImpl

Method Summary

void	addAPRSEventGenerator(wonderly.jeaprs.aprs.packet.APRSEventGenerator gen) Used to set the input event stream generator for this module to use
void	addAPRSOutputStream(wonderly.jeaprs.TNC out) Used to set the output stream used
wonderly.jeaprs.aprs.packet.APRSEventGenerator[]	getAPRSEventGenerators() Used to get the current input event stream generator
wonderly.jeaprs.TNC[]	getAPRSOutputStreams() Used to query the output stream currently used.
java.lang.String	getName()
wonderly.jeaprs.aprs.APRSUIFactory	getUIFactory() Returns the UI factory used to generate the UI for this module if a UI applies
boolean	isDirty()
boolean	isInputUser() Does this module need an event input stream
boolean	isOutputUser() Does this module need an output stream
void	removeAPRSEventGenerator(wonderly.jeaprs.aprs.packet.APRSEventGenerator gen) Used to remove the input event stream generator
void	removeAPRSOutputStream(wonderly.jeaprs.TNC out) Used to remove the indicated output stream used
void	setDirty(boolean how) Set whether this client needs to have its properties saved
void	setName(java.lang.String name) Sets the name used for this instance of this client module
void	start()
void	stop()
java.lang.String	toString() Returns name of Client for display in lists

Method Detail

isOutputUser

public boolean isOutputUser()

Does this module need an output stream

isInputUser

public boolean isInputUser()

Does this module need an event input stream

addAPRSOutputStream

public void addAPRSOutputStream(wonderly.jeaprs.TNC out)

Used to set the output stream used

removeAPRSOutputStream

public void removeAPRSOutputStream(wonderly.jeaprs.TNC out)

Used to remove the indicated output stream used

getAPRSOutputStreams

public wonderly.jeaprs.TNC[] getAPRSOutputStreams()

Used to query the output stream currently used.

addAPRSEventGenerator

public void addAPRSEventGenerator(wonderly.jeaprs.aprs.packet.APRSEventGenerator gen)

Used to set the input event stream generator for this module to use

removeAPRSEventGenerator

public void removeAPRSEventGenerator(wonderly.jeaprs.aprs.packet.APRSEventGenerator gen)

Used to remove the input event stream generator

getAPRSEventGenerators

public wonderly.jeaprs.aprs.packet.APRSEventGenerator[] getAPRSEventGenerators()

Used to get the current input event stream generator

toString

public java.lang.String toString()

Returns name of Client for display in lists

Overrides:

toString in class java.lang.Object

setName

public void setName(java.lang.String name)

Sets the name used for this instance of this client module

getName

public java.lang.String getName()

getUIFactory

public wonderly.jeaprs.aprs.APRSUIFactory getUIFactory()

Returns the UI factory used to generate the UI for this module if a UI applies

start

public void start()

stop

public void stop()

isDirty

public boolean isDirty()

Returns:

true if properties of client have changed and need to be saved

setDirty

public void setDirty(boolean how)

Set whether this client needs to have its properties saved