edu.umich.eecs.tac.props
Class AbstractAdvertiserKeyedReportTransportable<T extends AdvertiserEntry>

java.lang.Object
  edu.umich.eecs.tac.props.AbstractTransportable
      edu.umich.eecs.tac.props.AbstractTransportableEntryListBacking<S>
          edu.umich.eecs.tac.props.AbstractKeyedEntryList<java.lang.String,T>
              edu.umich.eecs.tac.props.AbstractAdvertiserKeyedReportTransportable<T>

Type Parameters:

T - the advertiser entry class

All Implemented Interfaces:

java.io.Serializable, java.lang.Iterable<java.lang.String>, se.sics.isl.transport.Transportable

Direct Known Subclasses:

QueryReport.DisplayReport

public abstract class AbstractAdvertiserKeyedReportTransportable<T extends AdvertiserEntry>
extends AbstractKeyedEntryList<java.lang.String,T>

This class provides a skeletal implementation of a list containing advertiser entries with supporting methods for interacting entries specified by a given advertiser.

Author:

Patrick Jordan

See Also:

Serialized Form

Constructor Summary

AbstractAdvertiserKeyedReportTransportable()

Method Summary

int	addAdvertiser(java.lang.String advertiser) Adds a new key to the list.
boolean	containsAdvertiser(java.lang.String advertiser) Returns true if the advertiser key is in the list and false otherwise.

Methods inherited from class edu.umich.eecs.tac.props.AbstractKeyedEntryList

addKey, containsKey, createEntry, getEntry, getKey, indexForEntry, iterator, keys

Methods inherited from class edu.umich.eecs.tac.props.AbstractTransportableEntryListBacking

addEntry, afterAddEntry, afterRemoveEntry, beforeAddEntry, beforeRemoveEntry, entryClass, getEntries, getEntry, readAfterEntries, readBeforeEntries, readWithLock, removeEntry, size, toString, toStringAfterEntries, toStringBeforeEntries, writeAfterEntries, writeBeforeEntries, writeWithLock

Methods inherited from class edu.umich.eecs.tac.props.AbstractTransportable

getTransportName, isLocked, lock, lockCheck, read, write

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractAdvertiserKeyedReportTransportable

public AbstractAdvertiserKeyedReportTransportable()

Method Detail

addAdvertiser

public final int addAdvertiser(java.lang.String advertiser)
                        throws java.lang.NullPointerException

Adds a new key to the list. The AbstractKeyedEntryList.createEntry(T) method creates the new entry with the specified advertiser. This method delegates to AbstractKeyedEntryList.addKey(Object).

Parameters:

advertiser - the advertiser used to add the new advertiser entry.

Returns:

the index of the newly generated entry.

Throws:

java.lang.NullPointerException - if the advertiser is null.

containsAdvertiser

public final boolean containsAdvertiser(java.lang.String advertiser)

Returns true if the advertiser key is in the list and false otherwise. This method delegates to AbstractKeyedEntryList.containsKey(Object).

Parameters:

advertiser - the advertiser key to check for containment.

Returns:

true if the key is in the list and false otherwise.