|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.bukkit.configuration.ConfigurationOptions org.bukkit.configuration.MemoryConfigurationOptions org.bukkit.configuration.file.FileConfigurationOptions
public class FileConfigurationOptions
Various settings for controlling the input and output of a FileConfiguration
Constructor Summary | |
---|---|
protected |
FileConfigurationOptions(MemoryConfiguration configuration)
|
Method Summary | |
---|---|
FileConfiguration |
configuration()
Returns the Configuration that this object is responsible for. |
FileConfigurationOptions |
copyDefaults(boolean value)
Sets if the Configuration should copy values from its default Configuration directly. |
boolean |
copyHeader()
Gets whether or not the header should be copied from a default source. |
FileConfigurationOptions |
copyHeader(boolean value)
Sets whether or not the header should be copied from a default source. |
String |
header()
Gets the header that will be applied to the top of the saved output. |
FileConfigurationOptions |
header(String value)
Sets the header that will be applied to the top of the saved output. |
FileConfigurationOptions |
pathSeparator(char value)
Sets the char that will be used to separate ConfigurationSection s
This value does not affect how the Configuration is stored, only in
how you access the data. |
Methods inherited from class org.bukkit.configuration.ConfigurationOptions |
---|
copyDefaults, pathSeparator |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
protected FileConfigurationOptions(MemoryConfiguration configuration)
Method Detail |
---|
public FileConfiguration configuration()
ConfigurationOptions
Configuration
that this object is responsible for.
configuration
in class MemoryConfigurationOptions
public FileConfigurationOptions copyDefaults(boolean value)
ConfigurationOptions
Configuration
should copy values from its default Configuration
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 as ConfigurationSection.isSet(java.lang.String)
.
The default value is false.
copyDefaults
in class MemoryConfigurationOptions
value
- Whether or not defaults are directly copied
public FileConfigurationOptions pathSeparator(char value)
ConfigurationOptions
ConfigurationSection
s
This value does not affect how the Configuration
is stored, only in
how you access the data. The default value is '.'.
pathSeparator
in class MemoryConfigurationOptions
value
- Path separator
public String header()
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 is null.
public FileConfigurationOptions header(String value)
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.
value
- New header
public boolean copyHeader()
FileConfiguration
is passed to
MemoryConfiguration.setDefaults(org.bukkit.configuration.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.
public FileConfigurationOptions copyHeader(boolean value)
FileConfiguration
is passed to
MemoryConfiguration.setDefaults(org.bukkit.configuration.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.
value
- Whether or not to copy the header
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |