net.ontopia.persistence.proxy
Interface TrackableCollectionIF

All Superinterfaces:
java.util.Collection, java.lang.Iterable
All Known Implementing Classes:
TrackableLazySet, TrackableSet

public interface TrackableCollectionIF
extends java.util.Collection

INTERNAL: Interface used by Collection implementations that track the changes performed on them. It keeps track of the objects that have been added and the ones that has been removed.


Method Summary
 boolean addWithTracking(java.lang.Object item)
          INTERNAL: Adds the item to the collection tracking the change.
 void clearWithTracking()
          INTERNAL: Removes all items from the collection tracking the changes.
 java.util.Collection getAdded()
          INTERNAL: Gets the objects that have been added to the set.
 java.util.Collection getRemoved()
          INTERNAL: Gets the objects that have been removed from the set.
 boolean removeWithTracking(java.lang.Object item)
          INTERNAL: Removes the item from the collection tracking the change.
 void resetTracking()
          INTERNAL: Clears the list of added and removed objects without touching the original collection.
 void selfAdded()
          INTERNAL: Consider existing collection elements as having just been added.
 
Methods inherited from interface java.util.Collection
add, addAll, clear, contains, containsAll, equals, hashCode, isEmpty, iterator, remove, removeAll, retainAll, size, toArray, toArray
 

Method Detail

resetTracking

void resetTracking()
INTERNAL: Clears the list of added and removed objects without touching the original collection.


selfAdded

void selfAdded()
INTERNAL: Consider existing collection elements as having just been added.


addWithTracking

boolean addWithTracking(java.lang.Object item)
INTERNAL: Adds the item to the collection tracking the change.


removeWithTracking

boolean removeWithTracking(java.lang.Object item)
INTERNAL: Removes the item from the collection tracking the change.


clearWithTracking

void clearWithTracking()
INTERNAL: Removes all items from the collection tracking the changes.


getAdded

java.util.Collection getAdded()
INTERNAL: Gets the objects that have been added to the set. This collection is immutable. Null is returned if the added collection has not been initialized, ie. it is empty.


getRemoved

java.util.Collection getRemoved()
INTERNAL: Gets the objects that have been removed from the set. This collection is immutable. Null is returned if the removed collection has not been initialized, ie. it is empty.



Copyright © 2000-2012 Ontopia.