/*
 * WorldEdit, a Minecraft world manipulation toolkit
 * Copyright (C) sk89q <http://www.sk89q.com>
 * Copyright (C) WorldEdit team and contributors
 *
 * This program 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.
 *
 * 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 Lesser General Public License
 * for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 */

package me.patothebest.gamecore.command;

import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;

/**
 * Indicates a nested command. Mark methods with this annotation to tell
 * {@link CommandsManager} that a method is merely a shell for child
 * commands. Note that the body of a method marked with this annotation
 * will never called. Additionally, not all fields of {@link Command} apply
 * when it is used in conjunction with this annotation, although both
 * are still required.
 */
@Retention(RetentionPolicy.RUNTIME)
public @interface NestedCommand {

    /**
     * A list of classes with the child commands.
     *
     * @return a list of classes
     */
    Class<?>[] value() default {};

    /**
     * If set to true it will execute the body of the tagged method.
     *
     * @return true to execute the body of the annotated method
     */
    boolean executeBody() default false;

    /**
     * If set to true it will execute the body of the tagged method
     * when there is no nested command to be executed
     *
     * @return true to execute the body of the annotated method
     */
    boolean defaultToBody() default false;

}
