Package me.qscbm.inlayx.config

Class CommentConfiguration

java.lang.Object
org.bukkit.configuration.MemorySection
org.bukkit.configuration.MemoryConfiguration
org.bukkit.configuration.file.FileConfiguration
org.bukkit.configuration.file.YamlConfiguration
me.qscbm.inlayx.config.CommentConfiguration
All Implemented Interfaces:
org.bukkit.configuration.Configuration, org.bukkit.configuration.ConfigurationSection
public class CommentConfiguration extends org.bukkit.configuration.file.YamlConfiguration
保存时保留配置文件注释的Yaml实例 会以KV的形式存储 ”'__comment__ # 注释内容': comment"的格式存储

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected static final String
    COMMENT_BODY_PREFIX
     
    protected static final String
    COMMENT_INDEX_SEPARATOR
     
    protected static final String
    COMMENT_PREFIX_SYMBOL
     
    protected static final int
    COMMENT_SPLIT_WIDTH
     
    protected static final String
    COMMENT_SUFFIX_SYMBOL
     
    protected static final Pattern
    COUNT_SPACE_PATTERN
     
    protected static final Pattern
    FROM_PATTERN
     
    protected static final String
    FROM_REGEX
     
    protected static final Pattern
    LOADED_COMMENT_PATTERN
     
    protected static final Pattern
    TO_PATTERN
     
    protected static final String
    TO_REGEX
     

    Fields inherited from class org.bukkit.configuration.file.YamlConfiguration

    BLANK_CONFIG, COMMENT_PREFIX

    Fields inherited from class org.bukkit.configuration.MemoryConfiguration

    defaults, options

    Fields inherited from class org.bukkit.configuration.MemorySection

    map

  • Constructor Summary

    Constructors
    Constructor
    Description
    CommentConfiguration()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getComment(String key)
    获取指定 key 同级且位于其上方的注释.
    void
    insertComment(String key, String value)
    设置注释
    static boolean
    isCommentByKeys(String key)
     
    void
    loadFromString(String contents)
     
    @NonNull String
    saveToString()
     

    Methods inherited from class org.bukkit.configuration.file.YamlConfiguration

    loadConfiguration, loadConfiguration, options

    Methods inherited from class org.bukkit.configuration.file.FileConfiguration

    buildHeader, load, load, load, save, save

    Methods inherited from class org.bukkit.configuration.MemoryConfiguration

    addDefault, addDefaults, addDefaults, getDefaults, getParent, setDefaults

    Methods inherited from class org.bukkit.configuration.MemorySection

    contains, contains, createPath, createPath, createSection, createSection, get, get, getBoolean, getBoolean, getBooleanList, getByteList, getCharacterList, getColor, getColor, getComments, getConfigurationSection, getCurrentPath, getDefault, getDefaultSection, getDouble, getDouble, getDoubleList, getFloatList, getInlineComments, getInt, getInt, getIntegerList, getItemStack, getItemStack, getKeys, getList, getList, getLocation, getLocation, getLong, getLong, getLongList, getMapList, getName, getObject, getObject, getOfflinePlayer, getOfflinePlayer, getRoot, getSerializable, getSerializable, getShortList, getString, getString, getStringList, getValues, getVector, getVector, isBoolean, isColor, isConfigurationSection, isDouble, isInt, isItemStack, isList, isLocation, isLong, isOfflinePlayer, isPrimitiveWrapper, isSet, isString, isVector, mapChildrenKeys, mapChildrenValues, set, setComments, setInlineComments, toString

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface org.bukkit.configuration.ConfigurationSection

    contains, contains, createSection, createSection, get, get, getBoolean, getBoolean, getBooleanList, getByteList, getCharacterList, getColor, getColor, getComments, getComponent, getComponent, getConfigurationSection, getCurrentPath, getDefaultSection, getDouble, getDouble, getDoubleList, getFloatList, getInlineComments, getInt, getInt, getIntegerList, getItemStack, getItemStack, getKeys, getList, getList, getLocation, getLocation, getLong, getLong, getLongList, getMapList, getName, getObject, getObject, getOfflinePlayer, getOfflinePlayer, getRichMessage, getRichMessage, getRoot, getSerializable, getSerializable, getShortList, getString, getString, getStringList, getValues, getVector, getVector, isBoolean, isColor, isConfigurationSection, isDouble, isInt, isItemStack, isList, isLocation, isLong, isOfflinePlayer, isSet, isString, isVector, set, setComments, setComponent, setInlineComments, setRichMessage

  • Field Details

  • Constructor Details

    • CommentConfiguration

      public CommentConfiguration()

  • Method Details

    • loadFromString

      public void loadFromString(String contents) throws org.bukkit.configuration.InvalidConfigurationException
      Overrides:
      loadFromString in class org.bukkit.configuration.file.YamlConfiguration
      Throws:
      org.bukkit.configuration.InvalidConfigurationException

    • saveToString

      @NonNull public @NonNull String saveToString()
      Overrides:
      saveToString in class org.bukkit.configuration.file.YamlConfiguration

    • getComment

      public String getComment(String key)
      获取指定 key 同级且位于其上方的注释.

    • insertComment

      public void insertComment(String key, String value)
      设置注释

    • isCommentByKeys

      public static boolean isCommentByKeys(String key)