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

Interface Image

  • All Known Implementing Classes:
    ImageDTO
    public interface Image
    Interface representing an Image data transfer object.


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

      • getFileName

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

      • getId

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

      • getKeyType

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

      • getLanguageId

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

      • getRatingAverage

        @Nullable
Double getRatingAverage()
        Get the value of the {data.ratingsInfo.average} JSON property
        Returns:
        The average property from the received JSONs ratingsInfo-node

      • getRatingCount

        @Nullable
Integer getRatingCount()
        Get the value of the {data.ratingsInfo.count} JSON property
        Returns:
        The count property from the received JSON ratingsInfo-node

      • getResolution

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

      • getSubKey

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

      • getThumbnail

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