net.sf.djdoc.util
Interface HittableList<T extends Hittable>

All Known Implementing Classes:

BunchList, ItemList

public interface HittableList<T extends Hittable>

The instances of the HittableList interface are aggregations of Hittable objects, i.e. objects that can be "hit" or marked as accessed.

Method Summary

T	get(java.lang.String targetName) This method finds a particular Hittable object among this HittableList's members.
java.util.Collection<T>	getAll() Collection valued getter method for all Hittable objects of this HittableList.
java.util.Collection<T>	getFavorite() Collection valued getter method for the most often accessed Hittable objects of this HittableList.
java.lang.String	getParentName() Getter method for the name of the object (either the API or the package) to which the Hittable objects of this HittableList belong.
java.util.Collection<T>	getRecent() Collection valued getter method for the most recently accessed Hittable objects of this HittableList.
boolean	hasHits() This method is used to determine whether this HittableList's parent has any previously accessed members or not.
void	hit(java.lang.String targetName) This method marks a particular Hittable object among this HittableList's members as currently accessed.

Method Detail

getParentName

java.lang.String getParentName()

Getter method for the name of the object (either the API or the package) to which the Hittable objects of this HittableList belong.

Returns:

The name of the parent object of this HittableList

getFavorite

java.util.Collection<T> getFavorite()

Collection valued getter method for the most often accessed Hittable objects of this HittableList.

Returns:

A collection of the top favorite Hittable objects of this HittableList

getRecent

java.util.Collection<T> getRecent()

Collection valued getter method for the most recently accessed Hittable objects of this HittableList.

Returns:

A collection of the most recently accessed Hittable objects of this HittableList

getAll

java.util.Collection<T> getAll()

Collection valued getter method for all Hittable objects of this HittableList.

Returns:

A collection of all Hittable objects of this HittableList

get

T get(java.lang.String targetName)

This method finds a particular Hittable object among this HittableList's members.

Parameters:

targetName - The name of the Hittable object to be found

Returns:

The Hittable object of this list with the specified name

hasHits

boolean hasHits()

This method is used to determine whether this HittableList's parent has any previously accessed members or not.

Returns:

true if this HittableList's parent aggregation has accessed members; false otherwise

hit

void hit(java.lang.String targetName)

This method marks a particular Hittable object among this HittableList's members as currently accessed.

Parameters:

targetName - The name of the Hittable object to be marked accessed