com.kttdevelopment.mal4j.anime.property.AnimeRetrievable 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.anime.property;

import com.kttdevelopment.mal4j.anime.Anime;

/**
 * Indicates that an Anime can be retrieved from the object.
 *
 * @see Anime
 * @since 1.0.0
 * @version 1.0.0
 * @author Katsute
 */
public interface AnimeRetrievable {

    /**
     * Returns the Anime. Note that this calls the API each time, it's suggested that you save this to a variable to prevent constantly calling the API.
     *
     * @return Anime
     *
     * @see Anime
     * @since 1.0.0
     */
    Anime getAnime();

}