FileConfigurationOptions (Simple-YAML 1.8.4 API)

java.lang.Object
- org.simpleyaml.configuration.ConfigurationOptions
- - org.simpleyaml.configuration.MemoryConfigurationOptions
  - - org.simpleyaml.configuration.file.FileConfigurationOptions

Direct Known Subclasses:

YamlConfigurationOptions
```
public class FileConfigurationOptions
extends MemoryConfigurationOptions
```
Various settings for controlling the input and output of a FileConfiguration

Author:

Bukkit, Carlos Lazaro Costa

See Also:

Bukkit Source

Constructor Summary

Constructors
Modifier Constructor and Description

protected FileConfigurationOptions(MemoryConfiguration configuration)

Constructors
Modifier	Constructor and Description
`protected`	`FileConfigurationOptions(MemoryConfiguration configuration)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Charset`	`charset()`
`FileConfigurationOptions`	`charset(Charset charset)`
`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.
`boolean`	`equals(Object o)`
`int`	`hashCode()`
`String`	`header()` Gets the header that will be applied to the top of the saved output.
`FileConfigurationOptions`	`header(String header)` Sets the header that will be applied to the top of the saved output.
`CommentFormatter`	`headerFormatter()` Gets the header format used for parsing and dumping the header.
`FileConfigurationOptions`	`headerFormatter(CommentFormatter headerFormatter)` Sets the header format used for parsing and dumping the header.
`boolean`	`isUnicode()`
`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.simpleyaml.configuration.ConfigurationOptions
copyDefaults, indent, indent, pathSeparator

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - FileConfigurationOptions
```
protected FileConfigurationOptions(MemoryConfiguration configuration)
```
- Method Detail
  - configuration
```
public FileConfiguration configuration()
```
    Description copied from class: ConfigurationOptions
    
    Returns the Configuration that this object is responsible for.
    
    Overrides:
    
    configuration in class MemoryConfigurationOptions
    
    Returns:
    
    Parent configuration
  - pathSeparator
```
public FileConfigurationOptions pathSeparator(char value)
```
    Description copied from class: ConfigurationOptions
    
    Sets the char that will be used to separate ConfigurationSections
    This value does not affect how the Configuration is stored, only in how you access the data. The default value is '.'
    
    Overrides:
    
    pathSeparator in class MemoryConfigurationOptions
    
    Parameters:
    
    value - Path separator
    
    Returns:
    
    This object, for chaining
  - copyDefaults
```
public FileConfigurationOptions copyDefaults(boolean value)
```
    Description copied from class: ConfigurationOptions
    
    Sets if the 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(String) will always return the same value as ConfigurationSection.isSet(String). The default value is true.
    
    Overrides:
    
    copyDefaults in class MemoryConfigurationOptions
    
    Parameters:
    
    value - Whether or not defaults are directly copied
    
    Returns:
    
    This object, for chaining
  - charset
```
public Charset charset()
```
  - charset
```
public FileConfigurationOptions charset(Charset charset)
```
  - isUnicode
```
public boolean isUnicode()
```
  - header
```
public String header()
```
    Gets the header that will be applied to the top of the saved output.
    This header will be commented out.
    Null is a valid value which will indicate that no header is to be applied. The default value is null.
    
    Returns:
    
    Header
  - header
```
public FileConfigurationOptions header(String 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 header which will indicate that no header is to be applied.
    
    Parameters:
    
    header - New header
    
    Returns:
    
    This object, for chaining
  - copyHeader
```
public boolean copyHeader()
```
    Gets whether or not the header should be copied from a default source.
    If this is true, if a default FileConfiguration is passed to MemoryConfiguration.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
```
public FileConfigurationOptions copyHeader(boolean value)
```
    Sets whether or not the header should be copied from a default source.
    If this is true, if a default FileConfiguration is passed to MemoryConfiguration.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
  - headerFormatter
```
public CommentFormatter headerFormatter()
```
    Gets the header format used for parsing and dumping the header.
    
    Returns:
    
    The header formatter
  - headerFormatter
```
public FileConfigurationOptions headerFormatter(CommentFormatter headerFormatter)
```
    Sets the header format used for parsing and dumping the header.
    
    Parameters:
    
    headerFormatter - The header formatter
    
    Returns:
    
    This object, for chaining
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class ConfigurationOptions
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class ConfigurationOptions

Class FileConfigurationOptions

Constructor Summary

Method Summary

Methods inherited from class org.simpleyaml.configuration.ConfigurationOptions

Methods inherited from class java.lang.Object

Constructor Detail

FileConfigurationOptions

Method Detail

configuration

pathSeparator

copyDefaults

charset

charset

isUnicode

header

header

copyHeader

copyHeader

headerFormatter

headerFormatter

equals

hashCode