Class YamlConfigurationOptions
YamlConfiguration
-
Constructor Summary
ModifierConstructorDescriptionprotected
YamlConfigurationOptions
(@NotNull YamlConfiguration configuration) -
Method Summary
Modifier and TypeMethodDescriptionint
Gets the maximum code point limit, that being, the maximum length of the document in which the loader will readcodePointLimit
(int codePointLimit) Sets the maximum code point limit, that being, the maximum length of the document in which the loader will readReturns theConfiguration
that this object is responsible for.copyDefaults
(boolean value) Sets if theConfiguration
should copy values from its defaultConfiguration
directly.copyHeader
(boolean value) Deprecated.Deprecated.int
indent()
Gets how much spaces should be used to indent each line.indent
(int value) Sets how much spaces should be used to indent each line.parseComments
(boolean value) Sets whether or not comments should be loaded and saved.pathSeparator
(char value) Sets the char that will be used to separateConfigurationSection
sSets the footer that will be applied to the bottom of the saved output.Sets the header that will be applied to the top of the saved output.int
width()
Gets how long a line can be, before it gets split.width
(int value) Sets how long a line can be, before it gets split.Methods inherited from class org.bukkit.configuration.file.FileConfigurationOptions
copyHeader, getFooter, getHeader, header, parseComments
Methods inherited from class org.bukkit.configuration.ConfigurationOptions
copyDefaults, pathSeparator
-
Constructor Details
-
YamlConfigurationOptions
-
-
Method Details
-
configuration
Description copied from class:ConfigurationOptions
Returns theConfiguration
that this object is responsible for.- Overrides:
configuration
in classFileConfigurationOptions
- Returns:
- Parent configuration
-
copyDefaults
Description copied from class:ConfigurationOptions
Sets if theConfiguration
should copy values from its defaultConfiguration
directly.If this is true, all values in the default Configuration will be directly copied, making it impossible to distinguish between values that were set and values that are provided by default. As a result,
ConfigurationSection.contains(java.lang.String)
will always return the same value asConfigurationSection.isSet(java.lang.String)
. The default value is false.- Overrides:
copyDefaults
in classFileConfigurationOptions
- Parameters:
value
- Whether or not defaults are directly copied- Returns:
- This object, for chaining
-
pathSeparator
Description copied from class:ConfigurationOptions
Sets the char that will be used to separateConfigurationSection
sThis value does not affect how the
Configuration
is stored, only in how you access the data. The default value is '.'.- Overrides:
pathSeparator
in classFileConfigurationOptions
- Parameters:
value
- Path separator- Returns:
- This object, for chaining
-
setHeader
Description copied from class:FileConfigurationOptions
Sets the header that will be applied to the top of the saved output.This header will be commented out and applied directly at the top of the generated output of the
FileConfiguration
. It is not required to include a newline at the end of the header as it will automatically be applied, but you may include one if you wish for extra spacing.If no comments exist, an empty list will be returned. A null entry represents an empty line and an empty String represents an empty comment line.
- Overrides:
setHeader
in classFileConfigurationOptions
- Parameters:
value
- New header, every entry represents one line.- Returns:
- This object, for chaining
-
header
@NotNull @Deprecated public @NotNull YamlConfigurationOptions header(@Nullable @Nullable String value) Deprecated.- Overrides:
header
in classFileConfigurationOptions
- Parameters:
value
- The string header.- Returns:
- This object, for chaining.
-
parseComments
Description copied from class:FileConfigurationOptions
Sets whether or not comments should be loaded and saved.Defaults to true.
- Overrides:
parseComments
in classFileConfigurationOptions
- Parameters:
value
- Whether or not comments are parsed.- Returns:
- This object, for chaining
-
copyHeader
Deprecated.- Overrides:
copyHeader
in classFileConfigurationOptions
- Parameters:
value
- Should comments be parsed.- Returns:
- This object, for chaining
-
indent
public int indent()Gets how much spaces should be used to indent each line.The minimum value this may be is 2, and the maximum is 9.
- Returns:
- How much to indent by
-
indent
Sets how much spaces should be used to indent each line.The minimum value this may be is 2, and the maximum is 9.
- Parameters:
value
- New indent- Returns:
- This object, for chaining
-
width
public int width()Gets how long a line can be, before it gets split.- Returns:
- How the max line width
-
width
Sets how long a line can be, before it gets split.- Parameters:
value
- New width- Returns:
- This object, for chaining
-
codePointLimit
public int codePointLimit()Gets the maximum code point limit, that being, the maximum length of the document in which the loader will read- Returns:
- The current value
-
codePointLimit
Sets the maximum code point limit, that being, the maximum length of the document in which the loader will read- Parameters:
codePointLimit
- new codepoint limit- Returns:
- This object, for chaining
-