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

Interface ImageQueryParameter

  • All Known Implementing Classes:
    ImageQueryParameterDTO
    public interface ImageQueryParameter
    Interface representing an Image query parameter data transfer object.


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

      • getKeyType

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

      • getLanguageId

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

      • getResolution

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

      • getSubKey

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