org.bukkit.craftbukkit.help.HelpTopicAmendment Maven / Gradle / Ivy

Go to download
package org.bukkit.craftbukkit.help;

/**
 * A HelpTopicAmendment represents the contents of a topic amendment from the help.yml
 */
public class HelpTopicAmendment {
  private final String topicName;
  private final String shortText;
  private final String fullText;
  private final String permission;

  public HelpTopicAmendment(String topicName, String shortText, String fullText, String permission) {
    this.fullText = fullText;
    this.shortText = shortText;
    this.topicName = topicName;
    this.permission = permission;
  }

  /**
   * Gets the amended full text
   *
   * @return the full text
   */
  public String getFullText() {
    return fullText;
  }

  /**
   * Gets the amended short text
   *
   * @return the short text
   */
  public String getShortText() {
    return shortText;
  }

  /**
   * Gets the name of the topic being amended
   *
   * @return the topic name
   */
  public String getTopicName() {
    return topicName;
  }

  /**
   * Gets the amended permission
   *
   * @return the permission
   */
  public String getPermission() {
    return permission;
  }
}