Package dev.reuss.tmdb.common.watchprovider

Interface WatchProvidersResponse<T>

Type Parameters:
T - watch provider region type
All Known Implementing Classes:
MovieWatchProviders, TvSeasonWatchProviders, TvSeriesWatchProviders
public interface WatchProvidersResponse<T>
Common contract for TMDB responses that contain watch provider availabilities grouped by region.

  • Method Summary

    Modifier and Type
    Method
    Description
    default boolean
    hasProviders()
    Returns whether the response contains at least one provider region.
    default boolean
    hasRegion(String region)
    Returns whether providers are available for the given region.
    default boolean
    isEmpty()
    Returns whether the response contains no provider regions.
    default Optional<T>
    region(Region region)
     
    default Optional<T>
    region(String region)
    Returns the provider availability for the given region.
    default int
    regionCount()
    Returns the number of provider regions.
    Map<String,T>
    results()
    Returns watch provider availabilities grouped by region code.

  • Method Details

    • results

      Map<String,T> results()
      Returns watch provider availabilities grouped by region code.
      Returns:
      immutable map of region code to watch provider availability

    • isEmpty

      default boolean isEmpty()
      Returns whether the response contains no provider regions.
      Returns:
      true if there are no provider regions

    • hasProviders

      default boolean hasProviders()
      Returns whether the response contains at least one provider region.
      Returns:
      true if provider regions are present

    • regionCount

      default int regionCount()
      Returns the number of provider regions.
      Returns:
      region count

    • hasRegion

      default boolean hasRegion(String region)
      Returns whether providers are available for the given region.
      Parameters:
      region - region code, for example DE
      Returns:
      true if the region exists

    • region

      default Optional<T> region(String region)
      Returns the provider availability for the given region.
      Parameters:
      region - region code, for example DE
      Returns:
      optional provider availability

    • region

      default Optional<T> region(Region region)