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