com.vwp.vuapi.util
Class VUInfoTool

java.lang.Object
  extended by java.util.AbstractCollection
      extended by java.util.AbstractList
          extended by java.util.Vector
              extended by com.vwp.vuapi.util.VUInfoTool
All Implemented Interfaces:
Serializable, Cloneable, Iterable, Collection, List, RandomAccess
Direct Known Subclasses:
VUObjectInfoTool

public class VUInfoTool
extends Vector

The VUInfo objects that are provided within the different listener contexts may not contain all the information of that VUInfo object, that means some of their fields may contain the initialization values. To get full access to the information that have been collected during the runtime of an application this class can be used.
VUInfoTool inherits from java.util.Vector, to ensure correct functionality of this class, the Vectors standard add- and remove- methods should be ignored. Instead of them the VUInfoTool-methods described below should be used.
Additionally it is not allowed to mix objects that inherit from VUInfo within such an object, if different types of VUInfos have to be managed, separate VUInfoTool objects have to be created and used for each.
Also for collecting lists of VUInfo objects this class has to be used instead of a Vector to ensure the correct handling of the classes data.
Attention: This class mustn't be used together with VUObjectInfo objects, for this type of object the class VUObjectInfoTool has to be used. VUInfoTool is only able to handle objects of type VUWorldInfo and VUUserInfo

See Also:
Serialized Form

Constructor Summary
VUInfoTool()
          The default constructor
VUInfoTool(Collection c)
          An overwritten constructor, this one should not be used
 
Method Summary
 void deleteVUInfo(VUInfo vui)
          Deletes a VUInfo object out of the list; to find that object at least the ID or the name has to be provided
 VUInfo getVUInfo(VUInfo vui)
          Returns a VUInfo object that has been stored; to find that object at least the ID or the name have to be provided
 VUInfo setVUInfo(VUInfo vui)
          This method is used to set newly available or changed VUInfo members that do not inherit from VUObjectInfo.
 
Methods inherited from class java.util.Vector
add, add, addAll, addAll, addElement, capacity, clear, clone, contains, containsAll, copyInto, elementAt, elements, ensureCapacity, equals, firstElement, get, hashCode, indexOf, indexOf, insertElementAt, isEmpty, lastElement, lastIndexOf, lastIndexOf, remove, remove, removeAll, removeAllElements, removeElement, removeElementAt, retainAll, set, setElementAt, setSize, size, subList, toArray, toArray, toString, trimToSize
 
Methods inherited from class java.util.AbstractList
iterator, listIterator, listIterator
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface java.util.List
iterator, listIterator, listIterator
 

Constructor Detail

VUInfoTool

public VUInfoTool()
The default constructor


VUInfoTool

public VUInfoTool(Collection c)
An overwritten constructor, this one should not be used

Parameters:
c -
Method Detail

setVUInfo

public VUInfo setVUInfo(VUInfo vui)
This method is used to set newly available or changed VUInfo members that do not inherit from VUObjectInfo. To collect all information after a VUInfo object has be provided by a listener this method should be called using
newInfo=setVUInfo(newInfo)
. Afterwards newInfo conains all information that are available for that object.

Parameters:
vui - the new VUInfo object whose information have to be added newly or using a VUInfo object that already has been stored
Returns:
the VUInfo object that possibly has been filled with more information

getVUInfo

public VUInfo getVUInfo(VUInfo vui)
Returns a VUInfo object that has been stored; to find that object at least the ID or the name have to be provided

Parameters:
vui - a VUInfo structure containing the ID or the name of the VUInfo object that has to be fetched
Returns:
the VUInfo object or null if no object with that name or ID could be found

deleteVUInfo

public void deleteVUInfo(VUInfo vui)
Deletes a VUInfo object out of the list; to find that object at least the ID or the name has to be provided

Parameters:
vui - a VUInfo structure containing the ID or the name of the VUInfo object that has to be deleted