com.ibm.broker.config.appdev

Class Terminal

  • java.lang.Object
    • com.ibm.broker.config.appdev.Terminal
  • All Implemented Interfaces:
    java.io.Serializable
    Direct Known Subclasses:
    InputTerminal, OutputTerminal


    public abstract class Terminal
    extends java.lang.Object
    implements java.io.Serializable

    The abstract superclass that represents all possible terminal types for a node.

    There are two terminal types, InputTerminal and OutputTerminal. Each node will contain zero or more InputTerminals and zero or more OutputTerminals. An input node is a node which contains no input terminals, as it forms the point from which messages are generated.

    Terminals form the logical connection points between nodes. Messages flow from the output terminal of one node to the input terminal of another node.

    To work with terminals, gain handles to them from the owning node. For example:

                          File msgFlow1 = new File("Test.msgflow");
                MessageFlow mf1 = FlowRendererMSGFLOW.read(msgFlow1);
                Node inputNode = mf1.getNodeByName("input from queue");
                Terminal t = inputNode.getOutputTerminal("out");
     
     Change Activity:
     -------- ----------- -------------   ------------------------------------
     Reason:  Date:       Originator:     Comments:
     -------- ----------- -------------   ------------------------------------
     xxxxx.x  2010-07-28  HDMPL           creation
     xxxxx.x  2010-08-10  dstorey         v7.0.0.2 Release
     xxxxx.x  2011-07-06  dstorey         v8.0.0.0 Release
     
    See Also:
    Serialized Form
    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static java.lang.String copyright 
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      boolean equals(java.lang.Object compare)
      Returns true if and only if the supplied Terminal is equivalent to the current Terminal
      java.lang.String getName()
      Returns the name of the Terminal
      Node getOwningNode()
      Returns the Node instance to which this terminal is logically attached.
      java.lang.String toString() 
      • Methods inherited from class java.lang.Object

        getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Method Detail

      • getName

        public java.lang.String getName()
        Returns the name of the Terminal
        Returns:
        String terminal name, for example "out".
      • getOwningNode

        public Node getOwningNode()
        Returns the Node instance to which this terminal is logically attached.
        Returns:
        Node
      • equals

        public boolean equals(java.lang.Object compare)
        Returns true if and only if the supplied Terminal is equivalent to the current Terminal
        Overrides:
        equals in class java.lang.Object
        Parameters:
        compare - Terminal for comparison
        Returns:
        boolean true if and only if the Terminals are equivalent
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object