Nodenet Problem Set Javadocs

nodenet
Class InputChannelVector

java.lang.Object
  extended bynodenet.InputChannelVector
All Implemented Interfaces:
java.io.Serializable

public class InputChannelVector
extends java.lang.Object
implements java.io.Serializable

InputChannelVector is something which acts like a Vector of InputChannels instead of Objects.

The methods of this class were previously synchronized, but Sun's Vector class uses synchronized methods. Since our only data field is the already synchronized Vector, locking on this object is redundant.

Version:
$Id: InputChannelVector.java,v 1.7 2004/01/14 20:23:21 gus Exp $
Author:
Todd C. Parnell, tparnell@ai.mit.edu, Patrick G. Heck, gus.heck@olin.edu
See Also:
Serialized Form

Constructor Summary
InputChannelVector(Node owner)
          Constructs a new InputChannelVector.
 
Method Summary
 void addElement(InputChannel obj)
          Adds an object to the InputChannelVector.
 boolean contains(java.lang.Object elem)
          Checks to see if it contains an element.
 InputChannel elementAt(int index)
          Returns the InputChannel at a certain index.
 java.util.Enumeration elements()
          Transforms InputChannelVector into yet another type of collection of objects, called an Enumeration.
 InputChannel firstElement()
          Returns the first InputChannel in the InputChannelVector.
 Node getOwner()
          Find out who the owner of this object is.
 boolean isEmpty()
          Returns true if the InputChannelVector is empty.
 InputChannel lastElement()
          Returns the last InputChannel in the InputChannelVector.
 void removeAllElements()
          Removes all elements from the InputChannelVector.
 boolean removeElement(InputChannel obj)
          Removes a specific element from the InputChannelVector.
 int size()
          Returns the size of the InputChannelVector.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

InputChannelVector

public InputChannelVector(Node owner)
Constructs a new InputChannelVector.

Method Detail

getOwner

public Node getOwner()
Find out who the owner of this object is.

Returns:
a reference to the owning Node

addElement

public final void addElement(InputChannel obj)
Adds an object to the InputChannelVector.


contains

public final boolean contains(java.lang.Object elem)
Checks to see if it contains an element.


elementAt

public final InputChannel elementAt(int index)
Returns the InputChannel at a certain index.

Parameters:
index - index of the InputChannel being looked up

elements

public final java.util.Enumeration elements()
Transforms InputChannelVector into yet another type of collection of objects, called an Enumeration.


firstElement

public final InputChannel firstElement()
Returns the first InputChannel in the InputChannelVector.


isEmpty

public final boolean isEmpty()
Returns true if the InputChannelVector is empty.


lastElement

public final InputChannel lastElement()
Returns the last InputChannel in the InputChannelVector.


removeAllElements

public final void removeAllElements()
Removes all elements from the InputChannelVector.


removeElement

public final boolean removeElement(InputChannel obj)
Removes a specific element from the InputChannelVector.

Parameters:
obj - the object being removed

size

public final int size()
Returns the size of the InputChannelVector.


Nodenet Problem Set Javadocs