/*
 * 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.easynpc.docu;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;

/**
 * This entry is used to store a generic entry in the documentation. The
 * documentation framework uses this entries to fetch all needed informations in
 * order to display a proper GUI.
 *
 * @author Martin Karing <nitram@illarion.org>
 */
public interface DocuEntry {
    /**
     * Get the child with the index handed over here.
     *
     * @param index the index of the child requested
     * @return the requested child
     */
    @Nonnull
    DocuEntry getChild(int index);

    /**
     * The amount of child entries this documentation entry has.
     *
     * @return the amount of child entries.
     */
    int getChildCount();

    /**
     * Get the description of this documentation entry.
     *
     * @return the description of this documentation entry
     */
    String getDescription();

    /**
     * Get the example of this documentation entry.
     *
     * @return the example to this documentation entry
     */
    @Nullable
    String getExample();

    /**
     * Get the syntax of this entry.
     *
     * @return the syntax of this entry
     */
    @Nullable
    String getSyntax();

    /**
     * Get the title of this entry in the documentation.
     *
     * @return the title of this documentation entry
     */
    @Nullable
    String getTitle();
}