org.bukkit.plugin.PluginAwareness Maven / Gradle / Ivy

Go to download
package org.bukkit.plugin;

import org.bukkit.plugin.java.JavaPlugin;

import java.util.Set;

/**
 * Represents a concept that a plugin is aware of.
 * 
 * The internal representation may be singleton, or be a parameterized
 * instance, but must be immutable.
 */
public interface PluginAwareness {
  /**
   * Each entry here represents a particular plugin's awareness. These can
   * be checked by using {@link PluginDescriptionFile#getAwareness()}.{@link
   * Set#contains(Object) contains(flag)}.
   */
  enum Flags implements PluginAwareness {
    /**
     * This specifies that all (text) resources stored in a plugin's jar
     * use UTF-8 encoding.
     *
     * @see JavaPlugin#getTextResource(String)
     */
    UTF8,
  }
}