Class FileConfigurationOptions
- Direct Known Subclasses:
YamlConfigurationOptions
FileConfiguration
-
Constructor Summary
ModifierConstructorDescriptionprotected
FileConfigurationOptions
(@NotNull MemoryConfiguration configuration) -
Method Summary
Modifier and TypeMethodDescriptionReturns theConfiguration
that this object is responsible for.copyDefaults
(boolean value) Sets if theConfiguration
should copy values from its defaultConfiguration
directly.boolean
Deprecated.copyHeader
(boolean value) Deprecated.CallparseComments(boolean)
instead.Gets the footer that will be applied to the bottom of the saved output.Gets the header that will be applied to the top of the saved output.header()
Deprecated.use getHeader() instead.Deprecated.use setHeader() insteadboolean
Gets whether or not comments should be loaded and saved.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.Methods inherited from class org.bukkit.configuration.ConfigurationOptions
copyDefaults, pathSeparator
-
Constructor Details
-
FileConfigurationOptions
-
-
Method Details
-
configuration
Description copied from class:ConfigurationOptions
Returns theConfiguration
that this object is responsible for.- Overrides:
configuration
in classMemoryConfigurationOptions
- 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 classMemoryConfigurationOptions
- 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 classMemoryConfigurationOptions
- Parameters:
value
- Path separator- Returns:
- This object, for chaining
-
getHeader
Gets 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.
- Returns:
- Unmodifiable header, every entry represents one line.
-
header
Deprecated.use getHeader() instead.- Returns:
- The string header.
-
setHeader
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.
- Parameters:
value
- New header, every entry represents one line.- Returns:
- This object, for chaining
-
header
@NotNull @Deprecated public @NotNull FileConfigurationOptions header(@Nullable @Nullable String value) Deprecated.use setHeader() instead- Parameters:
value
- The string header.- Returns:
- This object, for chaining.
-
parseComments
public boolean parseComments()Gets whether or not comments should be loaded and saved.Defaults to true.
- Returns:
- Whether or not comments are parsed.
-
parseComments
Sets whether or not comments should be loaded and saved.Defaults to true.
- Parameters:
value
- Whether or not comments are parsed.- Returns:
- This object, for chaining
-
copyHeader
Deprecated.CallparseComments()
instead.- Returns:
- Whether or not comments are parsed.
-
copyHeader
Deprecated.CallparseComments(boolean)
instead.- Parameters:
value
- Should comments be parsed.- Returns:
- This object, for chaining
-
parseComments()
instead.