|
DJDoc v.1.0.0b-1 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object net.sf.djdoc.util.ItemList
public class ItemList
The ItemList
class represents a user-specific list of all
available class items (i.e. classes, interfaces, enums etc.) of a package,
together with information about the most recently and most often accessed
items.
Constructor Summary | |
---|---|
ItemList(java.lang.String apiName,
java.lang.String bunchName,
User user)
Public constructor. |
Method Summary | |
---|---|
Item |
get(java.lang.String targetName)
This method finds a particular Item object among this
ItemList 's class items. |
java.util.Collection<Item> |
getAll()
Collection valued getter method for all class items in this ItemList . |
java.util.Collection<Item> |
getFavorite()
Collection valued getter method for the most often accessed class items in this ItemList . |
java.lang.String |
getParentName()
Getter method for the name of this list's parent object. |
java.util.Collection<Item> |
getRecent()
Collection valued getter method for the most recently accessed class items in this ItemList . |
boolean |
hasHits()
This method is used to determine whether this ItemList 's
package has any previously accessed class items or not. |
void |
hit(java.lang.String targetName)
This method marks a particular Item object among this
ItemList 's class items as currently accessed. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public ItemList(java.lang.String apiName, java.lang.String bunchName, User user)
User
.
apiName
- The name of the API of the package whose items are kept in
this ItemList
bunchName
- The name of the package the items of which are kept in
this listuser
- The user determining the access history for the item listMethod Detail |
---|
public java.lang.String getParentName()
getParentName
in interface HittableList<Item>
ItemList
's packagepublic java.util.Collection<Item> getFavorite()
ItemList
.
getFavorite
in interface HittableList<Item>
Collection
of the top favorite class items of this
ItemList
public java.util.Collection<Item> getRecent()
ItemList
.
getRecent
in interface HittableList<Item>
Collection
of the most recently accessed class
items of this ItemList
public java.util.Collection<Item> getAll()
ItemList
.
getAll
in interface HittableList<Item>
Collection
of all packages of this
BunchList
public Item get(java.lang.String targetName)
Item
object among this
ItemList
's class items.
get
in interface HittableList<Item>
targetName
- The name of the class item to be found
public void hit(java.lang.String targetName)
Item
object among this
ItemList
's class items as currently accessed.
hit
in interface HittableList<Item>
targetName
- The name of the class item to be marked accessedpublic boolean hasHits()
ItemList
's
package has any previously accessed class items or not.
hasHits
in interface HittableList<Item>
true
if this ItemList
's package
has accessed class items; false
otherwise
|
DJDoc v.1.0.0b-1 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |