org.starhope.appius.messaging
Class BadMailList

java.lang.Object
  extended by org.starhope.appius.util.SimpleDataRecord<SimpleDataRecordSet<DataRecordClass,DataRecordSetClass>>
      extended by org.starhope.appius.util.SimpleDataRecordSet<BadMailRecord,BadMailList>
          extended by org.starhope.appius.messaging.BadMailList
All Implemented Interfaces:
com.whirlycott.cache.Cacheable, Serializable, Comparable<SimpleDataRecordSet<BadMailRecord,BadMailList>>, Iterable<BadMailRecord>, Collection<BadMailRecord>, CTime, DataRecord, DataRecordSet<BadMailRecord>, HasSubversionRevision

public class BadMailList
extends SimpleDataRecordSet<BadMailRecord,BadMailList>

Author:
brpocock@star-hope.org
See Also:
Serialized Form

Field Summary
private static long serialVersionUID
          Java serialization unique ID
 
Fields inherited from class org.starhope.appius.util.SimpleDataRecord
myLoader, timeLastChanged, timeLastSaved
 
Constructor Summary
protected BadMailList(RecordLoader<SimpleDataRecordSet<BadMailRecord,BadMailList>> loader)
          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.
 boolean isBad(String mail)
           
 
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, checkStale, compareTo, equals, finalize, getRecordLoader, getTimeLastChanged, getTimeLastSaved, hashCode, isBeingLoaded, markAsLoaded, markAsSaved, markForReload, onRemove, onRetrieve, onStore, save, setRecordLoader, toString
 
Methods inherited from class java.lang.Object
clone, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface java.util.Collection
equals, hashCode
 
Methods inherited from interface org.starhope.appius.util.DataRecord
checkStale, 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

serialVersionUID

private static final long serialVersionUID
Java serialization unique ID

See Also:
Constant Field Values
Constructor Detail

BadMailList

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

Parameters:
loader - the record loader
Method Detail

getCacheableID

public int getCacheableID()
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
See Also:
DataRecord.getCacheableID()

getCacheableIdent

public String getCacheableIdent()
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
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: 1968 $"

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

Returns:
The Subversion revision level for this class's source code file.
See Also:
HasSubversionRevision.getSubversionRevision()

isBad

public boolean isBad(String mail)
Parameters:
mail - The eMail address to be tested
Returns:
true, if the eMail address is on the bad mail list and not yet expired from it.