com.ergotech.secs

Class Logger

java.lang.Object

com.ergotech.secs.Logger

All Implemented Interfaces:

LoggerInterface, SecsEventListener, java.util.EventListener

public class Logger
extends java.lang.Object
implements LoggerInterface, SecsEventListener

Field Summary

Fields inherited from interface com.ergotech.secs.SecsEventListener

cvsRev

Constructor Summary

Constructors

Constructor and Description
Logger(java.lang.String receiveString, java.lang.String sendString) Construct the logger with the strings that will be displayed for sent and received data.

Method Summary

Modifier and Type	Method and Description
void	displayBytes(byte[] data) Displays the provided data as hex values.
boolean	getDisplayBytes() Returns whether the logger will display message data.
boolean	getDisplayMessages() Returns whether the logger will display message data.
void	received(byte[] data) This will display received bytes.
void	received(SecsMsg msg) Called whenever a message is received.
void	register() Register for all events with the default event handler.
void	register(SecsEventHandler theHandler) Register for all events with the specified event handler.
void	registerForId(int id) Register for a specific event with the default event handler.
void	registerForId(SecsEventHandler theHandler, int id) Register for a specific event with the specified event handler.
void	secsEvent(SecsEvent theEvent) The implementation of the SecsEventListener interface.
void	sent(byte[] data) This will display sent bytes.
void	sent(SecsMsg msg) Called whenever a message is sent.
void	setDisplayBytes(boolean newValue) Determines whether the logger will display byte data.
void	setDisplayEvents(boolean newValue) This method will turn on the display of all events.
void	setDisplayMessages(boolean newValue) Determines whether the logger will display message data.

Methods inherited from class java.lang.Object

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

Constructor Detail

Logger

public Logger(java.lang.String receiveString,
              java.lang.String sendString)

Construct the logger with the strings that will be displayed for sent and received data.

Method Detail

displayBytes

public void displayBytes(byte[] data)

Displays the provided data as hex values.

Parameters:

data - the array to display

getDisplayBytes

public boolean getDisplayBytes()

Returns whether the logger will display message data.

getDisplayMessages

public boolean getDisplayMessages()

Returns whether the logger will display message data.

received

public void received(byte[] data)

This will display received bytes.

Specified by:

received in interface LoggerInterface

Parameters:

data - the array of bytes to display. This need not be a complete message or even a complete block.

received

public void received(SecsMsg msg)

Called whenever a message is received. This will display the message.

Specified by:

received in interface LoggerInterface

Parameters:

msg - the message to display

register

public void register()

Register for all events with the default event handler.

register

public void register(SecsEventHandler theHandler)

Register for all events with the specified event handler.

registerForId

public void registerForId(int id)

Register for a specific event with the default event handler.

registerForId

public void registerForId(SecsEventHandler theHandler,
                          int id)

Register for a specific event with the specified event handler.

secsEvent

public void secsEvent(SecsEvent theEvent)

The implementation of the SecsEventListener interface. This will display the event.

Specified by:

secsEvent in interface SecsEventListener

sent

public void sent(byte[] data)

This will display sent bytes.

Specified by:

sent in interface LoggerInterface

Parameters:

data - the array of bytes to display. This need not be a complete message or even a complete block.

sent

public void sent(SecsMsg msg)

Called whenever a message is sent. This will display the message.

Specified by:

sent in interface LoggerInterface

Parameters:

msg - the message to display

setDisplayBytes

public void setDisplayBytes(boolean newValue)

Determines whether the logger will display byte data.

Specified by:

setDisplayBytes in interface LoggerInterface

Parameters:

newValue - set to true to display byte data, otherwise false

setDisplayEvents

public void setDisplayEvents(boolean newValue)

This method will turn on the display of all events. It will do this regardless of the value of the boolean.

Specified by:

setDisplayEvents in interface LoggerInterface

setDisplayMessages

public void setDisplayMessages(boolean newValue)

Determines whether the logger will display message data.

Specified by:

setDisplayMessages in interface LoggerInterface

Parameters:

newValue - set to true to display byte data, otherwise false