summaryrefslogtreecommitdiffstats
path: root/src/main/java/org/bukkit/plugin/java/annotation/Commands.java
blob: c730b59427c8a3fd02eafa32d76b9c885e6b624b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
package org.bukkit.plugin.java.annotation;

import java.lang.annotation.ElementType;
import java.lang.annotation.Target;

/**
 *  Part of the plugin annotations framework.
 *  <p>
 *  Represents a list of this plugin's registered commands.
 */

@Target(ElementType.TYPE)
public @interface Commands { // TODO: in java 8, make repeatable.

    public Cmd[] value();

    @Target({})
    public static @interface Cmd {

        /**
         * This command's name.
         */
        public String value();

        /**
         * This command's description.
         */

        public String desc() default "";

        /**
         * This command's aliases.
         */
        public String[] aliases() default {};

        /**
         * This command's permission node.
         */
        public String permission() default "";

        /**
         * This command's permission-check-fail message.
         */
        public String permissionMessage() default "";

        /**
         * This command's usage message.
         */
        public String usage() default "";
    }

}