javaDocedRefactoringExample

Class Movie

java.lang.Object

javaDocedRefactoringExample.Movie

public class Movie
extends java.lang.Object

A movie that someone may rent.

 Domain:
         title      : String
         movieState : MovieState
 Invariante:
         title ≠ null AND movieState ≠ null

Author:

Scott Woodfield

Constructor Summary

Constructors

Constructor and Description
Movie(java.lang.String title) The constructor for Movie class.

Method Summary

Methods

Modifier and Type	Method and Description
void	changeMovieStateTo(MovieState newMovieState) The setter for the movieState.
float	getAmountDue(int numberOfDaysRented) Get the amount due for this movie.
int	getFrequentRenterPoints(int numberOfDaysRented) Returns the number of frequent renter points for this movie.
java.lang.String	getTitle() The getter for the title.

Methods inherited from class java.lang.Object

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

Constructor Detail

Movie

public Movie(java.lang.String title)

The constructor for Movie class. It creates a new movie with the given title and sets the movie state to New Released Movie.

Parameters:

title - the title of the new movie

Pre-condition:

title ≠ null

Post-condition:

this.title = title AND movieState = NewReleaseMovieState.getSingleton()

Method Detail

getTitle

public java.lang.String getTitle()

The getter for the title.

Pre-condition:

None

Post-condition:

result = title;

getAmountDue

public float getAmountDue(int numberOfDaysRented)

Get the amount due for this movie.

Parameters:

numberOfDaysRented - the number of days this movie was rented.

Pre-condition:

numberOfDaysRented ≥ 0

Post-condition:

result = movieState.getAmountDue(numberOfDaysRented)

getFrequentRenterPoints

public int getFrequentRenterPoints(int numberOfDaysRented)

Returns the number of frequent renter points for this movie.

Parameters:

numberOfDaysRented - the number of days this movie was rented

Pre-condition:

numberOfDaysRented ≥ 0

Post-condition:

result = movieState.getFrequentRenterPoints(numberOfDaysRented)

changeMovieStateTo

public void changeMovieStateTo(MovieState newMovieState)

The setter for the movieState.

Parameters:

newMovieState - the new movie state

Pre-condition:

newMovieState ≠ null

Post-condition:

movieState = newMovieState