Package dev.reuss.tmdb.query

Record Class AppendToResponse<T extends AppendableResponse>

java.lang.Object
java.lang.Record
dev.reuss.tmdb.query.AppendToResponse<T>
Type Parameters:
T - appendable response type
Record Components:
values - appendable responses to request
All Implemented Interfaces:
Serializable
public record AppendToResponse<T extends AppendableResponse>(List<T extends AppendableResponse> values) extends Record implements Serializable
Models TMDB's append_to_response query parameter.

Use this value with endpoints that support appended responses. Values are serialized as a comma-separated list, duplicate append values are removed while preserving their first occurrence, and at most 20 unique values are allowed.


 AppendToResponse<MovieAppend> append =
         AppendToResponse.of(MovieAppend.CREDITS, MovieAppend.VIDEOS);
See Also:

  • Constructor Summary

    Constructors
    Constructor
    Description
    AppendToResponse(List<T> values)
    Creates an instance of a AppendToResponse record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    static <T extends AppendableResponse>
    AppendToResponse<T>
    of(T... values)
    Creates an append-to-response value from one or more appendable responses.
    String
    toString()
    Returns a string representation of this record class.
    List<T>
    values()
    Returns the value of the values record component.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • AppendToResponse

      public AppendToResponse(List<T> values)
      Creates an instance of a AppendToResponse record class.
      Parameters:
      values - the value for the values record component

  • Method Details

    • of

      @SafeVarargs public static <T extends AppendableResponse> AppendToResponse<T> of(T... values)
      Creates an append-to-response value from one or more appendable responses.
      Type Parameters:
      T - appendable response type
      Parameters:
      values - appendable responses to request
      Returns:
      append-to-response query value
      Throws:
      IllegalArgumentException - if values is null, empty, contains null, or contains more than 20 unique append values

    • toString

      public String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • values

      public List<T> values()
      Returns the value of the values record component.
      Returns:
      the value of the values record component