net.sf.sdedit.message
Class ForwardMessage

java.lang.Object
  net.sf.sdedit.message.Message
      net.sf.sdedit.message.ForwardMessage

All Implemented Interfaces:

Constants

Direct Known Subclasses:

BroadcastMessage, ConstructorMessage, MessageToSelf, Primitive

public class ForwardMessage
extends Message

A ForwardMessage is a normal message sent from a lifeline to another one. If the receiving lifeline (the callee) is not an actor, it becomes active, or, if it already is active, it occurs twice in the trace of activity, represented by another sub-lifeline attached to the original lifeline.

Author:

Markus Strauch

Field Summary

Fields inherited from class net.sf.sdedit.message.Message

diagram

Fields inherited from interface net.sf.sdedit.Constants

ACTIVE_LIFELINE_COLOR, ANTI_ALIAS, dashed, DEFAULT_CODE_FONT, DEFAULT_CURSOR, DEFAULT_ENCODING_SCHEME, dotted, emptyStroke, GLOBAL_CONF_FILE, HAND_CURSOR, MOVE_CURSOR, SAVE_AS_FILE_PROPERTY, SAVE_AS_TYPE_PROPERTY, solid, TEST_FREEHEP_CLASSNAME, thick, thick_dashed, THREAD_COLORS

Constructor Summary

ForwardMessage(Lifeline caller, Lifeline callee, Diagram diagram, MessageData data)
Creates a new forward message to be drawn.

Method Summary

Answer	getAnswerMessage() Returns the answer to this forward message, if there is one, otherwise null.
String	getText() Returns the text of the message, the string the message arrow is labeled by.
protected boolean	isActivating() Returns a flag denoting if this message activates its receiver.
void	updateView() Creates some space on the diagram, so that the message arrow and its label can be drawn, then draws them and creates some more space.

Methods inherited from class net.sf.sdedit.message.Message

extendLifelines, getArrow, getCallee, getCaller, getConfiguration, getData, getDiagram, getThread, isSynchronous, setArrow, toString, v

Methods inherited from class java.lang.Object

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

Constructor Detail

ForwardMessage

public ForwardMessage(Lifeline caller,
                      Lifeline callee,
                      Diagram diagram,
                      MessageData data)

Creates a new forward message to be drawn.

Parameters:

caller - the caller lifeline

callee - the callee lifeline

diagram - the diagram where to draw

data - the data of the message

Method Detail

getAnswerMessage

public Answer getAnswerMessage()

Returns the answer to this forward message, if there is one, otherwise null. If this is a forward message to an actor, there is no answer. Otherwise an AnswerMessage instance with the same MessageData attached is returned, so the answer found in this data is an appropriate label of an arrow representing the answer.

Returns:

the answer to this forward message, if there is one, otherwise null

isActivating

protected final boolean isActivating()

Returns a flag denoting if this message activates its receiver.

Returns:

a flag denoting if this message activates its receiver

updateView

public void updateView()

Description copied from class: Message

Creates some space on the diagram, so that the message arrow and its label can be drawn, then draws them and creates some more space. Changes the state of the diagram so that the effects of the message are reflected. When creating space, the lifelines that do not participate in the message must be drawn according to their current state (via Message.extendLifelines(int).

Specified by:

updateView in class Message

getText

public String getText()

Description copied from class: Message

Returns the text of the message, the string the message arrow is labeled by.

Specified by:

getText in class Message

Returns:

the text of the message, the string the message arrow is labeled by

See Also:

Message.getText()