/*
 * This file is part of Araknemu.
 *
 * Araknemu is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * Araknemu 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 Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with Araknemu.  If not, see <https://www.gnu.org/licenses/>.
 *
 * Copyright (c) 2017-2021 Vincent Quatrevieux
 */

package fr.quatrevieux.araknemu.game.admin.help;

import fr.quatrevieux.araknemu.game.admin.formatter.OutputBuilder;

/**
 * Render the help page for a command
 */
public interface HelpRenderer {
    /**
     * Build the help output
     */
    public void build(OutputBuilder output, CommandHelp help);

    /**
     * Render the help page
     */
    public default String render(CommandHelp help) {
        final OutputBuilder builder = new OutputBuilder();

        build(builder, help);

        return builder.toString();
    }
}