/*
 * This file is part of the Illarion project.
 *
 * Copyright © 2014 - 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.client.loading;

import illarion.common.util.ProgressMonitor;

import javax.annotation.Nonnull;

/**
 * This interface defines a task that need to be loaded.
 *
 * @author Martin Karing <nitram@illarion.org>
 */
interface LoadingTask {
    /**
     * Perform the next step of the loading operation.
     */
    void load();

    /**
     * Check if the loading of this task is done.
     *
     * @return {@code true} if the loading is done
     */
    boolean isLoadingDone();

    /**
     * Get the progress monitor that reports the progress of this task.
     *
     * @return the progress monitor for this task
     */
    @Nonnull
    ProgressMonitor getProgressMonitor();
}