diff --git a/pom.xml b/pom.xml index 15802c294..41b6e9a29 100644 --- a/pom.xml +++ b/pom.xml @@ -77,6 +77,8 @@ 1.7 ${maven.build.timestamp} yyyy-MM-dd-HHmm + + -Xdoclint:none diff --git a/src/main/java/com/omertron/themoviedbapi/TheMovieDbApi.java b/src/main/java/com/omertron/themoviedbapi/TheMovieDbApi.java index 88d20b1a5..0bc61d426 100644 --- a/src/main/java/com/omertron/themoviedbapi/TheMovieDbApi.java +++ b/src/main/java/com/omertron/themoviedbapi/TheMovieDbApi.java @@ -100,7 +100,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 */ @@ -133,8 +134,8 @@ public class TheMovieDbApi { /** * API for The Movie Db. * - * @param apiKey - * @throws MovieDbException + * @param apiKey apiKey + * @throws MovieDbException exception */ public TheMovieDbApi(String apiKey) throws MovieDbException { this(apiKey, new SimpleHttpClientBuilder().build()); @@ -143,9 +144,9 @@ public class TheMovieDbApi { /** * API for The Movie Db. * - * @param apiKey + * @param apiKey apiKey * @param httpClient The httpClient to use for web requests. - * @throws MovieDbException + * @throws MovieDbException exception */ public TheMovieDbApi(String apiKey, HttpClient httpClient) throws MovieDbException { this.httpTools = new HttpTools(httpClient); @@ -155,8 +156,8 @@ public class TheMovieDbApi { /** * Initialise the sub-classes once the API key and http client are known * - * @param apiKey - * @param httpTools + * @param apiKey apiKey + * @param httpTools httpTools */ private void initialise(String apiKey, HttpTools httpTools) { tmdbAccount = new TmdbAccount(apiKey, httpTools); @@ -184,11 +185,12 @@ 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 - * @throws MovieDbException + * @param sessionId sessionId + * @return Account + * @throws MovieDbException exception */ public Account getAccount(String sessionId) throws MovieDbException { return tmdbAccount.getAccount(sessionId); @@ -197,10 +199,10 @@ public class TheMovieDbApi { /** * Get all lists of a given user * - * @param sessionId - * @param accountId + * @param sessionId sessionId + * @param accountId accountId * @return The lists - * @throws MovieDbException + * @throws MovieDbException exception */ public ResultList getUserLists(String sessionId, int accountId) throws MovieDbException { return tmdbAccount.getUserLists(sessionId, accountId); @@ -209,10 +211,10 @@ public class TheMovieDbApi { /** * Get the account favourite movies * - * @param sessionId - * @param accountId - * @return - * @throws MovieDbException + * @param sessionId sessionId + * @param accountId accountId + * @return ResultList + * @throws MovieDbException exception */ public ResultList getFavoriteMovies(String sessionId, int accountId) throws MovieDbException { return tmdbAccount.getFavoriteMovies(sessionId, accountId); @@ -221,13 +223,13 @@ public class TheMovieDbApi { /** * Add or remove a movie to an accounts favourite list. * - * @param sessionId - * @param accountId - * @param mediaId - * @param mediaType - * @param isFavorite - * @return - * @throws MovieDbException + * @param sessionId sessionId + * @param accountId accountId + * @param mediaId mediaId + * @param mediaType mediaType + * @param isFavorite isFavorite + * @return StatusCode + * @throws MovieDbException exception */ public StatusCode modifyFavoriteStatus(String sessionId, int accountId, Integer mediaId, MediaType mediaType, boolean isFavorite) throws MovieDbException { return tmdbAccount.modifyFavoriteStatus(sessionId, accountId, mediaType, mediaId, isFavorite); @@ -236,13 +238,13 @@ public class TheMovieDbApi { /** * Get the list of rated movies (and associated rating) for an account. * - * @param sessionId - * @param accountId - * @param page - * @param sortBy - * @param language - * @return - * @throws MovieDbException + * @param sessionId sessionId + * @param accountId accountId + * @param page page + * @param sortBy sortBy + * @param language language + * @return ResultList + * @throws MovieDbException exception */ public ResultList getRatedMovies(String sessionId, int accountId, Integer page, String sortBy, String language) throws MovieDbException { return tmdbAccount.getRatedMovies(sessionId, accountId, page, sortBy, language); @@ -251,13 +253,13 @@ public class TheMovieDbApi { /** * Get the list of rated TV shows (and associated rating) for an account. * - * @param sessionId - * @param accountId - * @param page - * @param sortBy - * @param language - * @return - * @throws MovieDbException + * @param sessionId sessionId + * @param accountId accountId + * @param page page + * @param sortBy sortBy + * @param language language + * @return ResultList + * @throws MovieDbException exception */ public ResultList getRatedTV(String sessionId, int accountId, Integer page, String sortBy, String language) throws MovieDbException { return tmdbAccount.getRatedTV(sessionId, accountId, page, sortBy, language); @@ -266,13 +268,13 @@ public class TheMovieDbApi { /** * Get the list of movies on an accounts watchlist. * - * @param sessionId - * @param accountId - * @param page - * @param sortBy - * @param language + * @param sessionId sessionId + * @param accountId accountId + * @param page page + * @param sortBy sortBy + * @param language language * @return The watchlist of the user - * @throws MovieDbException + * @throws MovieDbException exception */ public ResultList getWatchListMovie(String sessionId, int accountId, Integer page, String sortBy, String language) throws MovieDbException { return tmdbAccount.getWatchListMovie(sessionId, accountId, page, sortBy, language); @@ -281,13 +283,13 @@ public class TheMovieDbApi { /** * Get the list of movies on an accounts watchlist. * - * @param sessionId - * @param accountId - * @param page - * @param sortBy - * @param language + * @param sessionId sessionId + * @param accountId accountId + * @param page page + * @param sortBy sortBy + * @param language language * @return The watchlist of the user - * @throws MovieDbException + * @throws MovieDbException exception */ public ResultList getWatchListTV(String sessionId, int accountId, Integer page, String sortBy, String language) throws MovieDbException { return tmdbAccount.getWatchListTV(sessionId, accountId, page, sortBy, language); @@ -296,12 +298,12 @@ public class TheMovieDbApi { /** * Add a movie to an accounts watch list. * - * @param sessionId - * @param accountId - * @param mediaId - * @param mediaType - * @return - * @throws MovieDbException + * @param sessionId sessionId + * @param accountId accountId + * @param mediaId mediaId + * @param mediaType mediaType + * @return StatusCode + * @throws MovieDbException exception */ public StatusCode addToWatchList(String sessionId, int accountId, MediaType mediaType, Integer mediaId) throws MovieDbException { return tmdbAccount.modifyWatchList(sessionId, accountId, mediaType, mediaId, true); @@ -310,12 +312,12 @@ public class TheMovieDbApi { /** * Remove a movie from an accounts watch list. * - * @param sessionId - * @param accountId - * @param mediaId - * @param mediaType - * @return - * @throws MovieDbException + * @param sessionId sessionId + * @param accountId accountId + * @param mediaId mediaId + * @param mediaType mediaType + * @return StatusCode + * @throws MovieDbException exception */ public StatusCode removeFromWatchList(String sessionId, int accountId, MediaType mediaType, Integer mediaId) throws MovieDbException { return tmdbAccount.modifyWatchList(sessionId, accountId, mediaType, mediaId, false); @@ -324,10 +326,10 @@ public class TheMovieDbApi { /** * Get the list of favorite TV series for an account. * - * @param sessionId - * @param accountId - * @return - * @throws MovieDbException + * @param sessionId sessionId + * @param accountId accountId + * @return ResultList + * @throws MovieDbException exception */ public ResultList getFavoriteTv(String sessionId, int accountId) throws MovieDbException { return tmdbAccount.getFavoriteTv(sessionId, accountId); @@ -336,12 +338,12 @@ public class TheMovieDbApi { /** * Get a list of rated movies for a specific guest session id. * - * @param guestSessionId - * @param language - * @param page + * @param guestSessionId guestSessionId + * @param language language + * @param page page * @param sortBy only CREATED_AT_ASC or CREATED_AT_DESC is supported - * @return - * @throws MovieDbException + * @return ResultList + * @throws MovieDbException exception */ public ResultList getGuestRatedMovies(String guestSessionId, String language, Integer page, SortBy sortBy) throws MovieDbException { return tmdbAccount.getGuestRatedMovies(guestSessionId, language, page, sortBy); @@ -350,44 +352,49 @@ 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 + * @return TokenAuthorisation + * @throws MovieDbException exception */ public TokenAuthorisation getAuthorisationToken() throws MovieDbException { return tmdbAuth.getAuthorisationToken(); } /** - * 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. * - * @param token - * @return - * @throws MovieDbException + * @param token token + * @return TokenSession + * @throws MovieDbException exception */ public TokenSession getSessionToken(TokenAuthorisation token) throws MovieDbException { return tmdbAuth.getSessionToken(token); } /** - * 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. * * @param token Session token * @param username User's username * @param password User's password - * @return - * @throws MovieDbException + * @return TokenAuthorisation + * @throws MovieDbException exception */ public TokenAuthorisation getSessionTokenLogin(TokenAuthorisation token, String username, String password) throws MovieDbException { return tmdbAuth.getSessionTokenLogin(token, username, password); @@ -396,17 +403,21 @@ 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. - * - * @return - * @throws MovieDbException + * If a guest session is not used for the first time within 24 hours, it + * will be automatically discarded. + * + * @return TokenSession + * @throws MovieDbException exception */ public TokenSession getGuestSessionToken() throws MovieDbException { return tmdbAuth.getGuestSessionToken(); @@ -417,8 +428,8 @@ public class TheMovieDbApi { /** * Get a list of movies certification. * - * @return - * @throws MovieDbException + * @return ResultsMap + * @throws MovieDbException exception */ public ResultsMap> getMoviesCertification() throws MovieDbException { return tmdbCertifications.getMoviesCertification(); @@ -427,8 +438,8 @@ public class TheMovieDbApi { /** * Get a list of tv certification. * - * @return - * @throws MovieDbException + * @return ResultsMap + * @throws MovieDbException exception */ public ResultsMap> getTvCertification() throws MovieDbException { return tmdbCertifications.getTvCertification(); @@ -439,13 +450,14 @@ 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 page page * @param startDate the start date of the changes, optional * @param endDate the end date of the changes, optional * @return List of changed movie - * @throws MovieDbException + * @throws MovieDbException exception */ public ResultList getMovieChangeList(Integer page, String startDate, String endDate) throws MovieDbException { return tmdbChanges.getChangeList(MethodBase.MOVIE, page, startDate, endDate); @@ -454,13 +466,14 @@ 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 page page * @param startDate the start date of the changes, optional * @param endDate the end date of the changes, optional * @return List of changed movie - * @throws MovieDbException + * @throws MovieDbException exception */ public ResultList getTvChangeList(Integer page, String startDate, String endDate) throws MovieDbException { return tmdbChanges.getChangeList(MethodBase.TV, page, startDate, endDate); @@ -469,13 +482,14 @@ 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 page page * @param startDate the start date of the changes, optional * @param endDate the end date of the changes, optional * @return List of changed movie - * @throws MovieDbException + * @throws MovieDbException exception */ public ResultList getPersonChangeList(Integer page, String startDate, String endDate) throws MovieDbException { return tmdbChanges.getChangeList(MethodBase.PERSON, page, startDate, endDate); @@ -484,14 +498,16 @@ 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 - * @return - * @throws MovieDbException + * @param collectionId collectionId + * @param language language + * @return CollectionInfo + * @throws MovieDbException exception */ public CollectionInfo getCollectionInfo(int collectionId, String language) throws MovieDbException { return tmdbCollections.getCollectionInfo(collectionId, language); @@ -500,10 +516,10 @@ public class TheMovieDbApi { /** * Get all of the images for a particular collection by collection id. * - * @param collectionId - * @param language - * @return - * @throws MovieDbException + * @param collectionId collectionId + * @param language language + * @return ResultList + * @throws MovieDbException exception */ public ResultList getCollectionImages(int collectionId, String language) throws MovieDbException { return tmdbCollections.getCollectionImages(collectionId, language); @@ -512,11 +528,12 @@ 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 - * @throws MovieDbException + * @param companyId companyId + * @return Company + * @throws MovieDbException exception */ public Company getCompanyInfo(int companyId) throws MovieDbException { return tmdbCompany.getCompanyInfo(companyId); @@ -525,13 +542,14 @@ 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 - * @param page + * @param companyId companyId + * @param language language + * @param page page * @return - * @throws MovieDbException + * @throws MovieDbException exception */ public ResultList getCompanyMovies(int companyId, String language, Integer page) throws MovieDbException { return tmdbCompany.getCompanyMovies(companyId, language, page); @@ -552,10 +570,10 @@ public class TheMovieDbApi { /** * Generate the full image URL from the size and image path * - * @param imagePath - * @param requiredSize + * @param imagePath imagePath + * @param requiredSize requiredSize * @return - * @throws MovieDbException + * @throws MovieDbException exception */ public URL createImageUrl(String imagePath, String requiredSize) throws MovieDbException { return tmdbConfiguration.getConfig().createImageUrl(imagePath, requiredSize); @@ -565,14 +583,15 @@ public class TheMovieDbApi { * Get a list of valid jobs * * @return - * @throws MovieDbException + * @throws MovieDbException exception */ public ResultList getJobs() throws MovieDbException { return tmdbConfiguration.getJobs(); } /** - * 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 */ @@ -587,16 +606,19 @@ 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 + * @param creditId creditId + * @param language language * @return - * @throws MovieDbException + * @throws MovieDbException exception */ public CreditInfo getCreditInfo(String creditId, String language) throws MovieDbException { return tmdbCredits.getCreditInfo(creditId, language); @@ -605,22 +627,24 @@ 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 - * @throws MovieDbException + * @throws MovieDbException exception */ public ResultList getDiscoverMovies(Discover discover) throws MovieDbException { return tmdbDiscover.getDiscoverMovies(discover); } /** - * 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 - * @throws MovieDbException + * @throws MovieDbException exception */ public ResultList getDiscoverTV(Discover discover) throws MovieDbException { return tmdbDiscover.getDiscoverTV(discover); @@ -629,16 +653,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 @@ -647,7 +673,7 @@ public class TheMovieDbApi { * @param externalSource one of {@link ExternalSource}. * @param language the language * @return - * @throws MovieDbException + * @throws MovieDbException exception */ public FindResults find(String id, ExternalSource externalSource, String language) throws MovieDbException { return tmdbFind.find(id, externalSource, language); @@ -658,9 +684,9 @@ public class TheMovieDbApi { /** * Get the list of Movie genres. * - * @param language + * @param language language * @return - * @throws MovieDbException + * @throws MovieDbException exception */ public ResultList getGenreMovieList(String language) throws MovieDbException { return tmdbGenre.getGenreMovieList(language); @@ -669,9 +695,9 @@ public class TheMovieDbApi { /** * Get the list of TV genres.. * - * @param language + * @param language language * @return - * @throws MovieDbException + * @throws MovieDbException exception */ public ResultList getGenreTVList(String language) throws MovieDbException { return tmdbGenre.getGenreTVList(language); @@ -680,17 +706,19 @@ 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 - * @param page - * @param includeAllMovies - * @param includeAdult + * @param genreId genreId + * @param language language + * @param page page + * @param includeAllMovies includeAllMovies + * @param includeAdult includeAdult * @return - * @throws MovieDbException + * @throws MovieDbException exception */ public ResultList getGenreMovies(int genreId, String language, Integer page, Boolean includeAllMovies, Boolean includeAdult) throws MovieDbException { return tmdbGenre.getGenreMovies(genreId, language, page, includeAllMovies, includeAdult); @@ -701,9 +729,9 @@ public class TheMovieDbApi { /** * Get the basic information for a specific keyword id. * - * @param keywordId + * @param keywordId keywordId * @return - * @throws MovieDbException + * @throws MovieDbException exception */ public Keyword getKeyword(String keywordId) throws MovieDbException { return tmdbKeywords.getKeyword(keywordId); @@ -712,11 +740,11 @@ public class TheMovieDbApi { /** * Get the list of movies for a particular keyword by id. * - * @param keywordId - * @param language - * @param page + * @param keywordId keywordId + * @param language language + * @param page page * @return List of movies with the keyword - * @throws MovieDbException + * @throws MovieDbException exception */ public ResultList getKeywordMovies(String keywordId, String language, Integer page) throws MovieDbException { return tmdbKeywords.getKeywordMovies(keywordId, language, page); @@ -727,9 +755,9 @@ public class TheMovieDbApi { /** * Get a list by its ID * - * @param listId + * @param listId listId * @return The list and its items - * @throws MovieDbException + * @throws MovieDbException exception */ public ListItem getList(String listId) throws MovieDbException { return tmdbList.getList(listId); @@ -738,23 +766,24 @@ public class TheMovieDbApi { /** * This method lets users create a new list. A valid session id is required. * - * @param sessionId - * @param name - * @param description + * @param sessionId sessionId + * @param name name + * @param description description * @return The list id - * @throws MovieDbException + * @throws MovieDbException exception */ public String createList(String sessionId, String name, String description) throws MovieDbException { return tmdbList.createList(sessionId, name, description); } /** - * 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 + * @param sessionId sessionId + * @param listId listId * @return - * @throws MovieDbException + * @throws MovieDbException exception */ public StatusCode deleteList(String sessionId, String listId) throws MovieDbException { return tmdbList.deleteList(sessionId, listId); @@ -763,10 +792,10 @@ public class TheMovieDbApi { /** * Check to see if an item is already on a list. * - * @param listId - * @param mediaId + * @param listId listId + * @param mediaId mediaId * @return true if the item is on the list - * @throws MovieDbException + * @throws MovieDbException exception */ public boolean checkItemStatus(String listId, Integer mediaId) throws MovieDbException { return tmdbList.checkItemStatus(listId, mediaId); @@ -777,11 +806,11 @@ public class TheMovieDbApi { * * A valid session id is required. * - * @param sessionId - * @param listId - * @param mediaId + * @param sessionId sessionId + * @param listId listId + * @param mediaId mediaId * @return true if the movie is on the list - * @throws MovieDbException + * @throws MovieDbException exception */ public StatusCode addItemToList(String sessionId, String listId, Integer mediaId) throws MovieDbException { return tmdbList.addItem(sessionId, listId, mediaId); @@ -792,11 +821,11 @@ public class TheMovieDbApi { * * A valid session id is required. * - * @param sessionId - * @param listId - * @param mediaId + * @param sessionId sessionId + * @param listId listId + * @param mediaId mediaId * @return true if the movie is on the list - * @throws MovieDbException + * @throws MovieDbException exception */ public StatusCode removeItemFromList(String sessionId, String listId, Integer mediaId) throws MovieDbException { return tmdbList.removeItem(sessionId, listId, mediaId); @@ -809,13 +838,14 @@ 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 - * @param appendToResponse + * @param movieId movieId + * @param language language + * @param appendToResponse appendToResponse * @return - * @throws MovieDbException + * @throws MovieDbException exception */ public MovieInfo getMovieInfo(int movieId, String language, String... appendToResponse) throws MovieDbException { return tmdbMovies.getMovieInfo(movieId, language, appendToResponse); @@ -826,40 +856,42 @@ 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 - * @param appendToResponse + * @param imdbId imdbId + * @param language language + * @param appendToResponse appendToResponse * @return - * @throws MovieDbException + * @throws MovieDbException exception */ public MovieInfo 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. + * 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 + * @param movieId movieId + * @param sessionId sessionId * @return - * @throws MovieDbException + * @throws MovieDbException exception */ 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. + * This method is used to retrieve all of the alternative titles we have for + * a particular movie. * - * @param movieId - * @param country + * @param movieId movieId + * @param country country * @return - * @throws MovieDbException + * @throws MovieDbException exception */ public ResultList getMovieAlternativeTitles(int movieId, String country) throws MovieDbException { return tmdbMovies.getMovieAlternativeTitles(movieId, country); @@ -868,88 +900,95 @@ public class TheMovieDbApi { /** * Get the cast and crew information for a specific movie id. * - * @param movieId + * @param movieId movieId * @return - * @throws MovieDbException + * @throws MovieDbException exception */ 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 movieId movieId + * @param language language * @return - * @throws MovieDbException + * @throws MovieDbException exception */ 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 movieId movieId * @return - * @throws MovieDbException + * @throws MovieDbException exception */ 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 movieId movieId + * @param language language * @return - * @throws MovieDbException + * @throws MovieDbException exception */ 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 movieId movieId + * @param language language * @return - * @throws MovieDbException + * @throws MovieDbException exception */ public ResultList