Package com.amilesend.omdb.client

Class OMDb

java.lang.Object

com.amilesend.omdb.client.OMDb

public class OMDb
extends Object

The Open Movie Database client.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	API_URL
static final String	USER_AGENT

Constructor Summary

Constructors

Constructor	Description
OMDb(String apiKey)	Creates a new OMDb with the provided API key.
OMDb(String apiKey, String userAgent)	Creates a nwe OMDb with the provided API key and user agent.
OMDb(String apiKey, String userAgent, OmdbConnection connection)	Creates a new OMDb with the provided connection and API key.

Method Summary

Modifier and Type	Method	Description
Episode	getEpisode(@NonNull GetEpisodeBasedRequest request)	Gets a TV episode for a request by either its series title or IMDB identifier.
Movie	getMovie(@NonNull GetMovieBasedRequest request)	Gets a movie for a request by either its title or IMDB identifier.
Season	getSeason(@NonNull GetSeasonBasedRequest request)	Gets a TV season for a request by either its title or IMDB identifier.
Series	getSeries(@NonNull GetSeriesBasedRequest request)	Gets a TV series for a request by either its title or IMDB identifier.
SearchResponse	search(@NonNull SearchMovieRequest request)	Searches for movies.
SearchResponse	search(@NonNull SearchSeriesRequest request)	Searches for TV series.

Methods inherited from class java.lang.Object

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

Field Details

USER_AGENT

public static final String USER_AGENT

See Also:

• Constant Field Values

API_URL

public static final String API_URL

See Also:

• Constant Field Values

Constructor Details

OMDb

public OMDb(String apiKey)

Creates a new OMDb with the provided API key.

Parameters:

apiKey - the API key

OMDb

public OMDb(String apiKey,
 String userAgent)

Creates a nwe OMDb with the provided API key and user agent.

Parameters:

apiKey - the API key

userAgent - the user agent

OMDb

public OMDb(String apiKey,
 String userAgent,
 OmdbConnection connection)

Creates a new OMDb with the provided connection and API key.

Parameters:

apiKey - the API key

userAgent - the user agent

connection - the underlying connection

Method Details

getMovie

public Movie getMovie(@NonNull GetMovieBasedRequest request)

Gets a movie for a request by either its title or IMDB identifier.

Parameters:

request - the request

Returns:

the movie

See Also:

• Movie
• GetMovieByIdRequest
• GetMovieByTitleRequest

getSeries

public Series getSeries(@NonNull GetSeriesBasedRequest request)

Gets a TV series for a request by either its title or IMDB identifier.

Parameters:

request - the request

Returns:

the series

See Also:

• Series
• GetSeriesByIdRequest
• GetSeriesByTitleRequest

getSeason

public Season getSeason(@NonNull GetSeasonBasedRequest request)

Gets a TV season for a request by either its title or IMDB identifier.

Parameters:

request - the request

Returns:

the season

See Also:

• Season
• GetSeasonByIdRequest
• GetSeasonByTitleRequest

getEpisode

public Episode getEpisode(@NonNull GetEpisodeBasedRequest request)

Gets a TV episode for a request by either its series title or IMDB identifier.

Parameters:

request - the request

Returns:

the episode

See Also:

• Episode
• GetEpisodeByIdRequest
• GetEpisodeByTitleRequest

search

public SearchResponse search(@NonNull SearchMovieRequest request)

Searches for movies.

Parameters:

request - the request

Returns:

the response containing the list of movies

search

public SearchResponse search(@NonNull SearchSeriesRequest request)

Searches for TV series.

Parameters:

request - the request

Returns:

the response containing the list of TV series.