javaDocedRefactoringExample.statement

Class TextStatement

java.lang.Object

javaDocedRefactoringExample.statement.StatementTemplate

javaDocedRefactoringExample.statement.TextStatement

public class TextStatement
extends StatementTemplate

A Text statement. It is really more like a generate Text Statement command with the "execute" method being the "toString()" method inherited from StatementTemplate.

 Domain:
         Inherited from StatementTemplate
 Invariant
         Inherited from StatementTemplate
 

Author:

Scott Woodfield

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	toString() Creates a string representation of a TextStatement.

Methods inherited from class java.lang.Object

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

Constructor Detail

TextStatement

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

The constructor for the TextStatement class.

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:

super(String, List).pre

Post-condition:

super(String, List).post

Method Detail

toString

public java.lang.String toString()

Creates a string representation of a TextStatement.

Overrides:

toString in class StatementTemplate

Pre-condition:

super.toString().pre

Post-condition:

super.toString().post AND is formatted according to the following syntax

 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+