org.starhope.appius.user
Class UserListGeneralSQLIterator

java.lang.Object
  org.starhope.appius.user.UserListIterator
      org.starhope.appius.user.UserListSQLIterator
          org.starhope.appius.user.UserListGeneralSQLIterator

All Implemented Interfaces:

Iterator<UserListEntry>, RecordLoader<UserListEntry>, HasSubversionRevision

public class UserListGeneralSQLIterator
extends UserListSQLIterator

WRITEME: Document this type.

Author:

brpocock@star-hope.org

Field Summary

Fields inherited from class org.starhope.appius.user.UserListIterator

moniker, userID, userLogin

Constructor Summary

UserListGeneralSQLIterator(AbstractUser user, String list)
WRITEME: Document this constructor brpocock@star-hope.org

Method Summary

void	add(AbstractUser user) Add another user to the list represented by this iterator
protected String	getSQL() WRITEME: Document this method brpocock@star-hope.org
void	refresh(UserListEntry record) Refreshes the record: Re-read the contents of the database into the given record.
void	remove(AbstractUser interestingFellow) WRITEME: Document this method brpocock@star-hope.org

Methods inherited from class org.starhope.appius.user.UserListSQLIterator

changed, getSubversionRevision, hasNext, initializeStorage, isRealtime, loadRecord, loadRecord, next, removeRecord, saveRecord

Methods inherited from class org.starhope.appius.user.UserListIterator

remove

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UserListGeneralSQLIterator

public UserListGeneralSQLIterator(AbstractUser user,
                                  String list)

WRITEME: Document this constructor brpocock@star-hope.org

Parameters:

user - WRITEME

list - WRITEME

Method Detail

add

public void add(AbstractUser user)

Description copied from class: UserListIterator

Add another user to the list represented by this iterator

Specified by:

add in class UserListIterator

Parameters:

user - the other user

See Also:

UserListIterator.add(org.starhope.appius.user.AbstractUser)

getSQL

protected String getSQL()

Description copied from class: UserListSQLIterator

WRITEME: Document this method brpocock@star-hope.org

Specified by:

getSQL in class UserListSQLIterator

Returns:

WRITEME

See Also:

UserListSQLIterator.getSQL()

refresh

public void refresh(UserListEntry record)

Description copied from interface: RecordLoader

Refreshes the record: Re-read the contents of the database into the given record. This is a rather cruel hack to work around some of the legacy tools in Tootsville™ that aren't hooked into the game server properly, and might be fiddling around with the SQL backing-store directly. This works together with e.g. SimpleDataRecord.checkStale() to try to reload data when it might have been changed: it's trading elegance and efficiency for expediency, but eventually, it should be removed.

Parameters:

record - the record to be reloaded.

remove

public void remove(AbstractUser interestingFellow)

Description copied from class: UserListIterator

WRITEME: Document this method brpocock@star-hope.org

Specified by:

remove in class UserListIterator

Parameters:

interestingFellow - WRITEME

See Also:

UserListIterator.remove(org.starhope.appius.user.AbstractUser)