Package dev.reuss.tmdb.query

Class ChangesQuery

java.lang.Object

dev.reuss.tmdb.query.ChangesQuery

All Implemented Interfaces:

PagedQuery<ChangesQuery>, TmdbQuery, Serializable

public final class ChangesQuery
extends Object
implements PagedQuery<ChangesQuery>

Query parameters for TMDB change endpoints.

The start and end date filters are optional. If both are set, the start date must not be after the end date and the range must not exceed 14 days.

See Also:

• Serialized Form

Method Summary

Modifier and Type	Method	Description
static ChangesQuery	create()	Creates an empty changes query.
ChangesQuery	endDate(LocalDate endDate)	Sets the inclusive end date filter.
ChangesQuery	page(Integer page)	Sets the requested result page.
ChangesQuery	startDate(LocalDate startDate)	Sets the inclusive start date filter.
QueryParams	toQueryParams()	Converts this query to TMDB query parameters.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

public static ChangesQuery create()

Creates an empty changes query.

Returns:

changes query

endDate

public ChangesQuery endDate(LocalDate endDate)

Sets the inclusive end date filter.

Parameters:

endDate - inclusive end date, or null

Returns:

this query

Throws:

IllegalArgumentException - if the configured date range is invalid

page

public ChangesQuery page(Integer page)

Description copied from interface: PagedQuery

Sets the requested result page.

Specified by:

page in interface PagedQuery<ChangesQuery>

Parameters:

page - page number, starting at 1

Returns:

the query instance

startDate

public ChangesQuery startDate(LocalDate startDate)

Sets the inclusive start date filter.

Parameters:

startDate - inclusive start date, or null

Returns:

this query

Throws:

IllegalArgumentException - if the configured date range is invalid

toQueryParams

public QueryParams toQueryParams()

Converts this query to TMDB query parameters.

Specified by:

toQueryParams in interface TmdbQuery

Returns:

query parameters