Params comments uopdated
This commit is contained in:
1 parent
6e765a6644
commit
bb4d17ee62
3 files changed
+12
-12
No files matched your search
@@ -28,7 +28,7 @@ public class BookStore {
|
|||||||
/**
|
/**
|
||||||
* BookStore constructor creats a bookstore, and tests
|
* BookStore constructor creats a bookstore, and tests
|
||||||
* hash maps and iterators
|
* hash maps and iterators
|
||||||
* @param bookStoreName to call bookstore
|
* @param bookStoreName - The bookStoreName to call bookstore
|
||||||
*/
|
*/
|
||||||
public BookStore(
|
public BookStore(
|
||||||
final String bookStoreName
|
final String bookStoreName
|
||||||
@@ -182,7 +182,7 @@ public class BookStore {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* printBoolTitle of all books containing the input string
|
* printBoolTitle of all books containing the input string
|
||||||
* @param title that book matches or contains
|
* @param title - The title that book matches or contains
|
||||||
*/
|
*/
|
||||||
public void printBookTitle(final String title)
|
public void printBookTitle(final String title)
|
||||||
{
|
{
|
||||||
@@ -209,7 +209,7 @@ public class BookStore {
|
|||||||
/**
|
/**
|
||||||
* printGroupByDecade prints any books within a given decade
|
* printGroupByDecade prints any books within a given decade
|
||||||
* e.g. 2000-2009
|
* e.g. 2000-2009
|
||||||
* @param decade to find books published in
|
* @param decade - The decade to find books published within
|
||||||
*/
|
*/
|
||||||
public void printGroupByDecade(final int decade)
|
public void printGroupByDecade(final int decade)
|
||||||
{
|
{
|
||||||
@@ -244,7 +244,7 @@ public class BookStore {
|
|||||||
/**
|
/**
|
||||||
* isThereABookWrittenIn checks if any books were written in
|
* isThereABookWrittenIn checks if any books were written in
|
||||||
* a given year
|
* a given year
|
||||||
* @param year to check for books
|
* @param year - The year to check for books
|
||||||
* @return if any books were published in a given year
|
* @return if any books were published in a given year
|
||||||
*/
|
*/
|
||||||
public boolean isThereABookWrittenIn(final int year)
|
public boolean isThereABookWrittenIn(final int year)
|
||||||
@@ -259,7 +259,7 @@ public class BookStore {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* howManyBooksContain a given word
|
* howManyBooksContain a given word
|
||||||
* @param word to check how many books contain it
|
* @param word - The word to check how many books contain it
|
||||||
* @return the number of books containing the word
|
* @return the number of books containing the word
|
||||||
*/
|
*/
|
||||||
public int howManyBooksContain(final String word)
|
public int howManyBooksContain(final String word)
|
||||||
@@ -281,8 +281,8 @@ public class BookStore {
|
|||||||
* whichPercentWrittenBetween gives the percent
|
* whichPercentWrittenBetween gives the percent
|
||||||
* of books from all books that were written
|
* of books from all books that were written
|
||||||
* between two given years
|
* between two given years
|
||||||
* @param first year book can be checked in
|
* @param first - The first year book can be checked in
|
||||||
* @param last year book can be checked in
|
* @param last - The last year book can be checked in
|
||||||
* @return the percent of books written between first year and last year
|
* @return the percent of books written between first year and last year
|
||||||
*/
|
*/
|
||||||
public float whichPercentWrittenBetween(
|
public float whichPercentWrittenBetween(
|
||||||
@@ -347,7 +347,7 @@ public class BookStore {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* main program entry to test methods of BookStore
|
* main program entry to test methods of BookStore
|
||||||
* @param args form cli
|
* @param args from cli
|
||||||
*/
|
*/
|
||||||
public static void main(final String[] args)
|
public static void main(final String[] args)
|
||||||
{
|
{
|
||||||
|
|||||||
@@ -17,9 +17,9 @@ public class Novel
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Novel constructor
|
* Novel constructor
|
||||||
* @param title of novel
|
* @param title - The title of novel
|
||||||
* @param authorName of the novel
|
* @param authorName - The authorName of the novel
|
||||||
* @param yearPublished of the novel
|
* @param yearPublished - The year published of the novel
|
||||||
*/
|
*/
|
||||||
public Novel(
|
public Novel(
|
||||||
final String title,
|
final String title,
|
||||||
|
|||||||
@@ -11,7 +11,7 @@ package ca.bcit.comp2522.lab05;
|
|||||||
public class Validator {
|
public class Validator {
|
||||||
/**
|
/**
|
||||||
* validateString ensures string input is not null or empty
|
* validateString ensures string input is not null or empty
|
||||||
* @param str to validate
|
* @param str - The String to validate
|
||||||
* @throws IllegalArgumentException if invalid string
|
* @throws IllegalArgumentException if invalid string
|
||||||
*/
|
*/
|
||||||
public static void validateString(final String str)
|
public static void validateString(final String str)
|
||||||
|
|||||||
Reference in new issue
Block a user