org.openlcb

Class Message

java.lang.Object

org.openlcb.Message

All Implemented Interfaces:

OpenLcb

Direct Known Subclasses:

AddressedMessage, EventMessage, InitializationCompleteMessage, VerifiedNodeIDNumberMessage, VerifyNodeIDNumberMessage

@Immutable
 @ThreadSafe
public abstract class Message
extends Object
implements OpenLcb

Base for all OpenLCB message types

Messages (and therefore all subtypes) are immutable once created.

A Message works with a MessageDecoder object in a double dispatch pattern to do message specific-processing in e.g. a node implementation.

Version:

$Revision$

Author:

Bob Jacobsen Copyright 2009, 2010

See Also:

MessageDecoder

Field Summary

Fields

Modifier and Type	Field and Description
(package private) NodeID	sourceNodeID

Fields inherited from interface org.openlcb.OpenLcb

MTI_CONSUMER_IDENTIFIED, MTI_DATAGRAM, MTI_DATAGRAM_RCV_OK, MTI_DATAGRAM_REJECTED, MTI_IDENTIFY_CONSUMERS, MTI_IDENTIFY_CONSUMERS_RANGE, MTI_IDENTIFY_EVENTS, MTI_IDENTIFY_PRODUCERS, MTI_IDENTIFY_PRODUCERS_RANGE, MTI_INITIALIZATION_COMPLETE, MTI_LEARN_EVENT, MTI_OPT_INT_REJECTED, MTI_PC_EVENT_REPORT, MTI_PRODUCER_IDENTIFIED, MTI_PROTOCOL_IDENT_REPLY, MTI_PROTOCOL_IDENT_REQUEST, MTI_SIMPLE_NODE_IDENT_REPLY, MTI_SIMPLE_NODE_IDENT_REQUEST, MTI_STREAM_DATA_COMPLETE, MTI_STREAM_DATA_PROCEED, MTI_STREAM_DATA_SEND, MTI_STREAM_INIT_REPLY, MTI_STREAM_INIT_REQUEST, MTI_VERIFIED_NID, MTI_VERIFY_NID

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Message()
	Message(NodeID source)

Method Summary

Modifier and Type	Method and Description
void	applyTo(MessageDecoder decoder, Connection sender) Implement message-type-specific processing when this message is received by a node.
boolean	equals(Object o) To be equal, messages have to have the same type and content
abstract int	getMTI()
NodeID	getSourceNodeID()
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

sourceNodeID

NodeID sourceNodeID

Constructor Detail

Message

public Message(NodeID source)

Message

protected Message()

Method Detail

getSourceNodeID

public NodeID getSourceNodeID()

applyTo

public void applyTo(MessageDecoder decoder,
                    Connection sender)

Implement message-type-specific processing when this message is received by a node.

Default is to do nothing.

Parameters:

decoder - the node (or processing component) to apply to this message

sender - the source of the message

equals

public boolean equals(Object o)

To be equal, messages have to have the same type and content

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

getMTI

public abstract int getMTI()