com.kttdevelopment.mal4j.query.MangaListUpdate 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
There is a newer version: 3.0.0
/*
 * Copyright (C) 2021 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.query;

import com.kttdevelopment.mal4j.manga.MangaListStatus;
import com.kttdevelopment.mal4j.manga.property.MangaStatus;
import com.kttdevelopment.mal4j.manga.property.RereadValue;

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

 * Represents a Manga list update.
 *
 * @see com.kttdevelopment.mal4j.MyAnimeList#updateMangaListing(long)
 * @see ListUpdate
 * @since 1.0.0
 * @version 1.0.0
 * @author Katsute
 */
public abstract class MangaListUpdate extends ListUpdate {

    protected Boolean rereading;
    protected Integer volumesRead, chaptersRead, timesReread;
    protected RereadValue rereadValue;

    /**
     * Creates a Manga list update. Applications do not use this constructor.
     *
     * @param id Manga id
     *
     * @see com.kttdevelopment.mal4j.MyAnimeList#updateMangaListing(long)
     * @since 1.0.0
     */
    public MangaListUpdate(final long id){
        super(id);
    }

    /**
     * Sets the rereading status.
     *
     * @param rereading rereading
     * @return list update
     *
     * @since 1.0.0
     */
    public final MangaListUpdate rereading(final boolean rereading){
        this.rereading = rereading;
        return this;
    }

    /**
     * Sets the volumes read.
     *
     * @param volumesRead volumes read
     * @return list update
     *
     * @since 1.0.0
     */
    public final MangaListUpdate volumesRead(final int volumesRead){
        this.volumesRead = volumesRead;
        return this;
    }

    /**
     * Sets the chapters read.
     *
     * @param chaptersRead chapters read
     * @return list update
     *
     * @since 1.0.0
     */
    public final MangaListUpdate chaptersRead(final int chaptersRead){
        this.chaptersRead = chaptersRead;
        return this;
    }

    /**
     * Sets the times reread.
     *
     * @param timesReread times reread
     * @return list update
     *
     * @since 1.0.0
     */
    public final MangaListUpdate timesReread(final int timesReread){
        this.timesReread = timesReread;
        return this;
    }

    /**
     * Sets the reread value.
     *
     * @param rereadValue reread value
     * @return list update
     *
     * @see RereadValue
     * @since 1.0.0
     */
    public final MangaListUpdate rereadValue(final RereadValue rereadValue){
        this.rereadValue = rereadValue;
        return this;
    }

}