Package dev.reuss.tmdb.core.http

Class QueryParams

java.lang.Object
dev.reuss.tmdb.core.http.QueryParams
public final class QueryParams extends Object
Mutable builder for TMDB query parameters.

This class is used to collect request query parameters before creating a TmdbRequest. Parameters with null or blank values are ignored, which makes it convenient to add optional request settings such as language, region or page.

The insertion order is preserved while building the parameters. The map returned by toMap() is an immutable copy.

  • Method Details

    • create

      public static QueryParams create()
      Creates an empty query parameter builder.
      Returns:
      a new query parameter builder

    • add

      public QueryParams add(String name, String value)
      Adds a query parameter if the given value is not null or blank.
      Parameters:
      name - the query parameter name
      value - the query parameter value
      Returns:
      this builder
      Throws:
      IllegalArgumentException - if the parameter name is null, blank or empty

    • add

      public QueryParams add(String name, Object value)
      Adds a query parameter if the given value is not null.

      The value is converted using Object.toString().

      Parameters:
      name - the query parameter name
      value - the query parameter value
      Returns:
      this builder
      Throws:
      IllegalArgumentException - if the parameter name is null, blank or empty

    • toMap

      public Map<String,String> toMap()
      Returns the collected query parameters as an immutable map.
      Returns:
      an immutable copy of the collected query parameters