From 490a9dc397b0f25906bb82f64eda03aeeb370102 Mon Sep 17 00:00:00 2001 From: Stuart Boston Date: Wed, 3 Apr 2013 16:09:20 +0200 Subject: [PATCH] Wagon: Deploying site to repository --- apidocs/allclasses-frame.html | 211 +- apidocs/allclasses-noframe.html | 211 +- ...MovieDbException.MovieDbExceptionType.html | 769 ++-- .../themoviedbapi/MovieDbException.html | 613 ++- .../omertron/themoviedbapi/TheMovieDbApi.html | 2939 ++++++------ ...MovieDbException.MovieDbExceptionType.html | 380 +- .../class-use/MovieDbException.html | 1118 +++-- .../class-use/TheMovieDbApi.html | 325 +- .../themoviedbapi/model/AlternativeTitle.html | 756 +-- .../omertron/themoviedbapi/model/Artwork.html | 1251 ++--- .../themoviedbapi/model/ArtworkType.html | 627 +-- .../themoviedbapi/model/ChangeItem.html | 904 ++-- .../themoviedbapi/model/ChangeValue.html | 929 ++-- .../themoviedbapi/model/Collection.html | 1036 +++-- .../themoviedbapi/model/CollectionInfo.html | 888 ++-- .../omertron/themoviedbapi/model/Company.html | 1033 +++-- .../omertron/themoviedbapi/model/Genre.html | 756 +-- .../omertron/themoviedbapi/model/Keyword.html | 756 +-- .../themoviedbapi/model/KeywordMovie.html | 1094 +++-- .../themoviedbapi/model/Language.html | 756 +-- .../themoviedbapi/model/MovieChanges.html | 639 +-- .../omertron/themoviedbapi/model/MovieDb.html | 2231 +++++---- .../themoviedbapi/model/MovieDbList.html | 1068 +++-- .../themoviedbapi/model/MovieList.html | 1098 +++-- .../omertron/themoviedbapi/model/Person.html | 1920 ++++---- .../themoviedbapi/model/PersonCast.html | 1036 +++-- .../themoviedbapi/model/PersonCredit.html | 1238 ++--- .../themoviedbapi/model/PersonCrew.html | 966 ++-- .../themoviedbapi/model/PersonType.html | 628 +-- .../model/ProductionCompany.html | 756 +-- .../model/ProductionCountry.html | 756 +-- .../themoviedbapi/model/ReleaseInfo.html | 826 ++-- .../themoviedbapi/model/StatusCode.html | 678 +-- .../model/TmdbConfiguration.html | 1204 ++--- .../model/TokenAuthorisation.html | 712 +-- .../themoviedbapi/model/TokenSession.html | 904 ++-- .../omertron/themoviedbapi/model/Trailer.html | 997 ++-- .../themoviedbapi/model/Translation.html | 826 ++-- .../model/class-use/AlternativeTitle.html | 394 +- .../model/class-use/Artwork.html | 576 ++- .../model/class-use/ArtworkType.html | 369 +- .../model/class-use/ChangeItem.html | 339 +- .../model/class-use/ChangeValue.html | 363 +- .../model/class-use/Collection.html | 534 ++- .../model/class-use/CollectionInfo.html | 314 +- .../model/class-use/Company.html | 425 +- .../themoviedbapi/model/class-use/Genre.html | 472 +- .../model/class-use/Keyword.html | 463 +- .../model/class-use/KeywordMovie.html | 396 +- .../model/class-use/Language.html | 339 +- .../model/class-use/MovieChanges.html | 396 +- .../model/class-use/MovieDb.html | 760 +-- .../model/class-use/MovieDbList.html | 312 +- .../model/class-use/MovieList.html | 414 +- .../themoviedbapi/model/class-use/Person.html | 455 +- .../model/class-use/PersonCast.html | 339 +- .../model/class-use/PersonCredit.html | 416 +- .../model/class-use/PersonCrew.html | 339 +- .../model/class-use/PersonType.html | 393 +- .../model/class-use/ProductionCompany.html | 339 +- .../model/class-use/ProductionCountry.html | 339 +- .../model/class-use/ReleaseInfo.html | 394 +- .../model/class-use/StatusCode.html | 234 +- .../model/class-use/TmdbConfiguration.html | 445 +- .../model/class-use/TokenAuthorisation.html | 343 +- .../model/class-use/TokenSession.html | 326 +- .../model/class-use/Trailer.html | 418 +- .../model/class-use/Translation.html | 392 +- .../themoviedbapi/model/package-frame.html | 150 +- .../themoviedbapi/model/package-summary.html | 528 +-- .../themoviedbapi/model/package-tree.html | 329 +- .../themoviedbapi/model/package-use.html | 812 ++-- .../omertron/themoviedbapi/package-frame.html | 81 +- .../themoviedbapi/package-summary.html | 325 +- .../omertron/themoviedbapi/package-tree.html | 292 +- .../omertron/themoviedbapi/package-use.html | 351 +- .../omertron/themoviedbapi/tools/ApiUrl.html | 1227 ++--- .../themoviedbapi/tools/WebBrowser.html | 946 ++-- .../themoviedbapi/tools/class-use/ApiUrl.html | 234 +- .../tools/class-use/WebBrowser.html | 234 +- .../themoviedbapi/tools/package-frame.html | 54 +- .../themoviedbapi/tools/package-summary.html | 277 +- .../themoviedbapi/tools/package-tree.html | 257 +- .../themoviedbapi/tools/package-use.html | 234 +- .../wrapper/WrapperAlternativeTitles.html | 615 +-- .../themoviedbapi/wrapper/WrapperBase.html | 755 +-- .../themoviedbapi/wrapper/WrapperChanges.html | 551 +-- .../wrapper/WrapperCollection.html | 531 +-- .../themoviedbapi/wrapper/WrapperCompany.html | 531 +-- .../wrapper/WrapperCompanyMovies.html | 570 +-- .../themoviedbapi/wrapper/WrapperConfig.html | 615 +-- .../themoviedbapi/wrapper/WrapperGenres.html | 556 +-- .../themoviedbapi/wrapper/WrapperImages.html | 659 +-- .../wrapper/WrapperKeywordMovies.html | 531 +-- .../wrapper/WrapperKeywords.html | 531 +-- .../themoviedbapi/wrapper/WrapperMovie.html | 570 +-- .../wrapper/WrapperMovieCasts.html | 679 +-- .../wrapper/WrapperMovieKeywords.html | 615 +-- .../wrapper/WrapperMovieList.html | 531 +-- .../themoviedbapi/wrapper/WrapperPerson.html | 531 +-- .../wrapper/WrapperPersonCredits.html | 595 +-- .../wrapper/WrapperReleaseInfo.html | 615 +-- .../wrapper/WrapperTrailers.html | 679 +-- .../wrapper/WrapperTranslations.html | 615 +-- .../class-use/WrapperAlternativeTitles.html | 234 +- .../wrapper/class-use/WrapperBase.html | 418 +- .../wrapper/class-use/WrapperChanges.html | 234 +- .../wrapper/class-use/WrapperCollection.html | 234 +- .../wrapper/class-use/WrapperCompany.html | 234 +- .../class-use/WrapperCompanyMovies.html | 234 +- .../wrapper/class-use/WrapperConfig.html | 234 +- .../wrapper/class-use/WrapperGenres.html | 234 +- .../wrapper/class-use/WrapperImages.html | 234 +- .../class-use/WrapperKeywordMovies.html | 234 +- .../wrapper/class-use/WrapperKeywords.html | 234 +- .../wrapper/class-use/WrapperMovie.html | 234 +- .../wrapper/class-use/WrapperMovieCasts.html | 234 +- .../class-use/WrapperMovieKeywords.html | 234 +- .../wrapper/class-use/WrapperMovieList.html | 234 +- .../wrapper/class-use/WrapperPerson.html | 234 +- .../class-use/WrapperPersonCredits.html | 234 +- .../wrapper/class-use/WrapperReleaseInfo.html | 234 +- .../wrapper/class-use/WrapperTrailers.html | 234 +- .../class-use/WrapperTranslations.html | 234 +- .../themoviedbapi/wrapper/package-frame.html | 108 +- .../wrapper/package-summary.html | 421 +- .../themoviedbapi/wrapper/package-tree.html | 280 +- .../themoviedbapi/wrapper/package-use.html | 295 +- apidocs/constant-values.html | 514 ++- apidocs/deprecated-list.html | 281 +- apidocs/help-doc.html | 418 +- apidocs/index-all.html | 4060 +++++++++-------- apidocs/index.html | 54 +- apidocs/overview-frame.html | 71 +- apidocs/overview-summary.html | 284 +- apidocs/overview-tree.html | 374 +- apidocs/serialized-form.html | 2993 +++++++----- apidocs/stylesheet.css | 501 +- dependencies.html | 16 +- index.html | 6 +- issue-tracking.html | 6 +- license.html | 6 +- project-info.html | 6 +- project-reports.html | 6 +- project-summary.html | 6 +- source-repository.html | 6 +- testapidocs/allclasses-frame.html | 52 +- testapidocs/allclasses-noframe.html | 52 +- .../omertron/themoviedbapi/TestLogger.html | 451 +- .../themoviedbapi/TheMovieDbApiTest.html | 2665 ++++++----- .../themoviedbapi/class-use/TestLogger.html | 230 +- .../class-use/TheMovieDbApiTest.html | 230 +- .../omertron/themoviedbapi/package-frame.html | 54 +- .../themoviedbapi/package-summary.html | 271 +- .../omertron/themoviedbapi/package-tree.html | 246 +- .../omertron/themoviedbapi/package-use.html | 230 +- testapidocs/constant-values.html | 232 +- testapidocs/deprecated-list.html | 232 +- testapidocs/help-doc.html | 404 +- testapidocs/index-all.html | 653 ++- testapidocs/index.html | 48 +- testapidocs/overview-tree.html | 252 +- testapidocs/stylesheet.css | 501 +- 163 files changed, 47708 insertions(+), 40750 deletions(-) diff --git a/apidocs/allclasses-frame.html b/apidocs/allclasses-frame.html index 696533929..f5a7e6b67 100644 --- a/apidocs/allclasses-frame.html +++ b/apidocs/allclasses-frame.html @@ -1,73 +1,140 @@ - - - - - -All Classes (API-The MovieDB 3.5-SNAPSHOT API) - - - - -

All Classes

-
- -
- - + + + + + + +All Classes (API-The MovieDB 3.5-SNAPSHOT API) + + + + + + + + + + + +All Classes +
+ + + + + +
AlternativeTitle +
+ApiUrl +
+Artwork +
+ArtworkType +
+ChangeItem +
+ChangeValue +
+Collection +
+CollectionInfo +
+Company +
+Genre +
+Keyword +
+KeywordMovie +
+Language +
+MovieChanges +
+MovieDb +
+MovieDbException +
+MovieDbException.MovieDbExceptionType +
+MovieDbList +
+MovieList +
+Person +
+PersonCast +
+PersonCredit +
+PersonCrew +
+PersonType +
+ProductionCompany +
+ProductionCountry +
+ReleaseInfo +
+StatusCode +
+TheMovieDbApi +
+TmdbConfiguration +
+TokenAuthorisation +
+TokenSession +
+Trailer +
+Translation +
+WebBrowser +
+WrapperAlternativeTitles +
+WrapperBase +
+WrapperChanges +
+WrapperCollection +
+WrapperCompany +
+WrapperCompanyMovies +
+WrapperConfig +
+WrapperGenres +
+WrapperImages +
+WrapperKeywordMovies +
+WrapperKeywords +
+WrapperMovie +
+WrapperMovieCasts +
+WrapperMovieKeywords +
+WrapperMovieList +
+WrapperPerson +
+WrapperPersonCredits +
+WrapperReleaseInfo +
+WrapperTrailers +
+WrapperTranslations +
+
+ + + diff --git a/apidocs/allclasses-noframe.html b/apidocs/allclasses-noframe.html index 347b7e2c6..1adac17d3 100644 --- a/apidocs/allclasses-noframe.html +++ b/apidocs/allclasses-noframe.html @@ -1,73 +1,140 @@ - - - - - -All Classes (API-The MovieDB 3.5-SNAPSHOT API) - - - - -

All Classes

-
- -
- - + + + + + + +All Classes (API-The MovieDB 3.5-SNAPSHOT API) + + + + + + + + + + + +All Classes +
+ + + + + +
AlternativeTitle +
+ApiUrl +
+Artwork +
+ArtworkType +
+ChangeItem +
+ChangeValue +
+Collection +
+CollectionInfo +
+Company +
+Genre +
+Keyword +
+KeywordMovie +
+Language +
+MovieChanges +
+MovieDb +
+MovieDbException +
+MovieDbException.MovieDbExceptionType +
+MovieDbList +
+MovieList +
+Person +
+PersonCast +
+PersonCredit +
+PersonCrew +
+PersonType +
+ProductionCompany +
+ProductionCountry +
+ReleaseInfo +
+StatusCode +
+TheMovieDbApi +
+TmdbConfiguration +
+TokenAuthorisation +
+TokenSession +
+Trailer +
+Translation +
+WebBrowser +
+WrapperAlternativeTitles +
+WrapperBase +
+WrapperChanges +
+WrapperCollection +
+WrapperCompany +
+WrapperCompanyMovies +
+WrapperConfig +
+WrapperGenres +
+WrapperImages +
+WrapperKeywordMovies +
+WrapperKeywords +
+WrapperMovie +
+WrapperMovieCasts +
+WrapperMovieKeywords +
+WrapperMovieList +
+WrapperPerson +
+WrapperPersonCredits +
+WrapperReleaseInfo +
+WrapperTrailers +
+WrapperTranslations +
+
+ + + diff --git a/apidocs/com/omertron/themoviedbapi/MovieDbException.MovieDbExceptionType.html b/apidocs/com/omertron/themoviedbapi/MovieDbException.MovieDbExceptionType.html index bc6776cb8..4f64d3689 100644 --- a/apidocs/com/omertron/themoviedbapi/MovieDbException.MovieDbExceptionType.html +++ b/apidocs/com/omertron/themoviedbapi/MovieDbException.MovieDbExceptionType.html @@ -1,399 +1,422 @@ - - - - - -MovieDbException.MovieDbExceptionType (API-The MovieDB 3.5-SNAPSHOT API) - - - - - - +} + + + + + + +
+ + -
- - - - - -
-
- - - -
- -
-
- - -
- - -
+ + + + + + + + + SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD + +DETAIL: ENUM CONSTANTS | FIELD | METHOD + + + + +
-
-
com.omertron.themoviedbapi
-

Enum MovieDbException.MovieDbExceptionType

-
-
- -
- -
-
- -
-
- -
-
+not permitted.) +

+

+
Parameters:
name - the name of the enum constant to be returned. +
Returns:
the enum constant with the specified name +
Throws: +
IllegalArgumentException - if this enum type has no constant +with the specified name +
NullPointerException - if the argument is null
+
+ +
+ + -
- - - - - -
-
- - - -
- -
-
- - -
- - -
+ + + + + + + + + SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD + +DETAIL: ENUM CONSTANTS | FIELD | METHOD + + + -

Copyright © 2012-2013. All Rights Reserved.

- - + +
+Copyright © 2012-2013. All Rights Reserved. + + diff --git a/apidocs/com/omertron/themoviedbapi/MovieDbException.html b/apidocs/com/omertron/themoviedbapi/MovieDbException.html index ec15fad34..cc457b6e7 100644 --- a/apidocs/com/omertron/themoviedbapi/MovieDbException.html +++ b/apidocs/com/omertron/themoviedbapi/MovieDbException.html @@ -1,330 +1,325 @@ - - - - - -MovieDbException (API-The MovieDB 3.5-SNAPSHOT API) - - - - - - +} + + + + + + +
+ + -
- - - - - -
-
- - - -
- -
-
- - -
- - -
+ + + + + + + + + SUMMARY: NESTED | FIELD | CONSTR | METHOD + +DETAIL: FIELD | CONSTR | METHOD + + + + +
-
-
com.omertron.themoviedbapi
-

Class MovieDbException

-
-
- -
- -
-
- -
-
- -
-
+ + + + + + +
+Method Detail
+ +

+getExceptionType

+
+public MovieDbException.MovieDbExceptionType getExceptionType()
+
+
+
+
+
+
+ +

+getResponse

+
+public String getResponse()
+
+
+
+
+
+
+ + -
- - - - - -
-
- - - -
- -
-
- - -
- - -
+ + + + + + + + + SUMMARY: NESTED | FIELD | CONSTR | METHOD + +DETAIL: FIELD | CONSTR | METHOD + + + -

Copyright © 2012-2013. All Rights Reserved.

- - + +
+Copyright © 2012-2013. All Rights Reserved. + + diff --git a/apidocs/com/omertron/themoviedbapi/TheMovieDbApi.html b/apidocs/com/omertron/themoviedbapi/TheMovieDbApi.html index 9c9b1a486..97a6c991c 100644 --- a/apidocs/com/omertron/themoviedbapi/TheMovieDbApi.html +++ b/apidocs/com/omertron/themoviedbapi/TheMovieDbApi.html @@ -1,680 +1,807 @@ - - - - - -TheMovieDbApi (API-The MovieDB 3.5-SNAPSHOT API) - - - - - - +} + + + + + + +
+ + -
- - - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
- -
- - -
+ + + + + + + + + SUMMARY: NESTED | FIELD | CONSTR | METHOD + +DETAIL: FIELD | CONSTR | METHOD + + + + +
-
-
com.omertron.themoviedbapi
-

Class TheMovieDbApi

-
-
- -
-
    -
  • -
    -
    -
    public class TheMovieDbApi
-extends Object
    -
    The MovieDb API

    This is for version 3 of the API as specified here: http://help.themoviedb.org/kb/api/about-3

    -
    Author:
    -
    stuart.boston
    -
    • -
-
-
-
    -
  • +

    + +com.omertron.themoviedbapi +
    +Class TheMovieDbApi

    +
    +java.lang.Object
+  extended by com.omertron.themoviedbapi.TheMovieDbApi
+
    +
    +
    +
    public class TheMovieDbApi
    extends Object
    + + +

    +The MovieDb API

    This is for version 3 of the API as specified here: http://help.themoviedb.org/kb/api/about-3 +

    + +

    +

    +
    Author:
    +
    stuart.boston
    +
    +
    + +

    + -

      -
    • - - -

      Constructor Summary

      - - - - - - - - -
      Constructors 
      Constructor and Description
      TheMovieDbApi(String apiKey) -
      API for The Movie Db.
      -
      -
      • -
    + + + + + + + + + +
    +Constructor Summary
    TheMovieDbApi(String apiKey) + +
    +          API for The Movie Db.
    +  -
      -
    • - - -

      Method Summary

      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      static booleancompareMovies(MovieDb moviedb, - String title, - String year) -
      Compare the MovieDB object with a title & year
      -
      static booleancompareMovies(MovieDb moviedb, - String title, - String year, - int maxDistance) -
      Compare the MovieDB object with a title & year
      -
      URLcreateImageUrl(String imagePath, - String requiredSize) -
      Generate the full image URL from the size and image path
      -
      StringgetApiKey() -
      Get the API key that is to be used
      -
      TokenAuthorisationgetAuthorisationToken() -
      This method is used to generate a valid request token for user based authentication.
      -
      List<Artwork>getCollectionImages(int collectionId, - String language) -
      Get all of the images for a particular collection by collection id.
      -
      CollectionInfogetCollectionInfo(int collectionId, - String language) -
      This method is used to retrieve all of the basic information about a movie collection.
      -
      CompanygetCompanyInfo(int companyId) -
      This method is used to retrieve the basic information about a production company on TMDb.
      -
      List<MovieDb>getCompanyMovies(int companyId, - String language, - int page) -
      This method is used to retrieve the movies associated with a company.
      -
      TmdbConfigurationgetConfiguration() -
      Get the configuration information
      -
      List<Genre>getGenreList(String language) -
      You can use this method to retrieve the list of genres used on TMDb.
      -
      List<MovieDb>getGenreMovies(int genreId, - String language, - int page) -
      Deprecated. 
      -
      List<MovieDb>getGenreMovies(int genreId, - String language, - int page, - boolean includeAllMovies) -
      Get a list of movies per genre.
      -
      TokenSessiongetGuestSessionToken() -
      This method is used to generate a guest session id.
      -
      KeywordgetKeyword(String keywordId) -
      Get the basic information for a specific keyword id.
      -
      List<KeywordMovie>getKeywordMovies(String keywordId, - String language, - int page) -
      Get the list of movies for a particular keyword by id.
      -
      MovieDbgetLatestMovie() -
      This method is used to retrieve the newest movie that was added to TMDb.
      -
      MovieDbListgetList(String listId) -
      Get a list by its ID
      -
      List<AlternativeTitle>getMovieAlternativeTitles(int movieId, - String country) -
      This method is used to retrieve all of the alternative titles we have for a particular movie.
      -
      List<Person>getMovieCasts(int movieId) -
      Get the cast information for a specific movie id.
      -
      List<MovieChanges>getMovieChanges(int movieId, - String startDate, - String endDate) -
      Deprecated. 
      -
      voidgetMovieChangesList(int page, - String startDate, - String endDate) 
      List<Artwork>getMovieImages(int movieId, - String language) -
      This method should be used when you’re wanting to retrieve all of the images for a particular movie.
      -
      MovieDbgetMovieInfo(int movieId, - String language) -
      This method is used to retrieve all of the basic movie information.
      -
      MovieDbgetMovieInfoImdb(String imdbId, - String language) -
      This method is used to retrieve all of the basic movie information.
      -
      List<Keyword>getMovieKeywords(int movieId) -
      This method is used to retrieve all of the keywords that have been added to a particular movie.
      -
      List<MovieList>getMovieLists(int movieId, - String language, - int page) -
      Get the lists that the movie belongs to
      -
      List<ReleaseInfo>getMovieReleaseInfo(int movieId, - String language) -
      This method is used to retrieve all of the release and certification data we have for a specific movie.
      -
      List<Trailer>getMovieTrailers(int movieId, - String language) -
      This method is used to retrieve all of the trailers for a particular movie.
      -
      List<Translation>getMovieTranslations(int movieId) -
      This method is used to retrieve a list of the available translations for a specific movie.
      -
      List<MovieDb>getNowPlayingMovies(String language, - int page) -
      This method is used to retrieve the movies currently in theatres.
      -
      voidgetPersonChanges(int personId, - String startDate, - String endDate) -
      Get the changes for a specific person id.
      -
      voidgetPersonChangesList(int page, - String startDate, - String endDate) 
      List<PersonCredit>getPersonCredits(int personId) -
      This method is used to retrieve all of the cast & crew information for the person.
      -
      List<Artwork>getPersonImages(int personId) -
      This method is used to retrieve all of the profile images for a person.
      -
      PersongetPersonInfo(int personId) -
      This method is used to retrieve all of the basic person information.
      -
      PersongetPersonLatest() -
      Get the latest person id.
      -
      List<MovieDb>getPopularMovieList(String language, - int page) -
      This method is used to retrieve the daily movie popularity list.
      -
      TokenSessiongetSessionToken(TokenAuthorisation token) -
      This method is used to generate a session id for user based authentication.
      -
      List<MovieDb>getSimilarMovies(int movieId, - String language, - int page) -
      The similar movies method will let you retrieve the similar movies for a particular movie.
      -
      List<MovieDb>getTopRatedMovies(String language, - int page) -
      This method is used to retrieve the top rated movies that have over 10 votes on TMDb.
      -
      List<MovieDb>getUpcoming(String language, - int page) -
      Get the list of upcoming movies.
      -
      booleanpostMovieRating(String sessionId, - String rating) -
      This method lets users rate a movie.
      -
      List<Collection>searchCollection(String query, - String language, - int page) -
      Search for collections by name.
      -
      List<Company>searchCompanies(String companyName, - int page) -
      Search Companies.
      -
      List<Keyword>searchKeyword(String query, - int page) -
      Search for keywords by name
      -
      List<MovieList>searchList(String query, - String language, - int page) -
      Search for lists by name and description.
      -
      List<MovieDb>searchMovie(String movieName, - int searchYear, - String language, - boolean includeAdult, - int page) -
      Search Movies This is a good starting point to start finding movies on TMDb.
      -
      List<Person>searchPeople(String personName, + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - - - - -
      +Method Summary
      +static booleancompareMovies(MovieDb moviedb, + String title, + String year) + +
      +          Compare the MovieDB object with a title & year
      +static booleancompareMovies(MovieDb moviedb, + String title, + String year, + int maxDistance) + +
      +          Compare the MovieDB object with a title & year
      + URLcreateImageUrl(String imagePath, + String requiredSize) + +
      +          Generate the full image URL from the size and image path
      + StringgetApiKey() + +
      +          Get the API key that is to be used
      + TokenAuthorisationgetAuthorisationToken() + +
      +          This method is used to generate a valid request token for user based authentication.
      + List<Artwork>getCollectionImages(int collectionId, + String language) + +
      +          Get all of the images for a particular collection by collection id.
      + CollectionInfogetCollectionInfo(int collectionId, + String language) + +
      +          This method is used to retrieve all of the basic information about a movie collection.
      + CompanygetCompanyInfo(int companyId) + +
      +          This method is used to retrieve the basic information about a production company on TMDb.
      + List<MovieDb>getCompanyMovies(int companyId, + String language, + int page) + +
      +          This method is used to retrieve the movies associated with a company.
      + TmdbConfigurationgetConfiguration() + +
      +          Get the configuration information
      + List<Genre>getGenreList(String language) + +
      +          You can use this method to retrieve the list of genres used on TMDb.
      + List<MovieDb>getGenreMovies(int genreId, + String language, + int page) + +
      +          Deprecated. 
      + List<MovieDb>getGenreMovies(int genreId, + String language, + int page, + boolean includeAllMovies) + +
      +          Get a list of movies per genre.
      + TokenSessiongetGuestSessionToken() + +
      +          This method is used to generate a guest session id.
      + KeywordgetKeyword(String keywordId) + +
      +          Get the basic information for a specific keyword id.
      + List<KeywordMovie>getKeywordMovies(String keywordId, + String language, + int page) + +
      +          Get the list of movies for a particular keyword by id.
      + MovieDbgetLatestMovie() + +
      +          This method is used to retrieve the newest movie that was added to TMDb.
      + MovieDbListgetList(String listId) + +
      +          Get a list by its ID
      + List<AlternativeTitle>getMovieAlternativeTitles(int movieId, + String country) + +
      +          This method is used to retrieve all of the alternative titles we have for a particular movie.
      + List<Person>getMovieCasts(int movieId) + +
      +          Get the cast information for a specific movie id.
      + List<MovieChanges>getMovieChanges(int movieId, + String startDate, + String endDate) + +
      +          Deprecated. 
      + voidgetMovieChangesList(int page, + String startDate, + String endDate) + +
      +           
      + List<Artwork>getMovieImages(int movieId, + String language) + +
      +          This method should be used when you’re wanting to retrieve all of the images for a particular movie.
      + MovieDbgetMovieInfo(int movieId, + String language) + +
      +          This method is used to retrieve all of the basic movie information.
      + MovieDbgetMovieInfoImdb(String imdbId, + String language) + +
      +          This method is used to retrieve all of the basic movie information.
      + List<Keyword>getMovieKeywords(int movieId) + +
      +          This method is used to retrieve all of the keywords that have been added to a particular movie.
      + List<MovieList>getMovieLists(int movieId, + String language, + int page) + +
      +          Get the lists that the movie belongs to
      + List<ReleaseInfo>getMovieReleaseInfo(int movieId, + String language) + +
      +          This method is used to retrieve all of the release and certification data we have for a specific movie.
      + List<Trailer>getMovieTrailers(int movieId, + String language) + +
      +          This method is used to retrieve all of the trailers for a particular movie.
      + List<Translation>getMovieTranslations(int movieId) + +
      +          This method is used to retrieve a list of the available translations for a specific movie.
      + List<MovieDb>getNowPlayingMovies(String language, + int page) + +
      +          This method is used to retrieve the movies currently in theatres.
      + voidgetPersonChanges(int personId, + String startDate, + String endDate) + +
      +          Get the changes for a specific person id.
      + voidgetPersonChangesList(int page, + String startDate, + String endDate) + +
      +           
      + List<PersonCredit>getPersonCredits(int personId) + +
      +          This method is used to retrieve all of the cast & crew information for the person.
      + List<Artwork>getPersonImages(int personId) + +
      +          This method is used to retrieve all of the profile images for a person.
      + PersongetPersonInfo(int personId) + +
      +          This method is used to retrieve all of the basic person information.
      + PersongetPersonLatest() + +
      +          Get the latest person id.
      + List<MovieDb>getPopularMovieList(String language, + int page) + +
      +          This method is used to retrieve the daily movie popularity list.
      + TokenSessiongetSessionToken(TokenAuthorisation token) + +
      +          This method is used to generate a session id for user based authentication.
      + List<MovieDb>getSimilarMovies(int movieId, + String language, + int page) + +
      +          The similar movies method will let you retrieve the similar movies for a particular movie.
      + List<MovieDb>getTopRatedMovies(String language, + int page) + +
      +          This method is used to retrieve the top rated movies that have over 10 votes on TMDb.
      + List<MovieDb>getUpcoming(String language, + int page) + +
      +          Get the list of upcoming movies.
      + booleanpostMovieRating(String sessionId, + String rating) + +
      +          This method lets users rate a movie.
      + List<Collection>searchCollection(String query, + String language, + int page) + +
      +          Search for collections by name.
      + List<Company>searchCompanies(String companyName, + int page) + +
      +          Search Companies.
      + List<Keyword>searchKeyword(String query, + int page) + +
      +          Search for keywords by name
      + List<MovieList>searchList(String query, + String language, + int page) + +
      +          Search for lists by name and description.
      + List<MovieDb>searchMovie(String movieName, + int searchYear, + String language, boolean includeAdult, - int page) -
      This is a good starting point to start finding people on TMDb.
      -
      voidsetProxy(String host, - String port, - String username, - String password) -
      Set the proxy information
      -
      voidsetTimeout(int connect, - int read) -
      Set the connection and read time out values
      -
      - - - - - - -
      -
        -
      • + int page) + +
        +          Search Movies This is a good starting point to start finding movies on TMDb.
      + List<Person>searchPeople(String personName, + boolean includeAdult, + int page) + +
      +          This is a good starting point to start finding people on TMDb.
      + voidsetProxy(String host, + String port, + String username, + String password) + +
      +          Set the proxy information
      + voidsetTimeout(int connect, + int read) + +
      +          Set the connection and read time out values
      +  + + + + + + + +
      Methods inherited from class java.lang.Object
      clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
      +  +

      + -

      + + + + + + +
      +Constructor Detail
      + +

      +TheMovieDbApi

      +
      +public TheMovieDbApi(String apiKey)
+              throws MovieDbException
      +
      +
      API for The Movie Db. +

      +

      +
      Parameters:
      apiKey - +
      Throws: +
      MovieDbException
      +
      + -
        -
      • - - -

        Method Detail

        - - - -
          -
        • -

          getApiKey

          -
          public String getApiKey()
          -
          Get the API key that is to be used
          -
          • -
        - - - -
          -
        • -

          setProxy

          -
          public void setProxy(String host,
-            String port,
-            String username,
-            String password)
          -
          Set the proxy information
          -
          Parameters:
          host -
          port -
          username -
          password -
          -
          • -
        - - - -
          -
        • -

          setTimeout

          -
          public void setTimeout(int connect,
-              int read)
          -
          Set the connection and read time out values
          -
          Parameters:
          connect -
          read -
          -
          • -
        - - - -
          -
        • -

          compareMovies

          -
          public static boolean compareMovies(MovieDb moviedb,
-                    String title,
-                    String year)
          -
          Compare the MovieDB object with a title & year
          -
          Parameters:
          moviedb - The moviedb object to compare too
          title - The title of the movie to compare
          year - The year of the movie to compare exact match
          -
          Returns:
          True if there is a match, False otherwise.
          -
          • -
        - - - -
          -
        • -

          compareMovies

          -
          public static boolean compareMovies(MovieDb moviedb,
-                    String title,
-                    String year,
-                    int maxDistance)
          -
          Compare the MovieDB object with a title & year
          -
          Parameters:
          moviedb - The moviedb object to compare too
          title - The title of the movie to compare
          year - The year of the movie to compare
          maxDistance - The Levenshtein Distance between the two titles. 0 = exact match
          -
          Returns:
          True if there is a match, False otherwise.
          -
          • -
        - - - -
          -
        • -

          getConfiguration

          -
          public TmdbConfiguration getConfiguration()
          -
          Get the configuration information
          -
          • -
        - - - -
          -
        • -

          createImageUrl

          -
          public URL createImageUrl(String imagePath,
-                 String requiredSize)
-                   throws MovieDbException
          -
          Generate the full image URL from the size and image path
          -
          Parameters:
          imagePath -
          requiredSize -
          -
          Throws:
          -
          MovieDbException
          -
          • -
        - - - -
          -
        • -

          getAuthorisationToken

          -
          public TokenAuthorisation getAuthorisationToken()
-                                         throws MovieDbException
          -
          This method is used to generate a valid request token for user based authentication. + + + + + + +
          +Method Detail
          + +

          +getApiKey

          +
          +public String getApiKey()
          +
          +
          Get the API key that is to be used +

          +

          +
          +
          +
          +
          + +

          +setProxy

          +
          +public void setProxy(String host,
+                     String port,
+                     String username,
+                     String password)
          +
          +
          Set the proxy information +

          +

          +
          Parameters:
          host -
          port -
          username -
          password -
          +
          +
          +
          + +

          +setTimeout

          +
          +public void setTimeout(int connect,
+                       int read)
          +
          +
          Set the connection and read time out values +

          +

          +
          Parameters:
          connect -
          read -
          +
          +
          +
          + +

          +compareMovies

          +
          +public static boolean compareMovies(MovieDb moviedb,
+                                    String title,
+                                    String year)
          +
          +
          Compare the MovieDB object with a title & year +

          +

          +
          Parameters:
          moviedb - The moviedb object to compare too
          title - The title of the movie to compare
          year - The year of the movie to compare exact match +
          Returns:
          True if there is a match, False otherwise.
          +
          +
          +
          + +

          +compareMovies

          +
          +public static boolean compareMovies(MovieDb moviedb,
+                                    String title,
+                                    String year,
+                                    int maxDistance)
          +
          +
          Compare the MovieDB object with a title & year +

          +

          +
          Parameters:
          moviedb - The moviedb object to compare too
          title - The title of the movie to compare
          year - The year of the movie to compare
          maxDistance - The Levenshtein Distance between the two titles. 0 = exact match +
          Returns:
          True if there is a match, False otherwise.
          +
          +
          +
          + +

          +getConfiguration

          +
          +public TmdbConfiguration getConfiguration()
          +
          +
          Get the configuration information +

          +

          +
          +
          +
          +
          + +

          +createImageUrl

          +
          +public URL createImageUrl(String imagePath,
+                          String requiredSize)
+                   throws MovieDbException
          +
          +
          Generate the full image URL from the size and image path +

          +

          +
          Parameters:
          imagePath -
          requiredSize - +
          Throws: +
          MovieDbException
          +
          +
          +
          + +

          +getAuthorisationToken

          +
          +public TokenAuthorisation getAuthorisationToken()
+                                         throws MovieDbException
          +
          +
          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. - As soon as a valid session id has been created the token will be destroyed.
          -
          Throws:
          -
          MovieDbException
          -
          • -
        - - - -
          -
        • -

          getSessionToken

          -
          public TokenSession getSessionToken(TokenAuthorisation token)
-                             throws MovieDbException
          -
          This method is used to generate a session id for user based authentication. + As soon as a valid session id has been created the token will be destroyed. +

          +

          - A session id is required in order to use any of the write methods.
          -
          Parameters:
          token -
          -
          Throws:
          -
          MovieDbException
          -
          • -
        - - - -
          -
        • -

          getGuestSessionToken

          -
          public TokenSession getGuestSessionToken()
-                                  throws MovieDbException
          -
          This method is used to generate a guest session id. +
          Throws: +
          MovieDbException +
          + +
          + +

          +getSessionToken

          +
          +public TokenSession getSessionToken(TokenAuthorisation token)
+                             throws MovieDbException
          +
          +
          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. +

          +

          +
          Parameters:
          token - +
          Throws: +
          MovieDbException
          +
          +
          +
          + +

          +getGuestSessionToken

          +
          +public TokenSession getGuestSessionToken()
+                                  throws MovieDbException
          +
          +
          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. @@ -683,202 +810,228 @@ extends Throws: -
          MovieDbException
          -
          • -
        - - - -
          -
        • -

          getMovieInfo

          -
          public MovieDb getMovieInfo(int movieId,
-                   String language)
-                     throws MovieDbException
          -
          This method is used to retrieve all of the basic movie information. + If a guest session is not used for the first time within 24 hours, it will be automatically discarded. +

          +

          - It will return the single highest rated poster and backdrop.
          -
          Parameters:
          movieId -
          language -
          -
          Throws:
          -
          MovieDbException
          -
          • -
        - - - -
          -
        • -

          getMovieInfoImdb

          -
          public MovieDb getMovieInfoImdb(String imdbId,
-                       String language)
-                         throws MovieDbException
          -
          This method is used to retrieve all of the basic movie information. +
          Throws: +
          MovieDbException +
          + +
          - It will return the single highest rated poster and backdrop.
          -
          Parameters:
          imdbId -
          language -
          -
          Throws:
          -
          MovieDbException
          -
          • -
        - - - -
          -
        • -

          getMovieAlternativeTitles

          -
          public List<AlternativeTitle> getMovieAlternativeTitles(int movieId,
-                                               String country)
-                                                 throws MovieDbException
          -
          This method is used to retrieve all of the alternative titles we have for a particular movie.
          -
          Parameters:
          movieId -
          country -
          -
          Throws:
          -
          MovieDbException
          -
          • -
        - - - -
          -
        • -

          getMovieCasts

          -
          public List<Person> getMovieCasts(int movieId)
-                           throws MovieDbException
          -
          Get the cast information for a specific movie id. +

          +getMovieInfo

          +
          +public MovieDb getMovieInfo(int movieId,
+                            String language)
+                     throws MovieDbException
          +
          +
          This method is used to retrieve all of the basic movie information. - TODO: Add a function to enrich the data with the people methods
          -
          Parameters:
          movieId -
          -
          Throws:
          -
          MovieDbException
          -
          • -
        - - - -
          -
        • -

          getMovieImages

          -
          public List<Artwork> getMovieImages(int movieId,
-                           String language)
-                             throws MovieDbException
          -
          This method should be used when you’re wanting to retrieve all of the images for a particular movie.
          -
          Parameters:
          movieId -
          language -
          -
          Throws:
          -
          MovieDbException
          -
          • -
        - - - -
          -
        • -

          getMovieKeywords

          -
          public List<Keyword> getMovieKeywords(int movieId)
-                               throws MovieDbException
          -
          This method is used to retrieve all of the keywords that have been added to a particular movie. + It will return the single highest rated poster and backdrop. +

          +

          +
          Parameters:
          movieId -
          language - +
          Throws: +
          MovieDbException
          +
          + +
          - Currently, only English keywords exist.
          -
          Parameters:
          movieId -
          -
          Throws:
          -
          MovieDbException
          -
          • -
        - - - -
          -
        • -

          getMovieReleaseInfo

          -
          public List<ReleaseInfo> getMovieReleaseInfo(int movieId,
-                                    String language)
-                                      throws MovieDbException
          -
          This method is used to retrieve all of the release and certification data we have for a specific movie.
          -
          Parameters:
          movieId -
          language -
          -
          Throws:
          -
          MovieDbException
          -
          • -
        - - - -
          -
        • -

          getMovieTrailers

          -
          public List<Trailer> getMovieTrailers(int movieId,
-                             String language)
-                               throws MovieDbException
          -
          This method is used to retrieve all of the trailers for a particular movie. +

          +getMovieInfoImdb

          +
          +public MovieDb getMovieInfoImdb(String imdbId,
+                                String language)
+                         throws MovieDbException
          +
          +
          This method is used to retrieve all of the basic movie information. - Supported sites are YouTube and QuickTime.
          -
          Parameters:
          movieId -
          language -
          -
          Throws:
          -
          MovieDbException
          -
          • -
        - - - -
          -
        • -

          getMovieTranslations

          -
          public List<Translation> getMovieTranslations(int movieId)
-                                       throws MovieDbException
          -
          This method is used to retrieve a list of the available translations for a specific movie.
          -
          Parameters:
          movieId -
          -
          Throws:
          -
          MovieDbException
          -
          • -
        - - - -
          -
        • -

          getSimilarMovies

          -
          public List<MovieDb> getSimilarMovies(int movieId,
-                             String language,
-                             int page)
-                               throws MovieDbException
          -
          The similar movies method will let you retrieve the similar movies for a particular movie. + It will return the single highest rated poster and backdrop. +

          +

          +
          Parameters:
          imdbId -
          language - +
          Throws: +
          MovieDbException
          +
          + +
          + +

          +getMovieAlternativeTitles

          +
          +public List<AlternativeTitle> getMovieAlternativeTitles(int movieId,
+                                                        String country)
+                                                 throws MovieDbException
          +
          +
          This method is used to retrieve all of the alternative titles we have for a particular movie. +

          +

          +
          Parameters:
          movieId -
          country - +
          Throws: +
          MovieDbException
          +
          +
          +
          + +

          +getMovieCasts

          +
          +public List<Person> getMovieCasts(int movieId)
+                           throws MovieDbException
          +
          +
          Get the cast information for a specific movie id. + + TODO: Add a function to enrich the data with the people methods +

          +

          +
          Parameters:
          movieId - +
          Throws: +
          MovieDbException
          +
          +
          +
          + +

          +getMovieImages

          +
          +public List<Artwork> getMovieImages(int movieId,
+                                    String language)
+                             throws MovieDbException
          +
          +
          This method should be used when you’re wanting to retrieve all of the images for a particular movie. +

          +

          +
          Parameters:
          movieId -
          language - +
          Throws: +
          MovieDbException
          +
          +
          +
          + +

          +getMovieKeywords

          +
          +public List<Keyword> getMovieKeywords(int movieId)
+                               throws MovieDbException
          +
          +
          This method is used to retrieve all of the keywords that have been added to a particular movie. + + Currently, only English keywords exist. +

          +

          +
          Parameters:
          movieId - +
          Throws: +
          MovieDbException
          +
          +
          +
          + +

          +getMovieReleaseInfo

          +
          +public List<ReleaseInfo> getMovieReleaseInfo(int movieId,
+                                             String language)
+                                      throws MovieDbException
          +
          +
          This method is used to retrieve all of the release and certification data we have for a specific movie. +

          +

          +
          Parameters:
          movieId -
          language - +
          Throws: +
          MovieDbException
          +
          +
          +
          + +

          +getMovieTrailers

          +
          +public List<Trailer> getMovieTrailers(int movieId,
+                                      String language)
+                               throws MovieDbException
          +
          +
          This method is used to retrieve all of the trailers for a particular movie. + + Supported sites are YouTube and QuickTime. +

          +

          +
          Parameters:
          movieId -
          language - +
          Throws: +
          MovieDbException
          +
          +
          +
          + +

          +getMovieTranslations

          +
          +public List<Translation> getMovieTranslations(int movieId)
+                                       throws MovieDbException
          +
          +
          This method is used to retrieve a list of the available translations for a specific movie. +

          +

          +
          Parameters:
          movieId - +
          Throws: +
          MovieDbException
          +
          +
          +
          + +

          +getSimilarMovies

          +
          +public List<MovieDb> getSimilarMovies(int movieId,
+                                      String language,
+                                      int page)
+                               throws MovieDbException
          +
          +
          The similar movies method will let you retrieve the similar movies for a particular movie. This data is created dynamically but with the help of users votes on TMDb. - The data is much better with movies that have more keywords
          -
          Parameters:
          movieId -
          language -
          page -
          -
          Throws:
          -
          MovieDbException
          -
          • -
        - - - - - - - - - - - - - - - -
          -
        • -

          getUpcoming

          -
          public List<MovieDb> getUpcoming(String language,
-                        int page)
-                          throws MovieDbException
          -
          Get the list of upcoming movies. + TODO: DOES NOT WORK AT THE MOMENT. This is due to the "value" item changing type in the ChangeItem +

          +

          +
          Parameters:
          movieId -
          startDate - the start date of the changes, optional
          endDate - the end date of the changes, optional +
          Throws: +
          MovieDbException
          +
          + +
          + +

          +getLatestMovie

          +
          +public MovieDb getLatestMovie()
+                       throws MovieDbException
          +
          +
          This method is used to retrieve the newest movie that was added to TMDb. +

          +

          + +
          Throws: +
          MovieDbException
          +
          +
          +
          + +

          +getUpcoming

          +
          +public List<MovieDb> getUpcoming(String language,
+                                 int page)
+                          throws MovieDbException
          +
          +
          Get the list of upcoming movies. This list refreshes every day. - The maximum number of items this list will include is 100.
          -
          Throws:
          -
          MovieDbException
          -
          • -
        - - - -
          -
        • -

          getNowPlayingMovies

          -
          public List<MovieDb> getNowPlayingMovies(String language,
-                                int page)
-                                  throws MovieDbException
          -
          This method is used to retrieve the movies currently in theatres. + The maximum number of items this list will include is 100. +

          +

          + +
          Throws: +
          MovieDbException
          +
          + +
          + +

          +getNowPlayingMovies

          +
          +public List<MovieDb> getNowPlayingMovies(String language,
+                                         int page)
+                                  throws MovieDbException
          +
          +
          This method is used to retrieve the movies currently in theatres. This is a curated list that will normally contain 100 movies. The default response will return 20 movies. - TODO: Implement more than 20 movies
          -
          Parameters:
          language -
          page -
          -
          Throws:
          -
          MovieDbException
          -
          • -
        - - - -
          -
        • -

          getPopularMovieList

          -
          public List<MovieDb> getPopularMovieList(String language,
-                                int page)
-                                  throws MovieDbException
          -
          This method is used to retrieve the daily movie popularity list. + TODO: Implement more than 20 movies +

          +

          +
          Parameters:
          language -
          page - +
          Throws: +
          MovieDbException
          +
          + +
          + +

          +getPopularMovieList

          +
          +public List<MovieDb> getPopularMovieList(String language,
+                                         int page)
+                                  throws MovieDbException
          +
          +
          This method is used to retrieve the daily movie popularity list. This list is updated daily. The default response will return 20 movies. - TODO: Implement more than 20 movies
          -
          Parameters:
          language -
          page -
          -
          Throws:
          -
          MovieDbException
          -
          • -
        - - - -
          -
        • -

          getTopRatedMovies

          -
          public List<MovieDb> getTopRatedMovies(String language,
-                              int page)
-                                throws MovieDbException
          -
          This method is used to retrieve the top rated movies that have over 10 votes on TMDb. + TODO: Implement more than 20 movies +

          +

          +
          Parameters:
          language -
          page - +
          Throws: +
          MovieDbException
          +
          + +
          + +

          +getTopRatedMovies

          +
          +public List<MovieDb> getTopRatedMovies(String language,
+                                       int page)
+                                throws MovieDbException
          +
          +
          This method is used to retrieve the top rated movies that have over 10 votes on TMDb. The default response will return 20 movies. - TODO: Implement more than 20 movies
          -
          Parameters:
          language -
          page -
          -
          Throws:
          -
          MovieDbException
          -
          • -
        - - - -
          -
        • -

          postMovieRating

          -
          public boolean postMovieRating(String sessionId,
-                      String rating)
-                        throws MovieDbException
          -
          This method lets users rate a movie. + TODO: Implement more than 20 movies +

          +

          +
          Parameters:
          language -
          page - +
          Throws: +
          MovieDbException
          +
          + +
          - A valid session id is required.
          -
          Parameters:
          sessionId -
          rating -
          -
          Throws:
          -
          MovieDbException
          -
          • -
        - - - -
          -
        • -

          getCollectionInfo

          -
          public CollectionInfo getCollectionInfo(int collectionId,
-                               String language)
-                                 throws MovieDbException
          -
          This method is used to retrieve all of the basic information about a movie collection. +

          +postMovieRating

          +
          +public boolean postMovieRating(String sessionId,
+                               String rating)
+                        throws MovieDbException
          +
          +
          This method lets users rate a movie. - You can get the ID needed for this method by making a getMovieInfo request for the belongs_to_collection.
          -
          Parameters:
          collectionId -
          language -
          -
          Throws:
          -
          MovieDbException
          -
          • -
        - - - -
          -
        • -

          getCollectionImages

          -
          public List<Artwork> getCollectionImages(int collectionId,
-                                String language)
-                                  throws MovieDbException
          -
          Get all of the images for a particular collection by collection id.
          -
          Parameters:
          collectionId -
          language -
          -
          Throws:
          -
          MovieDbException
          -
          • -
        - - - -
          -
        • -

          getPersonInfo

          -
          public Person getPersonInfo(int personId)
-                     throws MovieDbException
          -
          This method is used to retrieve all of the basic person information. + A valid session id is required. +

          +

          +
          Parameters:
          sessionId -
          rating - +
          Throws: +
          MovieDbException
          +
          + +
          - It will return the single highest rated profile image.
          -
          Parameters:
          personId -
          -
          Throws:
          -
          MovieDbException
          -
          • -
        - - - -
          -
        • -

          getPersonCredits

          -
          public List<PersonCredit> getPersonCredits(int personId)
-                                    throws MovieDbException
          -
          This method is used to retrieve all of the cast & crew information for the person. +

          +getCollectionInfo

          +
          +public CollectionInfo getCollectionInfo(int collectionId,
+                                        String language)
+                                 throws MovieDbException
          +
          +
          This method is used to retrieve all of the basic information about a movie collection. - It will return the single highest rated poster for each movie record.
          -
          Parameters:
          personId -
          -
          Throws:
          -
          MovieDbException
          -
          • -
        - - - -
          -
        • -

          getPersonImages

          -
          public List<Artwork> getPersonImages(int personId)
-                              throws MovieDbException
          -
          This method is used to retrieve all of the profile images for a person.
          -
          Parameters:
          personId -
          -
          Throws:
          -
          MovieDbException
          -
          • -
        - - - -
          -
        • -

          getPersonChanges

          -
          public void getPersonChanges(int personId,
-                    String startDate,
-                    String endDate)
-                      throws MovieDbException
          -
          Get the changes for a specific person id. + You can get the ID needed for this method by making a getMovieInfo request for the belongs_to_collection. +

          +

          +
          Parameters:
          collectionId -
          language - +
          Throws: +
          MovieDbException
          +
          + +
          + +

          +getCollectionImages

          +
          +public List<Artwork> getCollectionImages(int collectionId,
+                                         String language)
+                                  throws MovieDbException
          +
          +
          Get all of the images for a particular collection by collection id. +

          +

          +
          Parameters:
          collectionId -
          language - +
          Throws: +
          MovieDbException
          +
          +
          +
          + +

          +getPersonInfo

          +
          +public Person getPersonInfo(int personId)
+                     throws MovieDbException
          +
          +
          This method is used to retrieve all of the basic person information. + + It will return the single highest rated profile image. +

          +

          +
          Parameters:
          personId - +
          Throws: +
          MovieDbException
          +
          +
          +
          + +

          +getPersonCredits

          +
          +public List<PersonCredit> getPersonCredits(int personId)
+                                    throws MovieDbException
          +
          +
          This method is used to retrieve all of the cast & crew information for the person. + + It will return the single highest rated poster for each movie record. +

          +

          +
          Parameters:
          personId - +
          Throws: +
          MovieDbException
          +
          +
          +
          + +

          +getPersonImages

          +
          +public List<Artwork> getPersonImages(int personId)
+                              throws MovieDbException
          +
          +
          This method is used to retrieve all of the profile images for a person. +

          +

          +
          Parameters:
          personId - +
          Throws: +
          MovieDbException
          +
          +
          +
          + +

          +getPersonChanges

          +
          +public void getPersonChanges(int personId,
+                             String startDate,
+                             String endDate)
+                      throws MovieDbException
          +
          +
          Get the changes for a specific person id. Changes are grouped by key, and ordered by date in descending order. @@ -1095,357 +1274,389 @@ public Parameters:
          personId -
          startDate -
          endDate -
          -
          Throws:
          -
          MovieDbException
          -
          • -
        - - - - - - - -
          -
        • -

          getCompanyInfo

          -
          public Company getCompanyInfo(int companyId)
-                       throws MovieDbException
          -
          This method is used to retrieve the basic information about a production company on TMDb.
          -
          Parameters:
          companyId -
          -
          Throws:
          -
          MovieDbException
          -
          • -
        - - - -
          -
        • -

          getCompanyMovies

          -
          public List<MovieDb> getCompanyMovies(int companyId,
-                             String language,
-                             int page)
-                               throws MovieDbException
          -
          This method is used to retrieve the movies associated with a company. + The language is present on fields that are translatable. +

          +

          +
          Parameters:
          personId -
          startDate -
          endDate - +
          Throws: +
          MovieDbException
          +
          + +
          + +

          +getPersonLatest

          +
          +public Person getPersonLatest()
+                       throws MovieDbException
          +
          +
          Get the latest person id. +

          +

          + +
          Throws: +
          MovieDbException
          +
          +
          +
          + +

          +getCompanyInfo

          +
          +public Company getCompanyInfo(int companyId)
+                       throws MovieDbException
          +
          +
          This method is used to retrieve the basic information about a production company on TMDb. +

          +

          +
          Parameters:
          companyId - +
          Throws: +
          MovieDbException
          +
          +
          +
          + +

          +getCompanyMovies

          +
          +public List<MovieDb> getCompanyMovies(int companyId,
+                                      String language,
+                                      int page)
+                               throws MovieDbException
          +
          +
          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. - TODO: Implement more than 20 movies
          -
          Parameters:
          companyId -
          language -
          page -
          -
          Throws:
          -
          MovieDbException
          -
          • -
        - - - -
          -
        • -

          getGenreList

          -
          public List<Genre> getGenreList(String language)
-                         throws MovieDbException
          -
          You can use this method to retrieve the list of genres used on TMDb. + TODO: Implement more than 20 movies +

          +

          +
          Parameters:
          companyId -
          language -
          page - +
          Throws: +
          MovieDbException
          +
          + +
          - These IDs will correspond to those found in movie calls.
          -
          Parameters:
          language -
          -
          Throws:
          -
          MovieDbException
          -
          • -
        - - - - - - - -
          -
        • -

          getGenreMovies

          -
          public List<MovieDb> getGenreMovies(int genreId,
-                           String language,
-                           int page,
-                           boolean includeAllMovies)
-                             throws MovieDbException
          -
          Get a list of movies per genre. +

          +getGenreList

          +
          +public List<Genre> getGenreList(String language)
+                         throws MovieDbException
          +
          +
          You can use this method to retrieve the list of genres used on TMDb. + + These IDs will correspond to those found in movie calls. +

          +

          +
          Parameters:
          language - +
          Throws: +
          MovieDbException
          +
          +
          +
          + +

          +getGenreMovies

          +
          +@Deprecated
+public List<MovieDb> getGenreMovies(int genreId,
+                                               String language,
+                                               int page)
+                             throws MovieDbException
          +
          +
          Deprecated.  +

          +

          + +
          Throws: +
          MovieDbException
          +
          +
          +
          + +

          +getGenreMovies

          +
          +public List<MovieDb> getGenreMovies(int genreId,
+                                    String language,
+                                    int page,
+                                    boolean includeAllMovies)
+                             throws MovieDbException
          +
          +
          Get a list of movies per genre. 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.
          -
          Parameters:
          genreId -
          language -
          page -
          -
          Throws:
          -
          MovieDbException
          -
          • -
        - - - -
          -
        • -

          searchMovie

          -
          public List<MovieDb> searchMovie(String movieName,
-                        int searchYear,
-                        String language,
-                        boolean includeAdult,
-                        int page)
-                          throws MovieDbException
          -
          Search Movies This is a good starting point to start finding movies on TMDb.
          -
          Parameters:
          movieName -
          searchYear - Limit the search to the provided year. Zero (0) will get all years
          language - The language to include. Can be blank/null.
          includeAdult - true or false to include adult titles in the search
          page - The page of results to return. 0 to get the default (first page)
          -
          Throws:
          -
          MovieDbException
          -
          • -
        - - - - - - - -
          -
        • -

          searchPeople

          -
          public List<Person> searchPeople(String personName,
-                        boolean includeAdult,
-                        int page)
-                          throws MovieDbException
          -
          This is a good starting point to start finding people on TMDb. + This prevents movies from 1 10/10 rating from being listed first and for the first 5 pages. +

          +

          +
          Parameters:
          genreId -
          language -
          page - +
          Throws: +
          MovieDbException
          +
          + +
          - The idea is to be a quick and light method so you can iterate through people quickly.
          -
          Parameters:
          personName -
          includeAdult -
          page -
          -
          Throws:
          -
          MovieDbException
          -
          • -
        - - - - - - - -
          -
        • -

          searchCompanies

          -
          public List<Company> searchCompanies(String companyName,
-                            int page)
-                              throws MovieDbException
          -
          Search Companies. +

          +searchMovie

          +
          +public List<MovieDb> searchMovie(String movieName,
+                                 int searchYear,
+                                 String language,
+                                 boolean includeAdult,
+                                 int page)
+                          throws MovieDbException
          +
          +
          Search Movies This is a good starting point to start finding movies on TMDb. +

          +

          +
          Parameters:
          movieName -
          searchYear - Limit the search to the provided year. Zero (0) will get all years
          language - The language to include. Can be blank/null.
          includeAdult - true or false to include adult titles in the search
          page - The page of results to return. 0 to get the default (first page) +
          Throws: +
          MovieDbException
          +
          +
          +
          + +

          +searchCollection

          +
          +public List<Collection> searchCollection(String query,
+                                         String language,
+                                         int page)
+                                  throws MovieDbException
          +
          +
          Search for collections by name. +

          +

          +
          Parameters:
          query -
          language -
          page - +
          Throws: +
          MovieDbException
          +
          +
          +
          + +

          +searchPeople

          +
          +public List<Person> searchPeople(String personName,
+                                 boolean includeAdult,
+                                 int page)
+                          throws MovieDbException
          +
          +
          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. +

          +

          +
          Parameters:
          personName -
          includeAdult -
          page - +
          Throws: +
          MovieDbException
          +
          +
          +
          + +

          +searchList

          +
          +public List<MovieList> searchList(String query,
+                                  String language,
+                                  int page)
+                           throws MovieDbException
          +
          +
          Search for lists by name and description. +

          +

          +
          Parameters:
          query -
          language -
          page - +
          Throws: +
          MovieDbException
          +
          +
          +
          + +

          +searchCompanies

          +
          +public List<Company> searchCompanies(String companyName,
+                                     int page)
+                              throws MovieDbException
          +
          +
          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. - http://help.themoviedb.org/kb/api/search-companies
          -
          Parameters:
          companyName -
          page -
          -
          Throws:
          -
          MovieDbException
          -
          • -
        - - - - - - - - - - - - - - - -
          -
        • -

          getKeywordMovies

          -
          public List<KeywordMovie> getKeywordMovies(String keywordId,
-                                  String language,
-                                  int page)
-                                    throws MovieDbException
          -
          Get the list of movies for a particular keyword by id.
          -
          Parameters:
          keywordId -
          language -
          page -
          -
          Returns:
          List of movies with the keyword
          -
          Throws:
          -
          MovieDbException
          -
          • -
        - - - - - - - - -
        • -
      -
      • -
    -
-
+ http://help.themoviedb.org/kb/api/search-companies +

+

+
Parameters:
companyName -
page - +
Throws: +
MovieDbException
+
+ +
+ +

+searchKeyword

+
+public List<Keyword> searchKeyword(String query,
+                                   int page)
+                            throws MovieDbException
+
+
Search for keywords by name +

+

+
Parameters:
query -
page - +
Throws: +
MovieDbException
+
+
+
+ +

+getList

+
+public MovieDbList getList(String listId)
+                    throws MovieDbException
+
+
Get a list by its ID +

+

+
Parameters:
listId - +
Returns:
The list and its items +
Throws: +
MovieDbException
+
+
+
+ +

+getKeyword

+
+public Keyword getKeyword(String keywordId)
+                   throws MovieDbException
+
+
Get the basic information for a specific keyword id. +

+

+
Parameters:
keywordId - +
Returns:
+
Throws: +
MovieDbException
+
+
+
+ +

+getKeywordMovies

+
+public List<KeywordMovie> getKeywordMovies(String keywordId,
+                                           String language,
+                                           int page)
+                                    throws MovieDbException
+
+
Get the list of movies for a particular keyword by id. +

+

+
Parameters:
keywordId -
language -
page - +
Returns:
List of movies with the keyword +
Throws: +
MovieDbException
+
+
+
+ +

+getMovieChangesList

+
+public void getMovieChangesList(int page,
+                                String startDate,
+                                String endDate)
+                         throws MovieDbException
+
+
+ +
Throws: +
MovieDbException
+
+
+
+ +

+getPersonChangesList

+
+public void getPersonChangesList(int page,
+                                 String startDate,
+                                 String endDate)
+                          throws MovieDbException
+
+
+ +
Throws: +
MovieDbException
+
+
+
+ + -
- - - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
- -
- - -
+ + + + + + + + + SUMMARY: NESTED | FIELD | CONSTR | METHOD + +DETAIL: FIELD | CONSTR | METHOD + + + -

Copyright © 2012-2013. All Rights Reserved.

- - + +
+Copyright © 2012-2013. All Rights Reserved. + + diff --git a/apidocs/com/omertron/themoviedbapi/class-use/MovieDbException.MovieDbExceptionType.html b/apidocs/com/omertron/themoviedbapi/class-use/MovieDbException.MovieDbExceptionType.html index 3b141e9ad..a3fe2f8a4 100644 --- a/apidocs/com/omertron/themoviedbapi/class-use/MovieDbException.MovieDbExceptionType.html +++ b/apidocs/com/omertron/themoviedbapi/class-use/MovieDbException.MovieDbExceptionType.html @@ -1,187 +1,221 @@ - - - - - -Uses of Class com.omertron.themoviedbapi.MovieDbException.MovieDbExceptionType (API-The MovieDB 3.5-SNAPSHOT API) - - - - - - +} + + + + + + +
+ + -
- - - - - -
-
- - - -
- -
- - -
+ + + + + + + + -
-

Uses of Class
com.omertron.themoviedbapi.MovieDbException.MovieDbExceptionType

-
-
- -
+ +
+
+

+Uses of Class
com.omertron.themoviedbapi.MovieDbException.MovieDbExceptionType

+
+ + + + + + + + + +
+Packages that use MovieDbException.MovieDbExceptionType
com.omertron.themoviedbapi  
+  +

+ + + + + +
+Uses of MovieDbException.MovieDbExceptionType in com.omertron.themoviedbapi
+  +

+ + + + + + + + + + + + + + + + + +
Methods in com.omertron.themoviedbapi that return MovieDbException.MovieDbExceptionType
+ MovieDbException.MovieDbExceptionTypeMovieDbException.getExceptionType() + +
+           
+static MovieDbException.MovieDbExceptionTypeMovieDbException.MovieDbExceptionType.valueOf(String name) + +
+          Returns the enum constant of this type with the specified name.
+static MovieDbException.MovieDbExceptionType[]MovieDbException.MovieDbExceptionType.values() + +
+          Returns an array containing the constants of this enum type, in +the order they are declared.
+  +

+ + + + + + + + + + + +
Constructors in com.omertron.themoviedbapi with parameters of type MovieDbException.MovieDbExceptionType
MovieDbException(MovieDbException.MovieDbExceptionType exceptionType, + String response) + +
+           
MovieDbException(MovieDbException.MovieDbExceptionType exceptionType, + String response, + Throwable cause) + +
+           
+  +

+

+ + -
- - - - - -
-
- - - -
- -
- - -
+ + + + + + + + -

Copyright © 2012-2013. All Rights Reserved.

- - + +
+Copyright © 2012-2013. All Rights Reserved. + + diff --git a/apidocs/com/omertron/themoviedbapi/class-use/MovieDbException.html b/apidocs/com/omertron/themoviedbapi/class-use/MovieDbException.html index f9ad492d1..4e4b6964e 100644 --- a/apidocs/com/omertron/themoviedbapi/class-use/MovieDbException.html +++ b/apidocs/com/omertron/themoviedbapi/class-use/MovieDbException.html @@ -1,509 +1,639 @@ - - - - - -Uses of Class com.omertron.themoviedbapi.MovieDbException (API-The MovieDB 3.5-SNAPSHOT API) - - - - - - +} + + + + + + +
+ + -
- - - - - -
-
- - - -
- -
- - -
+ + + + + + + + -
-

Uses of Class
com.omertron.themoviedbapi.MovieDbException

-
-
-