/*
 * This file is part of the Illarion project.
 *
 * Copyright © 2015 - Illarion e.V.
 *
 * Illarion is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * Illarion 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.
 */
package illarion.common.util;

import org.jetbrains.annotations.Contract;

import javax.annotation.Nonnull;

/**
 * This implementation of the table loader is used to load the music table.
 *
 * @author Martin Karing <nitram@illarion.org>
 */
public class TableLoaderMusic extends TableLoader {
    /**
     * The index in the table record of the song id.
     */
    private static final int TB_ID = 0;

    /**
     * The index in the table record of the song filename.
     */
    private static final int TB_NAME = 1;

    /**
     * Create a new music table loader that loads the music data from the default file.
     *
     * @param callback the callback sink that receives the data
     * @param <T> the type of the table loader used
     */
    public <T extends TableLoader> TableLoaderMusic(@Nonnull TableLoaderSink<T> callback) {
        super("Songs", callback);
    }

    /**
     * Get the ID of the song.
     * <p/>
     * Be aware that this ID is not unique. In case multiple tracks have the same ID one is chosen at random.
     *
     * @return the ID of the song
     */
    @Contract(pure = true)
    public int getSongId() {
        return getInt(TB_ID);
    }

    /**
     * The name of the file that contains the audio data of this song.
     *
     * @return the song file
     */
    @Nonnull
    @Contract(pure = true)
    public String getSongFile() {
        return getString(TB_NAME);
    }
}