com.github.alex1304.ultimategdbot.api.command.CommandDocumentation Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ultimategdbot-api Show documentation

There is a newer version: 6.0.2

package com.github.alex1304.ultimategdbot.api.command;

import java.util.Collections;
import java.util.Map;
import java.util.Objects;
import java.util.TreeMap;

/**
 * Holds the documentation for a specific command.
 */
public class CommandDocumentation {

	private final String shortDescription;
	private final Map docEntries;
	private final boolean isHidden;

	public CommandDocumentation(String shortDescription, Map docEntries, boolean isHidden) {
		this.shortDescription = Objects.requireNonNull(shortDescription);
		this.docEntries = Collections.unmodifiableMap(new TreeMap<>(docEntries));
		this.isHidden = isHidden;
	}
	
	/**
	 * Gets the short description of the command.
	 * 
	 * @return the short description
	 */
	public String getShortDescription() {
		return shortDescription;
	}
	
	/**
	 * Gets all entries corresponding to subsections of the command documentation.
	 * 
	 * @return the documentation entries
	 */
	public Map getEntries() {
		return docEntries;
	}

	/**
	 * Gets whether the command should be hidden from the documentation front page.
	 * 
	 * @return true if hidden, false otherwise
	 */
	public boolean isHidden() {
		return isHidden;
	}
}