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

Interface Episode

  • All Known Implementing Classes:
    EpisodeDTO
    public interface Episode
    Interface representing an Episode data transfer object.


    The methods of this class provide easy access to all episode 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

      • getAbsoluteNumber

        @Nullable
Long getAbsoluteNumber()
        Get the value of the {data.absoluteNumber} JSON property
        Returns:
        The absoluteNumber property from the received JSON

      • getAiredEpisodeNumber

        @Nullable
Long getAiredEpisodeNumber()
        Get the value of the {data.airedEpisodeNumber} JSON property
        Returns:
        The airedEpisodeNumber property from the received JSON

      • getAiredSeason

        @Nullable
Long getAiredSeason()
        Get the value of the {data.airedSeason} JSON property
        Returns:
        The airedSeason property from the received JSON

      • getAirsAfterSeason

        @Nullable
Long getAirsAfterSeason()
        Get the value of the {data.airsAfterSeason} JSON property
        Returns:
        The airsAfterSeason property from the received JSON

      • getAirsBeforeEpisode

        @Nullable
Long getAirsBeforeEpisode()
        Get the value of the {data.airsBeforeEpisode} JSON property
        Returns:
        The airsBeforeEpisode property from the received JSON

      • getAirsBeforeSeason

        @Nullable
Long getAirsBeforeSeason()
        Get the value of the {data.airsBeforeSeason} JSON property
        Returns:
        The airsBeforeSeason property from the received JSON

      • getDirector

        @Deprecated(since="0.0.1",
            forRemoval=true)
@Nullable
String getDirector()
        Deprecated, for removal: This API element is subject to removal in a future version.
        Will be removed in future API release. Use getDirectors() instead.
        Get the value of the {data.director} JSON property
        Returns:
        The director property from the received JSON

      • getDirectors

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

      • getDvdChapter

        @Nullable
Long getDvdChapter()
        Get the value of the {data.dvdChapter} JSON property
        Returns:
        The dvdChapter property from the received JSON

      • getDvdDiscid

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

      • getDvdEpisodeNumber

        @Nullable
Long getDvdEpisodeNumber()
        Get the value of the {data.dvdEpisodeNumber} JSON property
        Returns:
        The dvdEpisodeNumber property from the received JSON

      • getDvdSeason

        @Nullable
Long getDvdSeason()
        Get the value of the {data.dvdSeason} JSON property
        Returns:
        The dvdSeason property from the received JSON

      • getEpisodeName

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

      • getFilename

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

      • getFirstAired

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

      • getGuestStars

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

      • getId

        @Nullable
Long getId()
        Get the value of the {data.id} JSON property
        Returns:
        The id property from the received JSON

      • getImdbId

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

      • getLastUpdated

        @Nullable
Long getLastUpdated()
        Get the value of the {data.lastUpdated} JSON property
        Returns:
        The lastUpdated property from the received JSON

      • getLastUpdatedBy

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

      • getOverview

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

      • getProductionCode

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

      • getSeriesId

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

      • getShowUrl

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

      • getSiteRating

        @Nullable
Double getSiteRating()
        Get the value of the {data.siteRating} JSON property
        Returns:
        The siteRating property from the received JSON

      • getSiteRatingCount

        @Nullable
Long getSiteRatingCount()
        Get the value of the {data.siteRatingCount} JSON property
        Returns:
        The siteRatingCount property from the received JSON

      • getThumbAdded

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

      • getThumbAuthor

        @Nullable
Long getThumbAuthor()
        Get the value of the {data.thumbAuthor} JSON property
        Returns:
        The thumbAuthor property from the received JSON

      • getThumbHeight

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

      • getThumbWidth

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

      • getWriters

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