modeling.messaging

Class Port

java.lang.Object

modeling.messaging.Port

public class Port
extends Object

A fancy name for a String.

A Port is a part of an atomic model's mean of communication. Every message sent or received by an atomic model must travel through one of its Ports.

There are no default names for Ports, but common ones are "in" and "out". The uniqueness of the name is important for equality between two Port objects is checked using their name.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	_name The name of the Port.

Constructor Summary

Constructors

Constructor and Description
Port(String name) Constructor with a parameter.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o) Checks the equality between the name of this Port and the name of the Port given in parameter.
int	hashCode() The hash code of a Port is the hash code of its name attribute.
String	name() A getter to the name attribute.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

_name

protected String _name

The name of the Port. Must be unique among all the ports of a given atomic model.

Constructor Detail

Port

public Port(String name)

Constructor with a parameter.

Parameters:

name - the (unique) name of the Port. Uniqueness is not verified, it is up to the developer to guaranty it.

Method Detail

name

public String name()

A getter to the name attribute.

Returns:

the name of the Port.

toString

public String toString()

Overrides:

toString in class Object

Returns:

the name of this port.

equals

public boolean equals(Object o)

Checks the equality between the name of this Port and the name of the Port given in parameter. Two different instances of the Port object but with the same name are considered equal.

The

Overrides:

equals in class Object

Parameters:

o - an Object to check the equality with.

Returns:

true if o is a Port with the same name as this Port. False otherwise.

hashCode

public int hashCode()

The hash code of a Port is the hash code of its name attribute.

Overrides:

hashCode in class Object

Returns:

the hash code of the name attribute.