javaDocedRefactoringExample.statement

Class StatementTemplate

java.lang.Object

javaDocedRefactoringExample.statement.StatementTemplate

Direct Known Subclasses:

HTMLStatement, TextStatement

public abstract class StatementTemplate
extends java.lang.Object

The generalized Statement. It is really more like a general "Statement" command with the "execute" method being the generalized "toString()" method.

 Domain:
         customerName : String
         rentals      : List
 Invariant:
         customerName ≠ null AND |customerName| > 0 AND rentals ≠ null
 

Author:

Scott Woodfield

Constructor Summary

Constructors

Constructor and Description
StatementTemplate(java.lang.String customerName, java.util.List<Rental> rentals) The constructor for the Statement Template.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	toString() Generates a statement.

Methods inherited from class java.lang.Object

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

Constructor Detail

StatementTemplate

public StatementTemplate(java.lang.String customerName,
                 java.util.List<Rental> rentals)

The constructor for the Statement Template. We could have omitted this since Java would have created this constructor with the same semantics.

Parameters:

customerName - the name of the customer that will appear on the first line of the statement.

rentals - the list of rentals from which which we will get titles, charges, compute the total charge and compute the frequent renter points.

Pre-condition:

customerName ≠ null AND |customerName| > 0 AND rentals ≠ null

Post-condition:

this.customerName = customerName AND this.rentals = rentals

Method Detail

toString

public java.lang.String toString()

Generates a statement.

Overrides:

toString in class java.lang.Object

Pre-condition:

None>

Post-condition:

result = generateHeader() + generateLine(rental.getTitleOfMovie(), rentalAmount) for each rental + generateFooter(totalAmount, numberOfFrequentRenterPoints) wher totalAmount is the sum of all the rentalAmounts for each rental and numberOfFrequentRenterPoints is the sum of all the frequentRenterPoints from each rental. Must satisfy the appropriate syntax for the specialized statement.