Class FileConfigurationOptions
- Direct Known Subclasses:
YamlConfigurationOptions
FileConfiguration
.-
Constructor Summary
ModifierConstructorDescriptionprotected
FileConfigurationOptions
(MemoryConfiguration configuration) -
Method Summary
Modifier and TypeMethodDescriptionReturns theConfiguration
that this object is responsible for.boolean
Checks if theConfiguration
should copy values from its defaultConfiguration
directly.copyDefaults
(boolean value) Sets if theConfiguration
should copy values from its defaultConfiguration
directly.boolean
Gets whether or not the header should be copied from a default source.copyHeader
(boolean value) Sets whether or not the header should be copied from a default source.header()
Gets the header that will be applied to the top of the saved output.Sets the header that will be applied to the top of the saved output.
-
Constructor Details
-
FileConfigurationOptions
-
-
Method Details
-
configuration
Returns theConfiguration
that this object is responsible for.- Overrides:
configuration
in classMemoryConfigurationOptions
- Returns:
- Parent configuration
-
copyDefaults
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(String)
will always return the same value asConfigurationSection.isSet(String)
. The default value is false.- Overrides:
copyDefaults
in classMemoryConfigurationOptions
- Parameters:
value
- Whether or not defaults are directly copied- Returns:
- This object, for chaining
-
header
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.null
is a valid value which will indicate that no header] is to be applied. The default value isnull
.- Returns:
- Header
-
header
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.null
is a valid value which will indicate that no header is to be applied.- Parameters:
value
- New header- Returns:
- This object, for chaining
-
copyHeader
Gets whether or not the header should be copied from a default source.If this is true, if a default
FileConfiguration
is passed toMemoryConfiguration.setDefaults(Configuration)
then upon saving it will use the header from that config, instead of the one provided here.If no default is set on the configuration, or the default is not of type FileConfiguration, or that config has no header (
header()
returns null) then the header specified in this configuration will be used.Defaults to true.
- Returns:
- Whether or not to copy the header
-
copyHeader
Sets whether or not the header should be copied from a default source.If this is true, if a default
FileConfiguration
is passed toMemoryConfiguration.setDefaults(Configuration)
then upon saving it will use the header from that config, instead of the one provided here.If no default is set on the configuration, or the default is not of type FileConfiguration, or that config has no header (
header()
returns null) then the header specified in this configuration will be used.Defaults to true.
- Parameters:
value
- Whether or not to copy the header- Returns:
- This object, for chaining
-
copyDefaults
public boolean copyDefaults()Checks 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(String)
will always return the same value asConfigurationSection.isSet(String)
. The default value is false.- Returns:
- Whether or not defaults are directly copied
-