diff --git a/src/main/java/com/omertron/themoviedbapi/TheMovieDbApi.java b/src/main/java/com/omertron/themoviedbapi/TheMovieDbApi.java index 8cc1365a8..835b68fa9 100644 --- a/src/main/java/com/omertron/themoviedbapi/TheMovieDbApi.java +++ b/src/main/java/com/omertron/themoviedbapi/TheMovieDbApi.java @@ -32,6 +32,7 @@ import com.omertron.themoviedbapi.methods.TmdbCompanies; import com.omertron.themoviedbapi.methods.TmdbConfiguration; import com.omertron.themoviedbapi.methods.TmdbCredits; import com.omertron.themoviedbapi.methods.TmdbDiscover; +import com.omertron.themoviedbapi.methods.TmdbEpisodes; import com.omertron.themoviedbapi.methods.TmdbFind; import com.omertron.themoviedbapi.methods.TmdbGenres; import com.omertron.themoviedbapi.methods.TmdbKeywords; @@ -41,9 +42,8 @@ import com.omertron.themoviedbapi.methods.TmdbNetworks; import com.omertron.themoviedbapi.methods.TmdbPeople; import com.omertron.themoviedbapi.methods.TmdbReviews; import com.omertron.themoviedbapi.methods.TmdbSearch; -import com.omertron.themoviedbapi.methods.TmdbTV; -import com.omertron.themoviedbapi.methods.TmdbEpisodes; import com.omertron.themoviedbapi.methods.TmdbSeasons; +import com.omertron.themoviedbapi.methods.TmdbTV; import com.omertron.themoviedbapi.model.Certification; import com.omertron.themoviedbapi.model.FindResults; import com.omertron.themoviedbapi.model.Genre; @@ -64,22 +64,22 @@ import com.omertron.themoviedbapi.model.discover.Discover; import com.omertron.themoviedbapi.model.keyword.Keyword; import com.omertron.themoviedbapi.model.list.ListItem; import com.omertron.themoviedbapi.model.list.UserList; +import com.omertron.themoviedbapi.model.media.AlternativeTitle; import com.omertron.themoviedbapi.model.media.MediaBasic; import com.omertron.themoviedbapi.model.media.MediaCreditList; import com.omertron.themoviedbapi.model.media.MediaState; -import com.omertron.themoviedbapi.model.media.AlternativeTitle; +import com.omertron.themoviedbapi.model.media.Translation; +import com.omertron.themoviedbapi.model.media.Video; import com.omertron.themoviedbapi.model.movie.MovieBasic; import com.omertron.themoviedbapi.model.movie.MovieInfo; import com.omertron.themoviedbapi.model.movie.ReleaseInfo; -import com.omertron.themoviedbapi.model.media.Translation; -import com.omertron.themoviedbapi.model.media.Video; import com.omertron.themoviedbapi.model.network.Network; import com.omertron.themoviedbapi.model.person.ContentRating; import com.omertron.themoviedbapi.model.person.CreditInfo; import com.omertron.themoviedbapi.model.person.ExternalID; -import com.omertron.themoviedbapi.model.person.PersonInfo; import com.omertron.themoviedbapi.model.person.PersonCreditList; import com.omertron.themoviedbapi.model.person.PersonFind; +import com.omertron.themoviedbapi.model.person.PersonInfo; import com.omertron.themoviedbapi.model.review.Review; import com.omertron.themoviedbapi.model.tv.TVBasic; import com.omertron.themoviedbapi.model.tv.TVEpisodeInfo; @@ -97,7 +97,8 @@ import org.yamj.api.common.http.SimpleHttpClientBuilder; /** * The MovieInfo 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 */ @@ -181,7 +182,8 @@ 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 @@ -347,13 +349,16 @@ 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 @@ -363,7 +368,8 @@ 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. * @@ -376,7 +382,8 @@ 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. * @@ -393,14 +400,18 @@ 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 @@ -436,7 +447,8 @@ 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 @@ -451,7 +463,8 @@ 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 @@ -466,7 +479,8 @@ public class TheMovieDbApi { /** * Get a list of PersonInfo 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 @@ -481,9 +495,11 @@ 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 @@ -509,7 +525,8 @@ 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 @@ -522,7 +539,8 @@ 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. * * @param companyId * @param language @@ -569,7 +587,8 @@ 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 */ @@ -584,11 +603,14 @@ 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 @@ -602,7 +624,8 @@ 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 @@ -613,7 +636,8 @@ 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 @@ -626,16 +650,18 @@ 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 @@ -677,9 +703,11 @@ 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 @@ -746,7 +774,8 @@ 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 @@ -806,7 +835,8 @@ public class TheMovieDbApi { * * It will return the single highest rated poster and backdrop. * - * ApiExceptionType.MOVIE_ID_NOT_FOUND will be thrown if there are no movies found. + * ApiExceptionType.MOVIE_ID_NOT_FOUND will be thrown if there are no movies + * found. * * @param movieId * @param language @@ -823,7 +853,8 @@ public class TheMovieDbApi { * * It will return the single highest rated poster and backdrop. * - * ApiExceptionType.MOVIE_ID_NOT_FOUND will be thrown if there are no movies found. + * ApiExceptionType.MOVIE_ID_NOT_FOUND will be thrown if there are no movies + * found. * * @param imdbId * @param language @@ -836,8 +867,8 @@ public class TheMovieDbApi { } /** - * 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. + * 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. * @@ -851,113 +882,113 @@ public class TheMovieDbApi { } /** - * This method is used to retrieve all of the alternative titles we have for a particular movie. + * 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 ResultList getMovieAlternativeTitles(int movieId, String country, String... appendToResponse) throws MovieDbException { - return tmdbMovies.getMovieAlternativeTitles(movieId, country, appendToResponse); + public ResultList getMovieAlternativeTitles(int movieId, String country) throws MovieDbException { + return tmdbMovies.getMovieAlternativeTitles(movieId, country); } /** * 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); + public MediaCreditList getMovieCredits(int movieId) throws MovieDbException { + return tmdbMovies.getMovieCredits(movieId); } /** - * This method should be used when you’re wanting to retrieve all of the images for a particular movie. + * 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 ResultList getMovieImages(int movieId, String language, String... appendToResponse) throws MovieDbException { - return tmdbMovies.getMovieImages(movieId, language, appendToResponse); + public ResultList getMovieImages(int movieId, String language) throws MovieDbException { + return tmdbMovies.getMovieImages(movieId, language); } /** - * This method is used to retrieve all of the keywords that have been added to a particular movie. + * 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 ResultList getMovieKeywords(int movieId, String... appendToResponse) throws MovieDbException { - return tmdbMovies.getMovieKeywords(movieId, appendToResponse); + public ResultList getMovieKeywords(int movieId) throws MovieDbException { + return tmdbMovies.getMovieKeywords(movieId); } /** - * This method is used to retrieve all of the release and certification data we have for a specific movie. + * 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 ResultList getMovieReleaseInfo(int movieId, String language, String... appendToResponse) throws MovieDbException { - return tmdbMovies.getMovieReleaseInfo(movieId, language, appendToResponse); + public ResultList getMovieReleaseInfo(int movieId, String language) throws MovieDbException { + return tmdbMovies.getMovieReleaseInfo(movieId, language); } /** - * This method is used to retrieve all of the trailers for a particular movie. + * 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 ResultList