diff --git a/src/main/java/com/omertron/themoviedbapi/TheMovieDbApi.java b/src/main/java/com/omertron/themoviedbapi/TheMovieDbApi.java index feae06ee7..0dc5d2de4 100644 --- a/src/main/java/com/omertron/themoviedbapi/TheMovieDbApi.java +++ b/src/main/java/com/omertron/themoviedbapi/TheMovieDbApi.java @@ -64,7 +64,13 @@ import com.omertron.themoviedbapi.model2.discover.Discover; import com.omertron.themoviedbapi.model2.keyword.Keyword; import com.omertron.themoviedbapi.model2.list.ListItem; import com.omertron.themoviedbapi.model2.list.UserList; +import com.omertron.themoviedbapi.model2.media.MediaCreditList; +import com.omertron.themoviedbapi.model2.media.MediaState; +import com.omertron.themoviedbapi.model2.movie.AlternativeTitle; import com.omertron.themoviedbapi.model2.movie.MovieBasic; +import com.omertron.themoviedbapi.model2.movie.ReleaseInfo; +import com.omertron.themoviedbapi.model2.movie.Translation; +import com.omertron.themoviedbapi.model2.movie.Video; import com.omertron.themoviedbapi.model2.network.Network; import com.omertron.themoviedbapi.model2.person.CreditInfo; import com.omertron.themoviedbapi.model2.person.ExternalID; @@ -88,8 +94,7 @@ import org.yamj.api.common.http.SimpleHttpClientBuilder; /** * The MovieDb API *

- * This is for version 3 of the API as specified here: - * http://help.themoviedb.org/kb/api/about-3 + * This is for version 3 of the API as specified here: http://help.themoviedb.org/kb/api/about-3 * * @author stuart.boston */ @@ -187,8 +192,7 @@ public class TheMovieDbApi { * @param moviedb The moviedb object to compare too * @param title The title of the movie to compare * @param year The year of the movie to compare - * @param maxDistance The Levenshtein Distance between the two titles. 0 = - * exact match + * @param maxDistance The Levenshtein Distance between the two titles. 0 = exact match * @param caseSensitive true if the comparison is to be case sensitive * @return True if there is a match, False otherwise. */ @@ -269,8 +273,7 @@ public class TheMovieDbApi { // /** - * Get the basic information for an account. You will need to have a valid - * session id. + * Get the basic information for an account. You will need to have a valid session id. * * @param sessionId * @return @@ -436,16 +439,13 @@ public class TheMovieDbApi { // /** - * This method is used to generate a valid request token for user based - * authentication. + * This method is used to generate a valid request token for user based authentication. * * A request token is required in order to request a session id. * - * You can generate any number of request tokens but they will expire after - * 60 minutes. + * You can generate any number of request tokens but they will expire after 60 minutes. * - * As soon as a valid session id has been created the token will be - * destroyed. + * As soon as a valid session id has been created the token will be destroyed. * * @return * @throws MovieDbException @@ -455,8 +455,7 @@ public class TheMovieDbApi { } /** - * This method is used to generate a session id for user based - * authentication. + * This method is used to generate a session id for user based authentication. * * A session id is required in order to use any of the write methods. * @@ -469,8 +468,7 @@ public class TheMovieDbApi { } /** - * This method is used to generate a session id for user based - * authentication. User must provide their username and password + * This method is used to generate a session id for user based authentication. User must provide their username and password * * A session id is required in order to use any of the write methods. * @@ -487,18 +485,14 @@ public class TheMovieDbApi { /** * This method is used to generate a guest session id. * - * A guest session can be used to rate movies without having a registered - * TMDb user account. + * A guest session can be used to rate movies without having a registered TMDb user account. * - * You should only generate a single guest session per user (or device) as - * you will be able to attach the ratings to a TMDb user account in the - * future. + * You should only generate a single guest session per user (or device) as you will be able to attach the ratings to a TMDb user + * account in the future. * - * There are also IP limits in place so you should always make sure it's the - * end user doing the guest session actions. + * There are also IP limits in place so you should always make sure it's the end user doing the guest session actions. * - * If a guest session is not used for the first time within 24 hours, it - * will be automatically discarded. + * If a guest session is not used for the first time within 24 hours, it will be automatically discarded. * * @return * @throws MovieDbException @@ -534,8 +528,7 @@ public class TheMovieDbApi { /** * Get a list of Movie IDs that have been edited. * - * You can then use the movie changes API to get the actual data that has - * been changed. + * You can then use the movie changes API to get the actual data that has been changed. * * @param page * @param startDate the start date of the changes, optional @@ -550,8 +543,7 @@ public class TheMovieDbApi { /** * Get a list of TV IDs that have been edited. * - * You can then use the TV changes API to get the actual data that has been - * changed. + * You can then use the TV changes API to get the actual data that has been changed. * * @param page * @param startDate the start date of the changes, optional @@ -566,8 +558,7 @@ public class TheMovieDbApi { /** * Get a list of Person IDs that have been edited. * - * You can then use the person changes API to get the actual data that has - * been changed. + * You can then use the person changes API to get the actual data that has been changed. * * @param page * @param startDate the start date of the changes, optional @@ -582,11 +573,9 @@ public class TheMovieDbApi { // /** - * This method is used to retrieve all of the basic information about a - * movie collection. + * This method is used to retrieve all of the basic information about a movie collection. * - * You can get the ID needed for this method by making a getMovieInfo - * request for the belongs_to_collection. + * You can get the ID needed for this method by making a getMovieInfo request for the belongs_to_collection. * * @param collectionId * @param language @@ -612,8 +601,7 @@ public class TheMovieDbApi { // /** - * This method is used to retrieve the basic information about a production - * company on TMDb. + * This method is used to retrieve the basic information about a production company on TMDb. * * @param companyId * @return @@ -626,8 +614,7 @@ public class TheMovieDbApi { /** * This method is used to retrieve the movies associated with a company. * - * These movies are returned in order of most recently released to oldest. - * The default response will return 20 movies per page. + * These movies are returned in order of most recently released to oldest. The default response will return 20 movies per page. * * TODO: Implement more than 20 movies * @@ -676,8 +663,7 @@ public class TheMovieDbApi { } /** - * Get the list of supported timezones for the API methods that support - * them. + * Get the list of supported timezones for the API methods that support them. * * @return @throws MovieDbException */ @@ -692,14 +678,11 @@ public class TheMovieDbApi { *

* This is currently only supported with the new credit model found in TV. *
- * These IDs can be found from any TV credit response as well as the - * TV_credits and combined_credits methods for people.
- * The episodes object returns a list of episodes and are generally going to - * be guest stars.
+ * These IDs can be found from any TV credit response as well as the TV_credits and combined_credits methods for people.
+ * The episodes object returns a list of episodes and are generally going to be guest stars.
* The season array will return a list of season numbers.
- * Season credits are credits that were marked with the "add to every - * season" option in the editing interface and are assumed to be "season - * regulars". + * Season credits are credits that were marked with the "add to every season" option in the editing interface and are assumed to + * be "season regulars". * * @param creditId * @param language @@ -713,8 +696,7 @@ public class TheMovieDbApi { // /** - * Discover movies by different types of data like average rating, number of - * votes, genres and certifications. + * Discover movies by different types of data like average rating, number of votes, genres and certifications. * * @param discover A discover object containing the search criteria required * @return @@ -725,8 +707,7 @@ public class TheMovieDbApi { } /** - * Discover movies by different types of data like average rating, number of - * votes, genres and certifications. + * Discover movies by different types of data like average rating, number of votes, genres and certifications. * * @param discover A discover object containing the search criteria required * @return @@ -739,18 +720,16 @@ public class TheMovieDbApi { // /** - * You con use this method to find movies, tv series or persons using - * external ids. + * You con use this method to find movies, tv series or persons using external ids. * * Supported query ids are *

* * For details see http://docs.themoviedb.apiary.io/#find @@ -792,11 +771,9 @@ public class TheMovieDbApi { /** * Get a list of movies per genre. * - * It is important to understand that only movies with more than 10 votes - * get listed. + * It is important to understand that only movies with more than 10 votes get listed. * - * This prevents movies from 1 10/10 rating from being listed first and for - * the first 5 pages. + * This prevents movies from 1 10/10 rating from being listed first and for the first 5 pages. * * @param genreId * @param language @@ -863,8 +840,7 @@ public class TheMovieDbApi { } /** - * This method lets users delete a list that they created. A valid session - * id is required. + * This method lets users delete a list that they created. A valid session id is required. * * @param sessionId * @param listId @@ -919,7 +895,303 @@ public class TheMovieDbApi { // // + /** + * This method is used to retrieve all of the basic movie information. + * + * It will return the single highest rated poster and backdrop. + * + * ApiExceptionType.MOVIE_ID_NOT_FOUND will be thrown if there are no movies found. + * + * @param movieId + * @param language + * @param appendToResponse + * @return + * @throws MovieDbException + */ + public MovieDb getMovieInfo(int movieId, String language, String... appendToResponse) throws MovieDbException { + return tmdbMovies.getMovieInfo(movieId, language, appendToResponse); + } + /** + * This method is used to retrieve all of the basic movie information. + * + * It will return the single highest rated poster and backdrop. + * + * ApiExceptionType.MOVIE_ID_NOT_FOUND will be thrown if there are no movies found. + * + * @param imdbId + * @param language + * @param appendToResponse + * @return + * @throws MovieDbException + */ + public MovieDb getMovieInfoImdb(String imdbId, String language, String... appendToResponse) throws MovieDbException { + return tmdbMovies.getMovieInfoImdb(imdbId, language, appendToResponse); + } + + /** + * This method lets a user get the status of whether or not the movie has been rated or added to their favourite or movie watch + * list. + * + * A valid session id is required. + * + * @param movieId + * @param sessionId + * @return + * @throws MovieDbException + */ + public MediaState getMovieAccountState(int movieId, String sessionId) throws MovieDbException { + return tmdbMovies.getMovieAccountState(movieId, sessionId); + } + + /** + * This method is used to retrieve all of the alternative titles we have for a particular movie. + * + * @param movieId + * @param country + * @param appendToResponse + * @return + * @throws MovieDbException + */ + public TmdbResultsList getMovieAlternativeTitles(int movieId, String country, String... appendToResponse) throws MovieDbException { + return tmdbMovies.getMovieAlternativeTitles(movieId, country, appendToResponse); + } + + /** + * Get the cast and crew information for a specific movie id. + * + * @param movieId + * @param appendToResponse + * @return + * @throws MovieDbException + */ + public MediaCreditList getMovieCredits(int movieId, String... appendToResponse) throws MovieDbException { + return tmdbMovies.getMovieCredits(movieId, appendToResponse); + } + + /** + * This method should be used when you’re wanting to retrieve all of the images for a particular movie. + * + * @param movieId + * @param language + * @param appendToResponse + * @return + * @throws MovieDbException + */ + public TmdbResultsList getMovieImages(int movieId, String language, String... appendToResponse) throws MovieDbException { + return tmdbMovies.getMovieImages(movieId, language, appendToResponse); + } + + /** + * This method is used to retrieve all of the keywords that have been added to a particular movie. + * + * Currently, only English keywords exist. + * + * @param movieId + * @param appendToResponse + * @return + * @throws MovieDbException + */ + public TmdbResultsList getMovieKeywords(int movieId, String... appendToResponse) throws MovieDbException { + return tmdbMovies.getMovieKeywords(movieId, appendToResponse); + } + + /** + * This method is used to retrieve all of the release and certification data we have for a specific movie. + * + * @param movieId + * @param language + * @param appendToResponse + * @return + * @throws MovieDbException + */ + public TmdbResultsList getMovieReleaseInfo(int movieId, String language, String... appendToResponse) throws MovieDbException { + return tmdbMovies.getMovieReleaseInfo(movieId, language, appendToResponse); + } + + /** + * This method is used to retrieve all of the trailers for a particular movie. + * + * Supported sites are YouTube and QuickTime. + * + * @param movieId + * @param language + * @param appendToResponse + * @return + * @throws MovieDbException + */ + public TmdbResultsList // @@ -966,11 +1238,9 @@ public class TheMovieDbApi { /** * Get the TV credits for a specific person id. * - * To get the expanded details for each record, call the /credit method with - * the provided credit_id. + * To get the expanded details for each record, call the /credit method with the provided credit_id. * - * This will provide details about which episode and/or season the credit is - * for. + * This will provide details about which episode and/or season the credit is for. * * @param personId * @param language @@ -985,11 +1255,9 @@ public class TheMovieDbApi { /** * Get the combined (movie and TV) credits for a specific person id. * - * To get the expanded details for each TV record, call the /credit method - * with the provided credit_id. + * To get the expanded details for each TV record, call the /credit method with the provided credit_id. * - * This will provide details about which episode and/or season the credit is - * for. + * This will provide details about which episode and/or season the credit is for. * * @param personId * @param language @@ -1026,8 +1294,7 @@ public class TheMovieDbApi { /** * Get the images that have been tagged with a specific person id. * - * We return all of the image results with a media object mapped for each - * image. + * We return all of the image results with a media object mapped for each image. * * @param personId * @param page @@ -1046,8 +1313,7 @@ public class TheMovieDbApi { * * By default, only the last 24 hours of changes are returned. * - * The maximum number of days that can be returned in a single request is - * 14. + * The maximum number of days that can be returned in a single request is 14. * * The language is present on fields that are translatable. * @@ -1100,8 +1366,8 @@ public class TheMovieDbApi { /** * Search Companies. * - * You can use this method to search for production companies that are part - * of TMDb. The company IDs will map to those returned on movie calls. + * You can use this method to search for production companies that are part of TMDb. The company IDs will map to those returned + * on movie calls. * * http://help.themoviedb.org/kb/api/search-companies * @@ -1153,16 +1419,13 @@ public class TheMovieDbApi { } /** - * Search Movies This is a good starting point to start finding movies on - * TMDb. + * Search Movies This is a good starting point to start finding movies on TMDb. * * @param query - * @param searchYear Limit the search to the provided year. Zero (0) will - * get all years + * @param searchYear Limit the search to the provided year. Zero (0) will get all years * @param language The language to include. Can be blank/null. * @param includeAdult true or false to include adult titles in the search - * @param page The page of results to return. 0 to get the default (first - * page) + * @param page The page of results to return. 0 to get the default (first page) * @param primaryReleaseYear * @param searchType * @return @@ -1181,11 +1444,9 @@ public class TheMovieDbApi { /** * Search the movie, tv show and person collections with a single query. * - * Each item returned in the result array has a media_type field that maps - * to either movie, tv or person. + * Each item returned in the result array has a media_type field that maps to either movie, tv or person. * - * Each mapped result is the same response you would get from each - * independent search + * Each mapped result is the same response you would get from each independent search * * @param query * @param page @@ -1201,8 +1462,7 @@ public class TheMovieDbApi { /** * This is a good starting point to start finding people on TMDb. * - * The idea is to be a quick and light method so you can iterate through - * people quickly. + * The idea is to be a quick and light method so you can iterate through people quickly. * * @param query * @param includeAdult