Module Mal4J

Package dev.katsute.mal4j.query

Class UserAnimeListQuery

java.lang.Object

dev.katsute.mal4j.query.LimitOffsetQuery<UserAnimeListQuery,AnimeListStatus>

dev.katsute.mal4j.query.FieldQuery<UserAnimeListQuery,AnimeListStatus>

dev.katsute.mal4j.query.UserAnimeListQuery

All Implemented Interfaces:

NSFW<UserAnimeListQuery>

public abstract class UserAnimeListQuery
extends FieldQuery<UserAnimeListQuery,AnimeListStatus>
implements NSFW<UserAnimeListQuery>

Documentation: https://myanimelist.net/apiconfig/references/api/v2#operation/users_user_id_animelist_get
Represents a user Anime list query.

Since:

1.0.0

Version:

2.9.0

Author:

Katsute

See Also:

• MyAnimeList.getUserAnimeListing()
• MyAnimeList.getUserAnimeListing(String)
• FieldQuery

Constructor Summary

Constructors

Constructor	Description
UserAnimeListQuery(String username)	Creates a user Anime search query.

Method Summary

Modifier and Type	Method	Description
final UserAnimeListQuery	includeNSFW()	Sets query to also return NSFW results.
final UserAnimeListQuery	includeNSFW(boolean nsfw)	Sets if the query will return NSFW results.
final UserAnimeListQuery	sortBy(AnimeSort sort)	Sets the sorting option.
final UserAnimeListQuery	sortBy(String sort)	Sets the sorting option.
final UserAnimeListQuery	withStatus(AnimeStatus status)	Sets the status filter.
final UserAnimeListQuery	withStatus(String status)	Sets the status filter.

Methods inherited from class dev.katsute.mal4j.query.FieldQuery

invertFields, invertFields, withAllFields, withField, withFields, withFields, withNoFields

Methods inherited from class dev.katsute.mal4j.query.LimitOffsetQuery

search, searchAll, withLimit, withOffset

Methods inherited from class java.lang.Object

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

Constructor Details

UserAnimeListQuery

public UserAnimeListQuery(String username)

Creates a user Anime search query.
Do not use this constructor, use MyAnimeList.getUserAnimeListing() or MyAnimeList.getUserAnimeListing(String) instead.

Parameters:

username - username

Since:

1.0.0

See Also:

• MyAnimeList.getUserAnimeListing()
• MyAnimeList.getUserAnimeListing(String)

Method Details

sortBy

public final UserAnimeListQuery sortBy(AnimeSort sort)

Sets the sorting option.

Parameters:

sort - sort

Returns:

list query

Since:

1.0.0

See Also:

• sortBy(String)
• AnimeSort

sortBy

public final UserAnimeListQuery sortBy(String sort)

Sets the sorting option.
It is recommended to use sortBy(AnimeSort) instead of this method. This method should only be used if the sort is missing from AnimeSort.

Parameters:

sort - raw sort

Returns:

list query

Since:

2.9.0

See Also:

• sortBy(AnimeSort)

withStatus

public final UserAnimeListQuery withStatus(AnimeStatus status)

Sets the status filter.

Parameters:

status - status

Returns:

list query

Since:

1.0.0

See Also:

• withStatus(String)
• AnimeStatus

withStatus

public final UserAnimeListQuery withStatus(String status)

Sets the status filter.
It is recommended to use withStatus(AnimeStatus) rather than this method. This method should only be used if the status is missing from AnimeStatus.

Parameters:

status - raw status

Returns:

list query

Since:

2.9.0

See Also:

• withStatus(AnimeStatus)

includeNSFW

public final UserAnimeListQuery includeNSFW()

Description copied from interface: NSFW

Sets query to also return NSFW results.

Specified by:

includeNSFW in interface NSFW<UserAnimeListQuery>

Returns:

query

See Also:

• NSFW.includeNSFW(boolean)

includeNSFW

public final UserAnimeListQuery includeNSFW(boolean nsfw)

Description copied from interface: NSFW

Sets if the query will return NSFW results.

Specified by:

includeNSFW in interface NSFW<UserAnimeListQuery>

Parameters:

nsfw - nsfw

Returns:

query

See Also:

• NSFW.includeNSFW()