Package jmri.jmrix

Interface MessageFormatter

All Known Subinterfaces:

XPressNetMessageFormatter, Z21MessageFormatter

All Known Implementing Classes:

HornbyEliteMultiUnitInfoReplyFormatter, XNet128SpeedStepModeSpeedAndDirectionFormatter, XNet14SpeedStepModeSpeedAndDirectionFormatter, XNet27SpeedStepModeSpeedAndDirectionFormatter, XNet28SpeedStepModeSpeedAndDirectionFormatter, XNetBCModelTimeFormatter, XNetBroadcastEmergencyStopFormatter, XNetCommandStationInfoResponseFormatter, XNetCommandStationRequestFormatter, XNetCSPowerOnStatusRequestMessageFormatter, XNetCSSoftwareVersionReplyFormatter, XNetCSStatusReplyFormatter, XNetDHandMUErrorMessageFormatter, XNetDirectModelTimeFormatter, XNetDoubleHeaderRequestMessageFormatter, XNetEstopAllRequestMessageFormatter, XNetEstopLocoRequestMessageFormatter, XNetFeedbackReplyFormatter, XNetFeedbackRequestCommandMessageFormatter, XNetFunctionGroup10MomentaryRequestMessageFormatter, XNetFunctionGroup10OperateRequestMessageFormatter, XNetFunctionGroup1MomentaryRequestMessageFormatter, XNetFunctionGroup1OperateRequestMessageFormatter, XNetFunctionGroup2MomentaryRequestMessageFormatter, XNetFunctionGroup2OperateRequestMessageFormatter, XNetFunctionGroup3MomentaryRequestMessageFormatter, XNetFunctionGroup3OperateRequestMessageFormatter, XNetFunctionGroup4MomentaryRequestMessageFormatter, XNetFunctionGroup4OperateRequestMessageFormatter, XNetFunctionGroup5MomentaryRequestMessageFormatter, XNetFunctionGroup5OperateRequestMessageFormatter, XNetFunctionGroup6MomentaryRequestMessageFormatter, XNetFunctionGroup6OperateRequestMessageFormatter, XNetFunctionGroup7MomentaryRequestMessageFormatter, XNetFunctionGroup7OperateRequestMessageFormatter, XNetFunctionGroup8MomentaryRequestMessageFormatter, XNetFunctionGroup8OperateRequestMessageFormatter, XNetFunctionGroup9MomentaryRequestMessageFormatter, XNetFunctionGroup9OperateRequestMessageFormatter, XNetLI101AddressReplyFormatter, XNetLI101BaudReplyFormatter, XNetLI101RequestMessageFormatter, XNetLIReplyFormatter, XNetLIVersionReplyFormatter, XNetLocoFunctionMomentaryStatusReplyFormatter, XNetLocoFunctionStatusHighReplyFormatter, XNetLocoInfoDHUnitFormatter, XNetLocoInfoMUAddressFormatter, XNetLocoInfoNormalUnitHighFunctionMomentaryStatusFormatter, XNetLocoInfoNormalUnitReplyFormatter, XNetLocoStatusRequestMessageFormatter, XNetMultiUnitInfoReplyFormatter, XNetMultiUnitSearchRequestMessageFormatter, XNetOpsModeReadResultFormatter, XNetOpsModeRequestMessageFormatter, XNetProgReadMessageFormatter, XNetProgWriteMessageFormatter, XNetRequestMultiUnitAddLocoMessageFormatter, XNetRequestMultiUnitRemoveLocoMessageFormatter, XNetSearchMURequestMessageFormatter, XNetServiceModeResponseFormatter, XNetStackSearchReplyFormatter, XNetThrottleTakenOverReplyFormatter, XNetTurnoutCommandMessageFormatter, XNetV1SoftwareVersionReplyFormatter, XPressnetInterfaceVersionRequestMessageFormatter, Z21BroadcastFlagsReplyFormatter, Z21BroadcastFlagsRequestFormatter, Z21CANDetectorReplyFormatter, Z21CANDetectorRequestFormatter, Z21FastClockDataReplyFormatter, Z21HardwareInfoReplyFormatter, Z21HardwareInfoRequestFormatter, Z21LanLogOffRequestFormatter, Z21LocoNetTunnelReplyFormatter, Z21LocoNetTunnelRequestFormatter, Z21RailComDataRequestFormatter, Z21RailComReplyFormatter, Z21RMBusFeedbackReplyFormatter, Z21RMBusGetDataRequestFormatter, Z21RMBusProgramModuleRequestFormatter, Z21SerialNumberReplyFormatter, Z21SerialNumberRequestMessageFormatter, Z21SetBroadCastFlagsRequestFormatter, Z21SystemStateChangedDataRequestFormatter, Z21SystemStateReplyFormatter, Z21XNetCVReplyFormatter, Z21XNetLocoReplyFormatter, Z21XNetTurnoutMessageFormatter, Z21XNetTurnoutReplyFormatter, Z21XPressNetTunnelReplyFormatter, Z21XPressNetTunnelRequestFormatter

public interface MessageFormatter

Interface for classes that translate @Ref{Message} objects into strings

Method Summary

Modifier and Type	Method	Description
java.lang.String	formatMessage(Message m)	Format the message into a string
boolean	handlesMessage(Message m)	Determine if this formatter can handle the message

Method Detail

handlesMessage

boolean handlesMessage(Message m)

Determine if this formatter can handle the message

Parameters:

m - message to check

Returns:

true if this formatter can handle the message

formatMessage

java.lang.String formatMessage(Message m)

Format the message into a string

Parameters:

m - message to format

Returns:

formatted string