Module Mal4J

Package dev.katsute.mal4j

Class MyAnimeList

java.lang.Object

dev.katsute.mal4j.MyAnimeList

public abstract class MyAnimeList
extends Object

The MyAnimeList API interface, used to execute requests with the API from Java.

The MyAnimeList class can be created by authenticating with either:

• A client ID using withClientID(String)
• A token using withToken(String)
• OAuth2 using withOAuth2(MyAnimeListAuthenticator).

Since:

1.0.0

Version:

3.2.0

Author:

Katsute

Method Summary

Modifier and Type	Method	Description
abstract void	deleteAnimeListing(long id)	Removes an Anime listing.
abstract void	deleteMangaListing(long id)	Removes a Manga listing.
abstract void	enableExperimentalFeature(ExperimentalFeature feature)	Enables an experimental feature.
abstract AnimeSearchQuery	getAnime()	Returns an Anime search query.
abstract Anime	getAnime(long id)	Returns the full Anime details given an ID.
abstract Anime	getAnime(long id, String... fields)	Returns Anime details requested in the fields given an ID.
abstract AnimeCharacterQuery	getAnimeCharacters(long id)	Returns characters for an Anime.
abstract AnimeRankingQuery	getAnimeRanking(AnimeRankingType rankingType)	Returns an Anime ranking query.
abstract AnimeRankingQuery	getAnimeRanking(String rankingType)	Returns an Anime ranking query.
abstract AnimeSeasonQuery	getAnimeSeason(int year, Season season)	Returns an Anime season query.
abstract AnimeSuggestionQuery	getAnimeSuggestions()	Returns an Anime suggestions query.
abstract User	getAuthenticatedUser()	Returns the authenticated user.
abstract User	getAuthenticatedUser(String... fields)	Returns the authenticated user.
abstract Character	getCharacter(long id)	Returns a character.
abstract Character	getCharacter(long id, String... fields)	Returns a character.
abstract List<ForumCategory>	getForumBoards()	Returns the top level forum boards.
abstract ForumTopicDetail	getForumTopicDetail(long id)	Returns a forum topic.
abstract ForumTopicDetail	getForumTopicDetail(long id, Integer limit)	Returns a forum topic.
abstract ForumTopicDetail	getForumTopicDetail(long id, Integer limit, Integer offset)	Returns a forum topic.
abstract ForumTopicDetailPostQuery	getForumTopicDetailPostQuery(long id)	Returns a forum topic post query.
abstract ForumSearchQuery	getForumTopics()	Returns a forum topic search query.
abstract MangaSearchQuery	getManga()	Returns a Manga search query.
abstract Manga	getManga(long id)	Returns the full Manga details given an ID.
abstract Manga	getManga(long id, String... fields)	Returns Manga details requested in the fields given an ID.
abstract MangaRankingQuery	getMangaRanking(MangaRankingType rankingType)	Returns a Manga ranking query.
abstract MangaRankingQuery	getMangaRanking(String rankingType)	Returns a Manga ranking query.
abstract Person	getPerson(long id)	Returns a person.
abstract Person	getPerson(long id, String... fields)	Returns a person.
abstract User	getUser(String username)	Returns a user given their username.
abstract User	getUser(String username, String... fields)	Returns a user given their username.
abstract UserAnimeListQuery	getUserAnimeListing()	Returns a list query for your Anime listings.
abstract UserAnimeListQuery	getUserAnimeListing(String username)	Returns a list query for a user's Anime listings.
abstract UserMangaListQuery	getUserMangaListing()	Returns a list query for your Manga listings.
abstract UserMangaListQuery	getUserMangaListing(String username)	Returns a list query for a user's Manga listings.
abstract void	refreshToken()	Refreshes the OAuth token.
static void	setDebug(boolean debug)	Enable/disable connection debugging.
abstract AnimeListUpdate	updateAnimeListing(long id)	Returns an Anime listing updater.
abstract MangaListUpdate	updateMangaListing(long id)	Returns a Manga listing updater.
static MyAnimeList	withClientID(String client_id)	Creates an interface with a client ID.
static MyAnimeList	withOAuth2(MyAnimeListAuthenticator authenticator)	Creates an interface using an authenticator.
static MyAnimeList	withToken(String token)	Creates an interface with an OAuth token.

Methods inherited from class java.lang.Object

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

Method Details

setDebug

public static void setDebug(boolean debug)

Enable/disable connection debugging.

Parameters:

debug - debug

Since:

2.7.0

withClientID

public static MyAnimeList withClientID(String client_id)

Creates an interface with a client ID. Only public read operations are allowed, for write and user operations use withToken(String) or withOAuth2(MyAnimeListAuthenticator). Client secret is not required if your application has one.

Parameters:

client_id - client id

Returns:

MyAnimeList

Throws:

NullPointerException - if client ID is null

Since:

2.6.0

See Also:

• withToken(String)
• withOAuth2(MyAnimeListAuthenticator)

withToken

public static MyAnimeList withToken(String token)

Creates an interface with an OAuth token. Note that this method does not support refreshToken().

Parameters:

token - OAuth token, Ex: 'Bearer oauth2token'

Returns:

MyAnimeList

Throws:

NullPointerException - if token is null

InvalidTokenException - if token doesn't start with 'Bearer'

Since:

2.6.0

See Also:

• withClientID(String)
• withOAuth2(MyAnimeListAuthenticator)

withOAuth2

public static MyAnimeList withOAuth2(MyAnimeListAuthenticator authenticator)

Creates an interface using an authenticator.

Parameters:

authenticator - authenticator

Returns:

MyAnimeList

Throws:

NullPointerException - if authenticator is null

Since:

2.7.0

See Also:

• withClientID(String)
• withToken(String)
• refreshToken()
• MyAnimeListAuthenticator

refreshToken

public abstract void refreshToken()

Refreshes the OAuth token. Only works with withOAuth2(MyAnimeListAuthenticator).

Throws:

UnsupportedOperationException - if this wasn't created with an authenticator

Since:

2.6.0

enableExperimentalFeature

public abstract void enableExperimentalFeature(ExperimentalFeature feature)

Enables an experimental feature.

Parameters:

feature - feature to enable

Since:

2.3.0

See Also:

• ExperimentalFeature

getAnime

public abstract AnimeSearchQuery getAnime()

Returns an Anime search query.

Returns:

Anime search

Since:

1.0.0

See Also:

• AnimeSuggestionQuery
• LimitOffsetQuery.search()
• Anime

getAnime

public abstract Anime getAnime(long id)

Returns the full Anime details given an ID.

Parameters:

id - Anime id

Returns:

Anime

Since:

1.0.0

See Also:

• Anime
• getAnime(long)

getAnime

public abstract Anime getAnime(long id,
 String... fields)

Returns Anime details requested in the fields given an ID.

Parameters:

id - Anime id

fields - a string array of the fields that should be returned

Returns:

Anime

Since:

1.0.0

See Also:

• Anime
• getAnime()
• Fields.Anime
• Fields.anime

getAnimeCharacters

public abstract AnimeCharacterQuery getAnimeCharacters(long id)

Returns characters for an Anime.

Parameters:

id - Anime id

Returns:

Anime character query

Since:

3.1.0

See Also:

• AnimeCharacterQuery
• Character

getAnimeRanking

public abstract AnimeRankingQuery getAnimeRanking(AnimeRankingType rankingType)

Returns an Anime ranking query.

Parameters:

rankingType - ranking type

Returns:

ranked Anime

Throws:

NullPointerException - if ranking type is null

Since:

1.0.0

See Also:

• getAnimeRanking(String)
• AnimeRankingQuery
• LimitOffsetQuery.search()
• AnimeRanking
• AnimeRankingType

getAnimeRanking

public abstract AnimeRankingQuery getAnimeRanking(String rankingType)

Returns an Anime ranking query.
It is recommended to use getAnimeRanking(AnimeRankingType) rather than this method. This method should only be used if you are using a ranking type that is missing from AnimeRankingType.

Parameters:

rankingType - ranking type API field

Returns:

ranked Anime

Throws:

NullPointerException - if ranking type is null

Since:

2.9.0

See Also:

• getAnimeRanking(AnimeRankingType)
• AnimeRankingQuery
• LimitOffsetQuery.search()
• AnimeRanking

getAnimeSeason

public abstract AnimeSeasonQuery getAnimeSeason(int year,
 Season season)

Returns an Anime season query.

Parameters:

year - year

season - airing season

Returns:

seasonal Anime

Throws:

NullPointerException - if season is null

Since:

1.0.0

See Also:

• AnimeSeasonQuery
• LimitOffsetQuery.search()
• Anime
• Season

getAnimeSuggestions

public abstract AnimeSuggestionQuery getAnimeSuggestions()

Returns an Anime suggestions query.

Returns:

suggested Anime

Since:

1.0.0

See Also:

• AnimeSuggestionQuery
• LimitOffsetQuery.search()
• Anime

updateAnimeListing

public abstract AnimeListUpdate updateAnimeListing(long id)

Returns an Anime listing updater.

Parameters:

id - Anime id

Returns:

Anime list updater

Since:

1.0.0

See Also:

• AnimeListUpdate
• ListUpdate.update()
• deleteAnimeListing(long)
• getUserAnimeListing()
• getUserAnimeListing(String)

deleteAnimeListing

public abstract void deleteAnimeListing(long id)

Removes an Anime listing.

Parameters:

id - Anime id

Since:

1.0.0

See Also:

• updateAnimeListing(long)
• getUserAnimeListing()
• getUserAnimeListing(String)

getUserAnimeListing

public abstract UserAnimeListQuery getUserAnimeListing()

Returns a list query for your Anime listings.

Returns:

Anime listing

Since:

1.0.0

See Also:

• UserAnimeListQuery
• LimitOffsetQuery.search()
• updateAnimeListing(long)
• deleteAnimeListing(long)
• getUserAnimeListing(String)

getUserAnimeListing

public abstract UserAnimeListQuery getUserAnimeListing(String username)

Returns a list query for a user's Anime listings.

Parameters:

username - username

Returns:

Anime listing

Throws:

NullPointerException - if username is null

Since:

1.0.0

See Also:

• UserAnimeListQuery
• LimitOffsetQuery.search()
• updateAnimeListing(long)
• deleteAnimeListing(long)
• getUserAnimeListing()

getCharacter

public abstract Character getCharacter(long id)

Returns a character.

Parameters:

id - character id

Returns:

character

Since:

3.1.0

See Also:

• Character
• getCharacter(long, String...)

getCharacter

public abstract Character getCharacter(long id,
 String... fields)

Returns a character.

Parameters:

id - character id

fields - a string array of the fields that should be returned

Returns:

character

Since:

3.1.0

See Also:

• Character
• getCharacter(long)
• Fields.Character
• Fields.character

getPerson

public abstract Person getPerson(long id)

Returns a person.

Parameters:

id - person id

Returns:

person

Since:

3.2.0

See Also:

• Person
• getPerson(long, String...)

getPerson

public abstract Person getPerson(long id,
 String... fields)

Returns a person.

Parameters:

id - person id

fields - a string array of the fields that should be returned

Returns:

person

Since:

3.2.0

See Also:

• Person
• getPerson(long)

getForumBoards

public abstract List<ForumCategory> getForumBoards()

Returns the top level forum boards.

Returns:

forum boards

Since:

1.0.0

See Also:

• ForumCategory

getForumTopicDetail

public abstract ForumTopicDetail getForumTopicDetail(long id)

Returns a forum topic.

Parameters:

id - forum topic id

Returns:

forum topic

Since:

1.0.0

See Also:

• getForumTopicDetail(long, Integer)
• getForumTopicDetail(long, Integer, Integer)
• getForumTopicDetailPostQuery(long)

getForumTopicDetail

public abstract ForumTopicDetail getForumTopicDetail(long id,
 Integer limit)

Returns a forum topic.

Parameters:

id - forum topic id

limit - post limit

Returns:

forum topic

Since:

1.0.0

See Also:

• getForumTopicDetail(long)
• getForumTopicDetail(long, Integer, Integer)
• getForumTopicDetailPostQuery(long)

getForumTopicDetail

public abstract ForumTopicDetail getForumTopicDetail(long id,
 Integer limit,
 Integer offset)

Returns a forum topic.

Parameters:

id - forum topic id

limit - post limit

offset - post offset

Returns:

forum topic

Since:

1.0.0

See Also:

• getForumTopicDetail(long)
• getForumTopicDetail(long, Integer)
• getForumTopicDetailPostQuery(long)

getForumTopicDetailPostQuery

public abstract ForumTopicDetailPostQuery getForumTopicDetailPostQuery(long id)

Returns a forum topic post query.

Parameters:

id - forum topic id

Returns:

post search

Since:

2.0.0

See Also:

• getForumTopicDetail(long)
• getForumTopicDetail(long, Integer)
• getForumTopicDetail(long, Integer, Integer)
• ForumTopicDetailPostQuery

getForumTopics

public abstract ForumSearchQuery getForumTopics()

Returns a forum topic search query.

Returns:

forums

Since:

1.0.0

See Also:

• ForumSearchQuery
• LimitOffsetQuery.search()

getManga

public abstract MangaSearchQuery getManga()

Returns a Manga search query.

Returns:

Manga search

Since:

1.0.0

See Also:

• MangaSearchQuery
• LimitOffsetQuery.search()
• Manga

getManga

public abstract Manga getManga(long id)

Returns the full Manga details given an ID.

Parameters:

id - Manga id

Returns:

Manga

Since:

1.0.0

See Also:

• Manga
• getManga(long)

getManga

public abstract Manga getManga(long id,
 String... fields)

Returns Manga details requested in the fields given an ID.

Parameters:

id - Manga id

fields - a string array of the fields that should be returned

Returns:

Manga

Since:

1.0.0

See Also:

• Manga
• getManga()
• Fields.Manga
• Fields.manga

getMangaRanking

public abstract MangaRankingQuery getMangaRanking(MangaRankingType rankingType)

Returns a Manga ranking query.

Parameters:

rankingType - ranking type

Returns:

ranked Manga

Throws:

NullPointerException - if ranking type is null

Since:

1.0.0

See Also:

• getMangaRanking(String)
• MangaRankingQuery
• LimitOffsetQuery.search()
• MangaRanking
• MangaRankingType

getMangaRanking

public abstract MangaRankingQuery getMangaRanking(String rankingType)

Returns a Manga ranking query.
It is recommended to use getMangaRanking(MangaRankingType) rather than this method. This method should only be used if you are using a ranking type that is missing from MangaRankingType.

Parameters:

rankingType - ranking type API field

Returns:

ranked Manga

Throws:

NullPointerException - if ranking type is null

Since:

2.9.0

See Also:

• getMangaRanking(MangaRankingType)
• MangaRankingQuery
• LimitOffsetQuery.search()
• MangaRanking

updateMangaListing

public abstract MangaListUpdate updateMangaListing(long id)

Returns a Manga listing updater.

Parameters:

id - Manga id

Returns:

Manga list updater

Since:

1.0.0

See Also:

• MangaListUpdate
• ListUpdate.update()
• deleteMangaListing(long)
• getUserMangaListing()
• getUserMangaListing(String)

deleteMangaListing

public abstract void deleteMangaListing(long id)

Removes a Manga listing.

Parameters:

id - Manga id

Since:

1.0.0

See Also:

• updateMangaListing(long)
• getUserMangaListing()
• getUserMangaListing(String)

getUserMangaListing

public abstract UserMangaListQuery getUserMangaListing()

Returns a list query for your Manga listings.

Returns:

Manga listing

Since:

1.0.0

See Also:

• UserMangaListQuery
• LimitOffsetQuery.search()
• updateMangaListing(long)
• deleteMangaListing(long)
• getUserMangaListing(String)

getUserMangaListing

public abstract UserMangaListQuery getUserMangaListing(String username)

Returns a list query for a user's Manga listings.

Parameters:

username - username

Returns:

Manga listing

Throws:

NullPointerException - if username is null

Since:

1.0.0

See Also:

• UserMangaListQuery
• LimitOffsetQuery.search()
• updateMangaListing(long)
• deleteMangaListing(long)
• getUserMangaListing()

getAuthenticatedUser

public abstract User getAuthenticatedUser()

Returns the authenticated user.

Returns:

authenticated user

Since:

2.2.0

See Also:

• User
• getAuthenticatedUser(String...)

getAuthenticatedUser

public abstract User getAuthenticatedUser(String... fields)

Returns the authenticated user.

Parameters:

fields - a string array of the fields that should be returned

Returns:

authenticated user

Since:

2.2.0

See Also:

• User
• getAuthenticatedUser()
• Fields.User
• Fields.user

getUser

public abstract User getUser(String username)

Returns a user given their username.

Parameters:

username - username

Returns:

user

Throws:

NullPointerException - if username is null

Since:

1.0.0

See Also:

• User
• getUser(String, String...)

getUser

public abstract User getUser(String username,
 String... fields)

Returns a user given their username.

Parameters:

username - username

fields - a string array of the fields that should be returned

Returns:

user

Throws:

NullPointerException - if username is null

Since:

1.0.0

See Also:

• User
• getUser(String)
• Fields.User
• Fields.user