frodo2.algorithms.adopt.ENDmsg< Val extends Addable< Val > > Class Template Reference

The message used to send a terminate message to a variable's children. More...

Inheritance diagram for frodo2.algorithms.adopt.ENDmsg< Val extends Addable< Val > >:

Public Member Functions
	ENDmsg ()
	Empty constructor.
	ENDmsg (String sender, String receiver, HashMap< String, Val > context)
	Constructor.
boolean	equals (Object msg)
void	writeExternal (ObjectOutput out) throws IOException
void	readExternal (ObjectInput in) throws IOException, ClassNotFoundException
String	getSender ()
	Getter function.
String	getReceiver ()
	Getter function.
HashMap< String, Val >	getContext ()
	Getter function.
String	toString ()
Public Member Functions inherited from frodo2.communication.Message
	Message (MessageType type)
	Constructor.
	Message ()
	Empty constructor.
MessageType	getType ()
void	fakeSerialize ()
	Pretends to serialize the message.

Package Attributes
String	receiver
	The receiving variable.

Private Attributes
String	sender
	The sending variable.
HashMap< String, Val >	context
	The context in which this message was created.

Static Private Attributes
static final long	serialVersionUID = 2153239219905600645L
	Used for serialization.

Additional Inherited Members
Protected Attributes inherited from frodo2.communication.Message
MessageType	type
	The type of this message.

Detailed Description

The message used to send a terminate message to a variable's children.

Parameters

<Val>

the type used for variable values

Constructor & Destructor Documentation

ENDmsg() [1/2]

frodo2.algorithms.adopt.ENDmsg< Val extends Addable< Val > >.ENDmsg

(

)

Empty constructor.

References frodo2.algorithms.adopt.ADOPT< Val extends Addable< Val >, U extends Addable< U > >.Original< Val extends Addable< Val >, U extends Addable< U > >.TERMINATE_MSG_TYPE.

Referenced by ENDmsg(), and equals().

ENDmsg() [2/2]

frodo2.algorithms.adopt.ENDmsg< Val extends Addable< Val > >.ENDmsg	(	String	sender,
		String	receiver,
		HashMap< String, Val >	context )

Constructor.

Parameters

sender	the sender variable
receiver	the recipient variable
context	the context

References context, ENDmsg(), receiver, sender, and frodo2.algorithms.adopt.ADOPT< Val extends Addable< Val >, U extends Addable< U > >.Original< Val extends Addable< Val >, U extends Addable< U > >.TERMINATE_MSG_TYPE.

Here is the call graph for this function:

Member Function Documentation

equals()

boolean frodo2.algorithms.adopt.ENDmsg< Val extends Addable< Val > >.equals

(

Object

msg

)

See also

java.lang.Object#equals(java.lang.Object)

References context, ENDmsg(), equals(), frodo2.communication.Message.getType(), frodo2.communication.Message.Message(), receiver, and sender.

Referenced by equals().

Here is the call graph for this function:

getContext()

HashMap< String, Val > frodo2.algorithms.adopt.ENDmsg< Val extends Addable< Val > >.getContext

(

)

Getter function.

Returns

the context

References context.

Referenced by frodo2.algorithms.adopt.ADOPT< Val extends Addable< Val >, U extends Addable< U > >.Original< Val extends Addable< Val >, U extends Addable< U > >.handleTERMINATEmessage().

getReceiver()

String frodo2.algorithms.adopt.ENDmsg< Val extends Addable< Val > >.getReceiver

(

)

Getter function.

Returns

the variable that is to receive this message

References receiver.

getSender()

String frodo2.algorithms.adopt.ENDmsg< Val extends Addable< Val > >.getSender

(

)

Getter function.

Returns

the variable that sent this message

References sender.

readExternal()

void frodo2.algorithms.adopt.ENDmsg< Val extends Addable< Val > >.readExternal

(

ObjectInput

in

)

throws IOException, ClassNotFoundException

See also

java.io.Externalizable#readExternal(java.io.ObjectInput)

Reimplemented from frodo2.communication.Message.

References readExternal().

Referenced by readExternal().

Here is the call graph for this function:

toString()

String frodo2.algorithms.adopt.ENDmsg< Val extends Addable< Val > >.toString

(

)

See also

Message.toString()

Reimplemented from frodo2.communication.Message.

writeExternal()

void frodo2.algorithms.adopt.ENDmsg< Val extends Addable< Val > >.writeExternal

(

ObjectOutput

out

)

throws IOException

See also

java.io.Externalizable#writeExternal(java.io.ObjectOutput)

Reimplemented from frodo2.communication.Message.

Member Data Documentation

context

HashMap<String, Val> frodo2.algorithms.adopt.ENDmsg< Val extends Addable< Val > >.context

private

The context in which this message was created.

Referenced by ENDmsg(), equals(), and getContext().

receiver

String frodo2.algorithms.adopt.ENDmsg< Val extends Addable< Val > >.receiver

package

The receiving variable.

Referenced by ENDmsg(), equals(), and getReceiver().

sender

String frodo2.algorithms.adopt.ENDmsg< Val extends Addable< Val > >.sender

private

The sending variable.

Referenced by ENDmsg(), equals(), and getSender().

serialVersionUID

final long frodo2.algorithms.adopt.ENDmsg< Val extends Addable< Val > >.serialVersionUID = 2153239219905600645L

staticprivate

Used for serialization.

---

The documentation for this class was generated from the following file:

• src/frodo2/algorithms/adopt/ENDmsg.java