Package dev.cwhead.GravesX.module.util

Class ModuleInfo.CommandDef

java.lang.Object

dev.cwhead.GravesX.module.util.ModuleInfo.CommandDef

Enclosing class:

ModuleInfo

public static final class ModuleInfo.CommandDef
extends Object

Simple immutable description of a command from module.yml:

 commands:
   example:
     description: "Runs example command"
     usage: "/example [arg]"
     permission: "graves.example.command"
     aliases: ["ex"]
     executor: dev.cwhead.GravesX.modules.example.command.GxCommand
     tab-completer: dev.cwhead.GravesX.modules.example.command.GxTab
 

Constructor Summary

Constructors

Constructor	Description
CommandDef(String name, String description, String usage, String permission, List<String> aliases, String executor, String tabCompleter)

Method Summary

Modifier and Type	Method	Description
List<String>	aliases()	Aliases for this command (may be empty).
String	description()	Command description, or null if not provided.
String	executor()	Executor class name (if provided).
String	name()	Command name (as defined under commands:).
String	permission()	Required permission node, or null if not specified.
String	tabCompleter()	Tab completer class name (if provided).
String	usage()	Usage string, e.g.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

CommandDef

public CommandDef(String name,
 String description,
 String usage,
 String permission,
 List<String> aliases,
 String executor,
 String tabCompleter)

Method Details

name

public String name()

Command name (as defined under commands:).

description

public String description()

Command description, or null if not provided.

usage

public String usage()

Usage string, e.g. "/example [arg]" or null.

permission

public String permission()

Required permission node, or null if not specified.

aliases

public List<String> aliases()

Aliases for this command (may be empty).

executor

public String executor()

Executor class name (if provided).

tabCompleter

public String tabCompleter()

Tab completer class name (if provided).