Package com.github.m0nk3y2k4.thetvdb.api.model.data

Interface SeriesSummary

  • All Known Implementing Classes:
    SeriesSummaryDTO
    public interface SeriesSummary
    Interface representing a Series summary data transfer object.


    The methods of this class provide easy access to all series summary related data which was returned by the remote service in JSON format. Please note that, as the remote service declares all of the properties to be optional, most of the methods are marked as Nullable. Methods returning collection-based values however will return an empty collection in case no corresponding data was received.


    The sole purpose of these DTO objects is to encapsulate the exact raw JSON data as received from the remote service in order to facilitate API integration by working with simple Java POJO's instead of nested JSON nodes. Although there will be no intense post-processing of the actual JSON values a type-casting may be applied to some of them to improve the usability and relieve the API user of this task.

    • Method Detail

      • getAiredEpisodes

        @Nullable
String getAiredEpisodes()
        Get the value of the {data.airedEpisodes} JSON property
        Returns:
        The airedEpisodes property from the received JSON

      • getAiredSeasons

        List<String> getAiredSeasons()
        Get all values of the {data.airedSeasons} JSON property in a list
        Returns:
        The airedSeasons property from the received JSON as list

      • getDvdEpisodes

        @Nullable
String getDvdEpisodes()
        Get the value of the {data.dvdEpisodes} JSON property
        Returns:
        The dvdEpisodes property from the received JSON

      • getDvdSeasons

        List<String> getDvdSeasons()
        Get all values of the {data.dvdSeasons} JSON property in a list
        Returns:
        The dvdSeasons property from the received JSON as list