com.omertron.rottentomatoesapi

Class RottenTomatoesApi

java.lang.Object

com.omertron.rottentomatoesapi.RottenTomatoesApi

public class RottenTomatoesApi
extends Object

Connect to the Rotten Tomatoes web site and get the rating for a specific movie

Author:

Stuart.Boston

Constructor Summary

Constructors

Constructor and Description
RottenTomatoesApi(String apiKey)
RottenTomatoesApi(String apiKey, org.apache.http.client.HttpClient httpClient)

Method Summary

Modifier and Type	Method and Description
List<RTMovie>	getBoxOffice() Displays top box office earning movies, sorted by most recent weekend gross ticket sales.
List<RTMovie>	getBoxOffice(String country) Displays top box office earning movies, sorted by most recent weekend gross ticket sales.
List<RTMovie>	getBoxOffice(String country, int limit) Displays top box office earning movies, sorted by most recent weekend gross ticket sales.
List<RTCast>	getCastInfo(int movieId) Pulls the complete movie cast for a movie
List<RTMovie>	getCurrentReleaseDvds() Retrieves current release DVDs
List<RTMovie>	getCurrentReleaseDvds(String country) Retrieves current release DVDs
List<RTMovie>	getCurrentReleaseDvds(String country, int page, int pageLimit) Retrieves current release DVDs
RTMovie	getDetailedInfo(int movieId) Detailed information on a specific movie specified by Id.
Map<String,String>	getDvdListsDirectory() Shows the DVD lists available
List<RTMovie>	getInTheaters() Retrieves movies currently in theaters
List<RTMovie>	getInTheaters(String country) Retrieves movies currently in theaters
List<RTMovie>	getInTheaters(String country, int page, int pageLimit) Retrieves movies currently in theaters
Map<String,String>	getListsDirectory() Displays the top level lists available in the API
List<RTClip>	getMovieClips(int movieId) Related movie clips and trailers for a movie
Map<String,String>	getMovieListsDirectory() Shows the movie lists available
RTMovie	getMoviesAlias(String altMovieId, String type) Provides a movie lookup by an id from a different vendor
List<Review>	getMoviesReviews(int movieId) Retrieves the reviews for a movie
List<Review>	getMoviesReviews(int movieId, String country) Retrieves the reviews for a movie
List<Review>	getMoviesReviews(int movieId, String reviewType, int pageLimit, int page, String country) Retrieves the reviews for a movie
List<Review>	getMoviesReviews(int movieId, String reviewType, String country) Retrieves the reviews for a movie
List<RTMovie>	getMoviesSearch(String query) The movies search endpoint for plain text queries.
List<RTMovie>	getMoviesSearch(String query, int pageLimit, int page) The movies search endpoint for plain text queries.
List<RTMovie>	getMoviesSimilar(int movieId) Returns similar movies to a movie
List<RTMovie>	getMoviesSimilar(int movieId, int limit) Returns similar movies to a movie
List<RTMovie>	getNewReleaseDvds() Retrieves new release DVDs
List<RTMovie>	getNewReleaseDvds(String country) Retrieves new release DVDs
List<RTMovie>	getNewReleaseDvds(String country, int page, int pageLimit) Retrieves new release DVDs
List<RTMovie>	getOpeningMovies() Retrieves current opening movies
List<RTMovie>	getOpeningMovies(String country) Retrieves current opening movies
List<RTMovie>	getOpeningMovies(String country, int limit) Retrieves current opening movies
List<RTMovie>	getTopRentals() Retrieves the current top DVD rentals
List<RTMovie>	getTopRentals(String country) Retrieves the current top DVD rentals
List<RTMovie>	getTopRentals(String country, int limit) Retrieves the current top DVD rentals
List<RTMovie>	getUpcomingDvds() Retrieves current release DVDs
List<RTMovie>	getUpcomingDvds(String country) Retrieves current release DVDs
List<RTMovie>	getUpcomingDvds(String country, int page, int pageLimit) Retrieves current release DVDs
List<RTMovie>	getUpcomingMovies() Retrieves upcoming movies
List<RTMovie>	getUpcomingMovies(String country) Retrieves upcoming movies
List<RTMovie>	getUpcomingMovies(String country, int page, int pageLimit) Retrieves upcoming movies
void	setRetryDelay(long retryDelay) Set the delay time between API retries when the account is over it's limit
void	setRetryLimit(int retryLimit) Number of times to retry the API call when the account limit is hit.

Methods inherited from class java.lang.Object

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

Constructor Detail

RottenTomatoesApi

public RottenTomatoesApi(String apiKey)
                  throws RottenTomatoesException

Throws:

RottenTomatoesException

RottenTomatoesApi

public RottenTomatoesApi(String apiKey,
                         org.apache.http.client.HttpClient httpClient)
                  throws RottenTomatoesException

Throws:

RottenTomatoesException

Method Detail

setRetryDelay

public void setRetryDelay(long retryDelay)

Set the delay time between API retries when the account is over it's limit

Parameters:

retryDelay - milliseconds to delay for, default is 500ms

setRetryLimit

public void setRetryLimit(int retryLimit)

Number of times to retry the API call when the account limit is hit. Once this limit is hit an exception is thrown.

Parameters:

retryLimit - Number of retries, default is 5

getBoxOffice

public List<RTMovie> getBoxOffice(String country,
                                  int limit)
                           throws RottenTomatoesException

Displays top box office earning movies, sorted by most recent weekend gross ticket sales.

Parameters:

limit - Limits the number of movies returned

country - Provides localized data for the selected country

Returns:

Throws:

RottenTomatoesException

getBoxOffice

public List<RTMovie> getBoxOffice()
                           throws RottenTomatoesException

Displays top box office earning movies, sorted by most recent weekend gross ticket sales.

Returns:

Throws:

RottenTomatoesException

getBoxOffice

public List<RTMovie> getBoxOffice(String country)
                           throws RottenTomatoesException

Displays top box office earning movies, sorted by most recent weekend gross ticket sales.

Parameters:

country - Provides localized data for the selected country

Returns:

Throws:

RottenTomatoesException

getInTheaters

public List<RTMovie> getInTheaters(String country,
                                   int page,
                                   int pageLimit)
                            throws RottenTomatoesException

Retrieves movies currently in theaters

Parameters:

country - Provides localized data for the selected country

page - The selected page of in theaters movies

pageLimit - The amount of movies in theaters to show per page

Returns:

Throws:

RottenTomatoesException

getInTheaters

public List<RTMovie> getInTheaters(String country)
                            throws RottenTomatoesException

Retrieves movies currently in theaters

Parameters:

country - Provides localized data for the selected country

Returns:

Throws:

RottenTomatoesException

getInTheaters

public List<RTMovie> getInTheaters()
                            throws RottenTomatoesException

Retrieves movies currently in theaters

Returns:

Throws:

RottenTomatoesException

getOpeningMovies

public List<RTMovie> getOpeningMovies(String country,
                                      int limit)
                               throws RottenTomatoesException

Retrieves current opening movies

Parameters:

country - Provides localized data for the selected country

limit - Limits the number of opening movies returned

Returns:

Throws:

RottenTomatoesException

getOpeningMovies

public List<RTMovie> getOpeningMovies(String country)
                               throws RottenTomatoesException

Retrieves current opening movies

Parameters:

country - Provides localized data for the selected country

Returns:

Throws:

RottenTomatoesException

getOpeningMovies

public List<RTMovie> getOpeningMovies()
                               throws RottenTomatoesException

Retrieves current opening movies

Returns:

Throws:

RottenTomatoesException

getUpcomingMovies

public List<RTMovie> getUpcomingMovies(String country,
                                       int page,
                                       int pageLimit)
                                throws RottenTomatoesException

Retrieves upcoming movies

Parameters:

country - Provides localized data for the selected country

page - The selected page of in theaters movies

pageLimit - The amount of movies in theaters to show per page

Returns:

Throws:

RottenTomatoesException

getUpcomingMovies

public List<RTMovie> getUpcomingMovies(String country)
                                throws RottenTomatoesException

Retrieves upcoming movies

Parameters:

country - Provides localized data for the selected country

Returns:

Throws:

RottenTomatoesException

getUpcomingMovies

public List<RTMovie> getUpcomingMovies()
                                throws RottenTomatoesException

Retrieves upcoming movies

Returns:

Throws:

RottenTomatoesException

getTopRentals

public List<RTMovie> getTopRentals(String country,
                                   int limit)
                            throws RottenTomatoesException

Retrieves the current top DVD rentals

Parameters:

country - Provides localized data for the selected country

limit - Limits the number of opening movies returned

Returns:

Throws:

RottenTomatoesException

getTopRentals

public List<RTMovie> getTopRentals(String country)
                            throws RottenTomatoesException

Retrieves the current top DVD rentals

Parameters:

country - Provides localized data for the selected country

Returns:

Throws:

RottenTomatoesException

getTopRentals

public List<RTMovie> getTopRentals()
                            throws RottenTomatoesException

Retrieves the current top DVD rentals

Returns:

Throws:

RottenTomatoesException

getCurrentReleaseDvds

public List<RTMovie> getCurrentReleaseDvds(String country,
                                           int page,
                                           int pageLimit)
                                    throws RottenTomatoesException

Retrieves current release DVDs

Parameters:

country - Provides localized data for the selected country

page - The selected page of in theaters movies

pageLimit - The amount of movies in theaters to show per page

Returns:

Throws:

RottenTomatoesException

getCurrentReleaseDvds

public List<RTMovie> getCurrentReleaseDvds(String country)
                                    throws RottenTomatoesException

Retrieves current release DVDs

Parameters:

country - Provides localized data for the selected country

Returns:

Throws:

RottenTomatoesException

getCurrentReleaseDvds

public List<RTMovie> getCurrentReleaseDvds()
                                    throws RottenTomatoesException

Retrieves current release DVDs

Returns:

Throws:

RottenTomatoesException

getNewReleaseDvds

public List<RTMovie> getNewReleaseDvds(String country,
                                       int page,
                                       int pageLimit)
                                throws RottenTomatoesException

Retrieves new release DVDs

Parameters:

country - Provides localized data for the selected country

page - The selected page of in theaters movies

pageLimit - The amount of movies in theaters to show per page

Returns:

Throws:

RottenTomatoesException

getNewReleaseDvds

public List<RTMovie> getNewReleaseDvds(String country)
                                throws RottenTomatoesException

Retrieves new release DVDs

Parameters:

country - Provides localized data for the selected country

Returns:

Throws:

RottenTomatoesException

getNewReleaseDvds

public List<RTMovie> getNewReleaseDvds()
                                throws RottenTomatoesException

Retrieves new release DVDs

Returns:

Throws:

RottenTomatoesException

getUpcomingDvds

public List<RTMovie> getUpcomingDvds(String country,
                                     int page,
                                     int pageLimit)
                              throws RottenTomatoesException

Retrieves current release DVDs

Parameters:

country - Provides localized data for the selected country

page - The selected page of in theaters movies

pageLimit - The amount of movies in theaters to show per page

Returns:

Throws:

RottenTomatoesException

getUpcomingDvds

public List<RTMovie> getUpcomingDvds(String country)
                              throws RottenTomatoesException

Retrieves current release DVDs

Parameters:

country - Provides localized data for the selected country

Returns:

Throws:

RottenTomatoesException

getUpcomingDvds

public List<RTMovie> getUpcomingDvds()
                              throws RottenTomatoesException

Retrieves current release DVDs

Returns:

Throws:

RottenTomatoesException

getDetailedInfo

public RTMovie getDetailedInfo(int movieId)
                        throws RottenTomatoesException

Detailed information on a specific movie specified by Id.

Parameters:

movieId - RT Movie ID to locate

Returns:

Throws:

RottenTomatoesException

getCastInfo

public List<RTCast> getCastInfo(int movieId)
                         throws RottenTomatoesException

Pulls the complete movie cast for a movie

Parameters:

movieId - RT Movie ID

Returns:

Throws:

RottenTomatoesException

getMovieClips

public List<RTClip> getMovieClips(int movieId)
                           throws RottenTomatoesException

Related movie clips and trailers for a movie

Parameters:

movieId - RT Movie ID

Returns:

Throws:

RottenTomatoesException

getMoviesReviews

public List<Review> getMoviesReviews(int movieId,
                                     String reviewType,
                                     int pageLimit,
                                     int page,
                                     String country)
                              throws RottenTomatoesException

Retrieves the reviews for a movie

Parameters:

movieId -

reviewType -

pageLimit -

page -

country -

Returns:

Throws:

RottenTomatoesException

getMoviesReviews

public List<Review> getMoviesReviews(int movieId,
                                     String reviewType,
                                     String country)
                              throws RottenTomatoesException

Retrieves the reviews for a movie

Parameters:

movieId -

reviewType -

country -

Returns:

Throws:

RottenTomatoesException

getMoviesReviews

public List<Review> getMoviesReviews(int movieId,
                                     String country)
                              throws RottenTomatoesException

Retrieves the reviews for a movie

Parameters:

movieId -

country -

Returns:

Throws:

RottenTomatoesException

getMoviesReviews

public List<Review> getMoviesReviews(int movieId)
                              throws RottenTomatoesException

Retrieves the reviews for a movie

Parameters:

movieId -

Returns:

Throws:

RottenTomatoesException

getMoviesSimilar

public List<RTMovie> getMoviesSimilar(int movieId,
                                      int limit)
                               throws RottenTomatoesException

Returns similar movies to a movie

Parameters:

movieId - RT Movie ID

limit - Limit number of returned movies

Returns:

Throws:

RottenTomatoesException

getMoviesSimilar

public List<RTMovie> getMoviesSimilar(int movieId)
                               throws RottenTomatoesException

Returns similar movies to a movie

Parameters:

movieId - RT Movie ID

Returns:

Throws:

RottenTomatoesException

getMoviesAlias

public RTMovie getMoviesAlias(String altMovieId,
                              String type)
                       throws RottenTomatoesException

Provides a movie lookup by an id from a different vendor

Parameters:

altMovieId -

type -

Returns:

Throws:

RottenTomatoesException

getMoviesSearch

public List<RTMovie> getMoviesSearch(String query,
                                     int pageLimit,
                                     int page)
                              throws RottenTomatoesException

The movies search endpoint for plain text queries. Let's you search for movies!

Parameters:

query -

pageLimit -

page -

Returns:

Throws:

RottenTomatoesException

getMoviesSearch

public List<RTMovie> getMoviesSearch(String query)
                              throws RottenTomatoesException

The movies search endpoint for plain text queries. Let's you search for movies!

Parameters:

query -

Returns:

Throws:

RottenTomatoesException

getListsDirectory

public Map<String,String> getListsDirectory()
                                     throws RottenTomatoesException

Displays the top level lists available in the API

Returns:

Throws:

RottenTomatoesException

getMovieListsDirectory

public Map<String,String> getMovieListsDirectory()
                                          throws RottenTomatoesException

Shows the movie lists available

Returns:

Throws:

RottenTomatoesException

getDvdListsDirectory

public Map<String,String> getDvdListsDirectory()
                                        throws RottenTomatoesException

Shows the DVD lists available

Returns:

Throws:

RottenTomatoesException