dev.katsute.mal4j.anime.property.AnimeSort 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) 2024 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 dev.katsute.mal4j.anime.property;

import dev.katsute.mal4j.property.FieldEnum;

/**
 * Represents how to sort the Anime search query.
 *
 * @since 1.0.0
 * @version 2.9.0
 * @author Katsute
 */
public enum AnimeSort implements FieldEnum {

    ID          ("anime_id"),
    Title       ("anime_title"),
    Score       ("list_score"),
    UpdatedAt   ("list_updated_at"),
    StartDate   ("anime_start_date");

    private final String field;

    AnimeSort(final String field){
        this.field = field;
    }

    @Override
    public final String field(){
        return field;
    }

    /**
     * Returns the field name as an enum.
     *
     * @param string json field name
     *
     * @return enum
     *
     * @since 1.0.0
     */
    public static AnimeSort asEnum(final String string){
        if(string != null)
            for(final AnimeSort value : values())
                if(value.field.equalsIgnoreCase(string))
                    return value;
        return null;
    }

    @Override
    public final String toString(){
        return name();
    }

}