org.starhope.appius.user
Class BetterUserList

java.lang.Object
  org.starhope.appius.util.SimpleDataRecord<SimpleDataRecordSet<DataRecordClass,DataRecordSetClass>>
      org.starhope.appius.util.SimpleDataRecordSet<UserRecord,BetterUserList>
          org.starhope.appius.user.BetterUserList

All Implemented Interfaces:

com.whirlycott.cache.Cacheable, Serializable, Comparable<SimpleDataRecordSet<UserRecord,BetterUserList>>, Iterable<UserRecord>, Collection<UserRecord>, CTime, DataRecord, DataRecordSet<UserRecord>, HasSubversionRevision

public class BetterUserList
extends SimpleDataRecordSet<UserRecord,BetterUserList>

List for managing buddies or ignored users.

Author:

brpocock@star-hope.org

See Also:

Serialized Form

Field Summary

private String	listMoniker WRITEME: Document this brpocock@star-hope.org
private UserRecord	owner WRITEME: Document this brpocock@star-hope.org

Fields inherited from class org.starhope.appius.util.SimpleDataRecord

myLoader, timeLastChanged, timeLastSaved

Constructor Summary

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

BetterUserList(RecordLoader<SimpleDataRecordSet<UserRecord,BetterUserList>> loader)
WRITEME: Document this constructor brpocock@star-hope.org

BetterUserList(UserRecord myOwner, String myMoniker)
WRITEME: Document this constructor brpocock@star-hope.org

Method Summary

int	getCacheableID() Note that all records must have either a numeric ID ( DataRecord.getCacheableID() or a string identifier ( DataRecord.getCacheableIdent() or both.
String	getCacheableIdent() Note that all records must have either a numeric ID ( DataRecord.getCacheableID() or a string identifier ( DataRecord.getCacheableIdent() or both.
String	getSubversionRevision() Return the Subversion revision level of this class's source code file, as supplied via the special "$Rev: " sequence.

Methods inherited from class org.starhope.appius.util.SimpleDataRecordSet

add, addAll, clear, contains, containsAll, isEmpty, iterator, remove, removeAll, retainAll, size, toArray, toArray

Methods inherited from class org.starhope.appius.util.SimpleDataRecord

changed, compareTo, equals, finalize, getRecordLoader, getTimeLastChanged, getTimeLastSaved, hashCode, isBeingLoaded, markAsLoaded, markAsLoaded, markAsSaved, onRemove, onRetrieve, onStore, setRecordLoader, toString

Methods inherited from class java.lang.Object

clone, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Collection

equals, hashCode

Methods inherited from interface org.starhope.appius.util.DataRecord

getRecordLoader, isBeingLoaded, markAsLoaded, markAsSaved, setRecordLoader

Methods inherited from interface org.starhope.appius.util.CTime

getTimeLastChanged, getTimeLastSaved

Methods inherited from interface com.whirlycott.cache.Cacheable

onRemove, onRetrieve, onStore

Field Detail

listMoniker

private String listMoniker

WRITEME: Document this brpocock@star-hope.org

owner

private UserRecord owner

WRITEME: Document this brpocock@star-hope.org

Constructor Detail

BetterUserList

public BetterUserList()

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

BetterUserList

public BetterUserList(RecordLoader<SimpleDataRecordSet<UserRecord,BetterUserList>> loader)

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

Parameters:

loader - record loader

BetterUserList

public BetterUserList(UserRecord myOwner,
                      String myMoniker)

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

Parameters:

myOwner - WRITEME

myMoniker - WRITEME

Method Detail

getCacheableID

public int getCacheableID()
                   throws NotFoundException

Description copied from interface: DataRecord

Note that all records must have either a numeric ID ( DataRecord.getCacheableID() or a string identifier ( DataRecord.getCacheableIdent() or both.

Returns:

an unique ID number

Throws:

NotFoundException - if the item doesn't have a distinct numeric ID

See Also:

DataRecord.getCacheableID()

getCacheableIdent

public String getCacheableIdent()
                         throws NotFoundException

Description copied from interface: DataRecord

Note that all records must have either a numeric ID ( DataRecord.getCacheableID() or a string identifier ( DataRecord.getCacheableIdent() or both.

Returns:

an unique identifier string

Throws:

NotFoundException - if the item doesn't have a distinct string identifier

See Also:

DataRecord.getCacheableIdent()

getSubversionRevision

public String getSubversionRevision()

Description copied from interface: HasSubversionRevision

Return the Subversion revision level of this class's source code file, as supplied via the special "$Rev: " sequence.

As an example,the Subversion revision string for this file is "$Rev: $"

 
 @Override
 public String getSubversionRevision () {
        return "$Rev: ";
 }
 

Returns:

The Subversion revision level for this class's source code file.

See Also:

HasSubversionRevision.getSubversionRevision()