org.starhope.appius.user
Class UserListIterator

java.lang.Object
  extended by org.starhope.appius.user.UserListIterator
All Implemented Interfaces:
Iterator<UserListEntry>, RecordLoader<UserListEntry>, HasSubversionRevision
Direct Known Subclasses:
UserListSQLIterator

public abstract class UserListIterator
extends Object
implements Iterator<UserListEntry>, RecordLoader<UserListEntry>

WRITEME: Document this type.

Author:
brpocock@star-hope.org

Field Summary
protected  String moniker
          WRITEME
protected  int userID
          WRITEME
protected  String userLogin
          WRITEME
 
Constructor Summary
protected UserListIterator(AbstractUser user, String listMoniker)
          WRITEME: Document this constructor brpocock@star-hope.org
 
Method Summary
abstract  void add(AbstractUser user)
          Add another user to the list represented by this iterator
 void remove()
           
abstract  void remove(AbstractUser interestingFellow)
          WRITEME: Document this method brpocock@star-hope.org
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface java.util.Iterator
hasNext, next
 
Methods inherited from interface org.starhope.appius.util.RecordLoader
changed, initializeStorage, isRealtime, loadRecord, loadRecord, refresh, removeRecord, saveRecord
 
Methods inherited from interface org.starhope.util.HasSubversionRevision
getSubversionRevision
 

Field Detail

moniker

protected final String moniker
WRITEME


userID

protected final int userID
WRITEME


userLogin

protected final String userLogin
WRITEME

Constructor Detail

UserListIterator

protected UserListIterator(AbstractUser user,
                           String listMoniker)
WRITEME: Document this constructor brpocock@star-hope.org

Parameters:
user - WRITEME
listMoniker - WRITEME
Method Detail

add

public abstract void add(AbstractUser user)
Add another user to the list represented by this iterator

Parameters:
user - the other user

remove

public void remove()
Specified by:
remove in interface Iterator<UserListEntry>
See Also:
Iterator.remove()

remove

public abstract void remove(AbstractUser interestingFellow)
WRITEME: Document this method brpocock@star-hope.org

Parameters:
interestingFellow - WRITEME