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

Interface Actor

  • All Known Implementing Classes:
    ActorDTO
    public interface Actor
    Interface representing an Actor data transfer object.


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

      • getId

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

      • getImage

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

      • getImageAdded

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

      • getImageAuthor

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

      • getLastUpdated

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

      • getName

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

      • getRole

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

      • getSeriesId

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

      • getSortOrder

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