com.kttdevelopment.mal4j.anime.AnimeListStatus Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of mal4j Show documentation
Java wrapper for the official MyAnimeList API
The newest version!
/*
 * Copyright (C) 2021-2022 Katsute 
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */

package com.kttdevelopment.mal4j.anime;

import com.kttdevelopment.mal4j.MyAnimeList;
import com.kttdevelopment.mal4j.anime.property.*;
import com.kttdevelopment.mal4j.property.Editable;
import com.kttdevelopment.mal4j.property.ListStatus;
import com.kttdevelopment.mal4j.query.AnimeListUpdate;

/**
 * Documentation: https://myanimelist.net/apiconfig/references/api/v2#operation/anime_anime_id_my_list_status_put 

 * Documentation: https://myanimelist.net/apiconfig/references/api/v2#operation/users_user_id_animelist_get 

 * Represents a user's Anime list status.
 *
 * @see Anime#getListStatus()
 * @see MyAnimeList#getUserAnimeListing()
 * @see MyAnimeList#getUserAnimeListing(String)
 * @see MyAnimeList#updateAnimeListing(long)
 * @see ListStatus
 * @since 1.0.0
 * @version 2.12.0
 * @author Katsute
 */
@SuppressWarnings("SpellCheckingInspection")
public abstract class AnimeListStatus implements ListStatus, AnimeRetrievable, Editable {

    // API methods

    /**
     * Returns the total amount of watched episodes.
     *
     * @return total watched episodes
     *
     * @since 1.0.0
     */
    public abstract Integer getWatchedEpisodes();

    /**
     * Returns if the user is rewatching.
     *
     * @return rewatching
     *
     * @since 1.0.0
     */
    public abstract Boolean isRewatching();

    /**
     * Returns the total times rewatched.
     *
     * @return times rewatched
     *
     * @since 1.0.0
     */
    public abstract Integer getTimesRewatched();

    /**
     * Returns the rewatch value.
     *
     * @return rewatch value
     *
     * @see #getRawRewatchValue()
     * @see RewatchValue
     * @since 1.0.0
     */
    public abstract RewatchValue getRewatchValue();

    /**
     * Returns the raw rewatch value.
     * 

     * It is recommended to use {@link #getRewatchValue()} and {@link RewatchValue#value()} rather than this method.
     * This method should only be used if the rewatch value is missing from {@link RewatchValue}.
     *
     * @return raw rewatch value
     *
     * @see #getRewatchValue()
     * @since 2.9.0
     */
    public abstract Integer getRawRewatchValue();

    // additional methods

    /**
     * Creates an Anime list update object. Used to change the Anime list status.
     *
     * @return list updater
     *
     * @see AnimeListUpdate
     * @since 1.0.0
     */
    @Override
    public abstract AnimeListUpdate edit();

}