javaDocedRefactoringExample

Class Rental

java.lang.Object

javaDocedRefactoringExample.Rental

public class Rental
extends java.lang.Object

One of many rentals that that a person may be returning.

 Domain:
         movie              : Movie -- the movie rented
         numberOfDaysRented : integer -- the number of days the movie was rented
 Invariant:
         move ≠ null AND numberOfDaysRented ≥ 0
 

Author:

Scott Woodfield

Constructor Summary

Constructors

Constructor and Description
Rental(Movie movie, int numberOfDaysRented) The constructor for the Rental class.

Method Summary

Methods

Modifier and Type	Method and Description
float	getAmountDue() Gets the amount due for this movie based on the number of days it was rented.
int	getFrequentRentalPoints() Get the number frequent renter points for this movie based on the number of days it was rented.
java.lang.String	getTitleOfMovie() Returns the title of this rental's movie.

Methods inherited from class java.lang.Object

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

Constructor Detail

Rental

public Rental(Movie movie,
      int numberOfDaysRented)

The constructor for the Rental class. It creates a new Rental from a movie and the number of days it was rented.

Parameters:

movie - the movie rented

numberOfDaysRented - the number of days rented

Pre-condition:

movie ≠ null AND numberOfDaysRented ≥ 0

Post-condition:

this.move = movie AND this.numberOfDaysRented = numberOfDaysRented

Method Detail

getTitleOfMovie

public java.lang.String getTitleOfMovie()

Returns the title of this rental's movie.

Pre-condition:

None

Post-condition:

result = movie.getTitle()

getAmountDue

public float getAmountDue()

Gets the amount due for this movie based on the number of days it was rented.

Pre-condition:

None

Post-condition:

result = movie.getAmountDue(numberOfDaysRented)

getFrequentRentalPoints

public int getFrequentRentalPoints()

Get the number frequent renter points for this movie based on the number of days it was rented.

Pre-condition:

None

Post-condition:

result = movie.getFrequentRenterPoints(numberOfDaysRented)