Module ultimategdbot.api

Package com.github.alex1304.ultimategdbot.api.command

Class CommandDocumentationEntry

java.lang.Object

com.github.alex1304.ultimategdbot.api.command.CommandDocumentationEntry

public final class CommandDocumentationEntry
extends Object

Represents a documentation entry. An entry is a subsection of the documentation of the command. An entry shows one possible syntax for the command, a description of what this part of the command does, and the different flags that can be used.

Constructor Summary

Constructors

Constructor	Description
CommandDocumentationEntry(Translator translator, String syntax, String description, Map<String,FlagInformation> flagInfo)

Method Summary

Modifier and Type	Method	Description
String	getDescription()	Gets the description of what the command does, according to the usage represented by this entry.
Map<String,FlagInformation>	getFlagInfo()	Gets information on the flags that can be used with this part of the command.
String	getSyntax()	Gets the syntax of the command relevant for this entry.

Methods inherited from class java.lang.Object

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

Constructor Detail

CommandDocumentationEntry

public CommandDocumentationEntry(Translator translator,
                                 String syntax,
                                 String description,
                                 Map<String,FlagInformation> flagInfo)

Method Detail

getSyntax

public String getSyntax()

Gets the syntax of the command relevant for this entry.

Returns:

the syntax

getDescription

public String getDescription()

Gets the description of what the command does, according to the usage represented by this entry.

Returns:

the description

getFlagInfo

public Map<String,FlagInformation> getFlagInfo()

Gets information on the flags that can be used with this part of the command.

Returns:

the information on available flags