com.vwp.vuapi.util
Class VUObjectInfoTool

java.lang.Object
  java.util.AbstractCollection
      java.util.AbstractList
          java.util.Vector
              com.vwp.vuapi.util.VUInfoTool
                  com.vwp.vuapi.util.VUObjectInfoTool

All Implemented Interfaces:

Serializable, Cloneable, Iterable, Collection, List, RandomAccess

public class VUObjectInfoTool
extends VUInfoTool

The VUObjectInfo objects that are provided within the different listener contexts may not contain all the information of that VUObjectInfo object, that means some of their fields still 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.
VUObjectInfoTool inherits from VUInfoTool and has to be used for world objects like they are managed by VUObjectInfo and their subclasses. To ensure the correct functionality of this class, the inherited standard add- and remove- methods of the base class Vector should be ignored. Instead of them the VUObjectInfoTool-methods described below should be used.
Additionally it is not allowed to use objects that inherit from VUInfo but not from VUObjectInfo with such an object.
Also for collecting lists of VUObjectInfo objects this class has to be used instead of a Vector to ensure the correct handling of the classes data.

See Also:

Serialized Form

Constructor Summary

VUObjectInfoTool()

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

Method Summary

void	deleteVUInfo(VUObjectInfo vui) Deletes a VUObjectInfo object out of the list; to find that object at least the ID or the name has to be provided
VUObjectInfo	getVUInfo(VUObjectInfo vui) Returns a VUObjectInfo object that has been stored; to find that object at least the ID or the name has to be provided
VUObjectInfo	setVUInfo(VUObjectInfo vui) This method is used to set newly available or changed VUObjectInfo members.

Methods inherited from class com.vwp.vuapi.util.VUInfoTool

deleteVUInfo, getVUInfo, setVUInfo

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

VUObjectInfoTool

public VUObjectInfoTool()

VUObjectInfoTool

public VUObjectInfoTool(Collection c)

An overwritten constructor, this one should not be used

Parameters:

c -

Method Detail

setVUInfo

public VUObjectInfo setVUInfo(VUObjectInfo vui)

This method is used to set newly available or changed VUObjectInfo members. To collect all information after a VUObjectInfo 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 VUObjectInfo object whose information have to be added newly or using a VUInfo object that already has been stored

Returns:

the VUObjectInfo object that possibly has been filled with more information

getVUInfo

public VUObjectInfo getVUInfo(VUObjectInfo vui)

Returns a VUObjectInfo object that has been stored; to find that object at least the ID or the name has to be provided

Parameters:

vui - a VUObjectInfo structure containing the ID or the name of the VUObjectInfo object that has to be fetched

Returns:

the VUObjectInfo object or null if no object with that name or ID could be found

deleteVUInfo

public void deleteVUInfo(VUObjectInfo vui)

Deletes a VUObjectInfo object out of the list; to find that object at least the ID or the name has to be provided

Parameters:

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