javaDocedRefactoringExample

Class Customer

java.lang.Object

javaDocedRefactoringExample.Customer

public class Customer
extends java.lang.Object

A Customer who has rented some movies.

Domain:
        customerName : String -- the name of the Customer
        rentals      : List<Rental> -- the list of this person's rentals being returned to the store.
Invariant:
        customerName ≠ null AND |customerName| > 0 AND rentals ≠ null AND

        ∀ 0 < i < |rentals| (rentals[i] ≠ null)

Author:

Scott Woodfield

Constructor Summary

Constructors

Constructor and Description
Customer(java.lang.String customerName) The constructor for the Person class.

Method Summary

Methods

Modifier and Type	Method and Description
void	addRental(Rental rental) Adds a new rental to the list of rentals being returned by this person.
java.lang.String	generateHTMLStatement() Creates an HTML formatted statement for this customer.
java.lang.String	generateTextStatement() Creates a text formatted statement for this customer.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Customer

public Customer(java.lang.String customerName)

The constructor for the Person class. It creates a Person from the supplied customer name.

Parameters:

customerName - the name of the Person to be created.

Pre-condition:

customerName ≠ null AND |customerName| > 0

Post-condition:

this.customerName = customerName AND rentals ≠ null AND |rentals| = 0

Method Detail

generateTextStatement

public java.lang.String generateTextStatement()

Creates a text formatted statement for this customer.

Pre-condition:

None

Post-condition:

this = statement for this customer with the correct syntax. The name in the statement must be the name of this person. For each rental being returned there must be a rental line with the rentalTitle and amountDue for each rental. The summary must have the sum of all amounts for all rentals. The summary must also include the number of frequent renter points which is the the number of rentals + the number of new releases checked out for more than one day.

 SYNTAX:
 Statement                    ::= Header Body Footer
 Header                       ::= "Rental Record for " Name + "\n"
 Name                         ::= String
 Body                         ::= ("\t" RentalTitle "\t" AmountDue "\n")*
 RentalTitle                  ::= String
 AmountDue                    ::= Amount
 Footer                       ::= "Amount owed is " SumOfAllAmounts "\n"
                                     "You earned " + NumberOfFrequentRenterPoints + "\n"
 SumOfAllAmounts              ::= Amount
 Amount                       ::= \d+\.\d\d
 NumberOfFrequentRenterPoints ::= \d+
 

generateHTMLStatement

public java.lang.String generateHTMLStatement()

Creates an HTML formatted statement for this customer.

Pre-condition:

None

Post-condition:

this = statement for this customer with the correct syntax. The name in the statement must be the name of this person. For each rental being returned there must be a rental line with the rental title and amount due for each rental. The summary must have the sum of all amounts for all rentals. The summary must also include the number of frequent renter points which is the the number of rentals + the number of new releases check out for more than one day.

 SYNTAX:
 Statement                    ::= Header Body Footer
 Header                       ::= "<H1>Rentals for <EM>" Name + "</EM></H1><P>\n"
 Name                         ::= String
 Body                         ::= (RentalTitle ": " AmountDue "<BR>\n")*
 RentalTitle                  ::= String
 AmountDue                    ::= Amount
 Footer                       ::= "<P>You owe <EM>" SumOfAllAmounts "</EM><P>\n"
                                     "On this rental you earned <EM>" NumberOfFrequentRenterPoints
                                     "</EM> frequent renter points<P>"
 SumOfAllAmounts              ::= Amount
 Amount                       ::= \d+\.\d\d
 NumberOfFrequentRenterPoints ::= \d+
 

addRental

public void addRental(Rental rental)

Adds a new rental to the list of rentals being returned by this person.

Parameters:

rental - the rental being added to the list

Pre-condition:

rental ≠ null

Post-condition:

|rentals| = |rentals'| + 1 AND rentals[0..|rentals'| - 1] = rentals'[0..|rentals'| - 1] AND rentals[|rentals| - 1] = rental