nile.BookPair Interface Reference

List of all members.

Public Member Functions

void like ()
int getPopularity ()
String getOtherBook (String book) throws IllegalArgumentException
boolean contains (String book)


Detailed Description

This interface should be used by any object representing a pair of books wherein if one book is on a recommended list, so is the other. It extends the Comparable interface so that it can be used by Java Collections.
Author:
alucido, nford

Member Function Documentation

void nile.BookPair.like (  ) 

Increases the recommended value of this book-pair.

int nile.BookPair.getPopularity (  ) 

Gets the popularity of this book as represented by an integer.

Returns:

String nile.BookPair.getOtherBook ( String  book  )  throws IllegalArgumentException

Gets the book in this pair that is not the parameter passed to it.

Parameters:
book 
Returns:
a string with the title of the other book in the pair.
Exceptions:
IllegalArgumentException if book is not in the pair.

boolean nile.BookPair.contains ( String  book  ) 

Function to determine if a book is contained in this pair.

Parameters:
book 
Returns:
true if the book is in the pair, false otherwise.


The documentation for this interface was generated from the following file:

Generated on Tue Sep 7 16:56:45 2010 for NileSupport by  doxygen 1.5.6