YamlConfigurationOptions (YamlConfiguration 1.3.2 API)

java.lang.Object
- org.bspfsystems.yamlconfiguration.configuration.ConfigurationOptions
- - org.bspfsystems.yamlconfiguration.configuration.MemoryConfigurationOptions
  - - org.bspfsystems.yamlconfiguration.file.FileConfigurationOptions
    - - org.bspfsystems.yamlconfiguration.file.YamlConfigurationOptions

```
public final class YamlConfigurationOptions
extends FileConfigurationOptions
```
Various settings for controlling the input and output of a YamlConfiguration.
Synchronized with the commit on 07-June-2022.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`@NotNull YamlConfiguration`	`configuration()` Deprecated.
`@NotNull YamlConfigurationOptions`	`copyDefaults(boolean copyDefaults)` Deprecated.
`@NotNull YamlConfigurationOptions`	`copyHeader(boolean copyHeader)` Deprecated.
`int`	`getCodePointLimit()` Gets the maximum number of code points that can be loaded in at one time.
`@NotNull YamlConfiguration`	`getConfiguration()` Gets the `Configuration` that this `ConfigurationOptions` controls.
`int`	`getIndent()` Gets the number of spaces used to represent an indent.
`int`	`getMaxAliases()` Gets the maximum number of aliases for collections.
`int`	`getWidth()` Gets how long a line can be before it gets split.
`@NotNull YamlConfigurationOptions`	`header(@Nullable String header)` Deprecated.
`int`	`indent()` Deprecated. This method exists for backwards compatibility. Please use `getIndent()` instead.
`@NotNull YamlConfigurationOptions`	`indent(int indent)` Deprecated. This method exists for backwards compatibility. Please use `setIndent(int)` instead.
`@NotNull YamlConfigurationOptions`	`pathSeparator(char pathSeparator)` Deprecated.
`@NotNull YamlConfigurationOptions`	`setCodePointLimit(int codePointLimit)` Sets the maximum number of code points that can be loaded in at one time.
`@NotNull YamlConfigurationOptions`	`setCopyDefaults(boolean copyDefaults)` Sets if the `Configuration` should copy values from its default `Configuration` directly.
`@NotNull YamlConfigurationOptions`	`setFooter(@Nullable List<String> footer)` Sets the footer that will be applied to the bottom of the saved output.
`@NotNull YamlConfigurationOptions`	`setHeader(@Nullable List<String> header)` Sets the header that will be applied to the top of the saved output.
`@NotNull YamlConfigurationOptions`	`setIndent(int indent)` Sets the number of spaces used to represent an indent.
`@NotNull YamlConfigurationOptions`	`setMaxAliases(int maxAliases)` Sets the maximum number of aliases for collections.
`@NotNull YamlConfigurationOptions`	`setParseComments(boolean parseComments)` Sets whether the comments in a `FileConfiguration` should be loaded and saved.
`@NotNull YamlConfigurationOptions`	`setPathSeparator(char pathSeparator)` Sets the `char` that will be used to separate `ConfigurationSections`.
`@NotNull YamlConfigurationOptions`	`setWidth(int width)` Sets how long a line can be before it gets split.

Methods inherited from class org.bspfsystems.yamlconfiguration.file.FileConfigurationOptions
copyHeader, getFooter, getHeader, getParseComments, header

Methods inherited from class org.bspfsystems.yamlconfiguration.configuration.ConfigurationOptions
copyDefaults, getCopyDefaults, getPathSeparator, pathSeparator

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

- Method Detail
  - getConfiguration
```
@NotNull
public @NotNull YamlConfiguration getConfiguration()
```
    Gets the Configuration that this ConfigurationOptions controls.
    
    Overrides:
    
    getConfiguration in class FileConfigurationOptions
    
    Returns:
    
    The Configuration that this ConfigurationOptions controls.
  - configuration
```
@Deprecated
 @NotNull
public @NotNull YamlConfiguration configuration()
```
    Deprecated.
    
    This method exists for backwards compatibility, and it will be removed in a future release.
    Please use ConfigurationOptions.getConfiguration() instead; it provides the same functionality.
    
    Overrides:
    
    configuration in class FileConfigurationOptions
    
    Returns:
    
    The Configuration that this ConfigurationOptions controls.
    
    See Also:
    
    ConfigurationOptions.getConfiguration()
  - setPathSeparator
```
@NotNull
public @NotNull YamlConfigurationOptions setPathSeparator(char pathSeparator)
```
    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:
    
    setPathSeparator in class FileConfigurationOptions
    
    Parameters:
    
    pathSeparator - The char used to separate ConfigurationSections.
    
    Returns:
    
    This ConfigurationOptions, for chaining.
  - pathSeparator
```
@Deprecated
 @NotNull
public @NotNull YamlConfigurationOptions pathSeparator(char pathSeparator)
```
    Deprecated.
    
    This method exists for backwards compatibility, and it will be removed in a future release.
    Please use ConfigurationOptions.setPathSeparator(char) instead; it provides the same functionality.
    
    Overrides:
    
    pathSeparator in class FileConfigurationOptions
    
    Parameters:
    
    pathSeparator - The char used to separate ConfigurationSections.
    
    Returns:
    
    This ConfigurationOptions, for chaining.
    
    See Also:
    
    ConfigurationOptions.setPathSeparator(char)
  - setCopyDefaults
```
@NotNull
public @NotNull YamlConfigurationOptions setCopyDefaults(boolean copyDefaults)
```
    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 false.
    
    Overrides:
    
    setCopyDefaults in class FileConfigurationOptions
    
    Parameters:
    
    copyDefaults - true if the default values should be copied, false otherwise.
    
    Returns:
    
    This ConfigurationOptions, for chaining.
  - copyDefaults
```
@Deprecated
 @NotNull
public @NotNull YamlConfigurationOptions copyDefaults(boolean copyDefaults)
```
    Deprecated.
    
    This method exists for backwards compatibility, and it will be removed in a future release.
    Please use ConfigurationOptions.setCopyDefaults(boolean) instead; it provides the same functionality.
    
    Overrides:
    
    copyDefaults in class FileConfigurationOptions
    
    Parameters:
    
    copyDefaults - true if the default values should be copied, false otherwise.
    
    Returns:
    
    This ConfigurationOptions, for chaining.
    
    See Also:
    
    ConfigurationOptions.setCopyDefaults(boolean)
  - setHeader
```
@NotNull
public @NotNull YamlConfigurationOptions setHeader(@Nullable
                                                            @Nullable List<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.
    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.
    The default header is no header.
    
    Overrides:
    
    setHeader in class FileConfigurationOptions
    
    Parameters:
    
    header - The new header, where every entry represents one line.
    
    Returns:
    
    This FileConfigurationOptions, for chaining.
  - header
```
@Deprecated
 @NotNull
public @NotNull YamlConfigurationOptions header(@Nullable
                                                                      @Nullable String header)
```
    Deprecated.
    
    This method exists for backwards compatibility, and it will be removed in a future release.
    Please use FileConfigurationOptions.setHeader(List) instead.
    
    Overrides:
    
    header in class FileConfigurationOptions
    
    Parameters:
    
    header - The new header, where every entry represents one line.
    
    Returns:
    
    This FileConfigurationOptions, for chaining.
    
    See Also:
    
    FileConfigurationOptions.setHeader(List)
  - setFooter
```
@NotNull
public @NotNull YamlConfigurationOptions setFooter(@Nullable
                                                            @Nullable List<String> footer)
```
    Sets the footer that will be applied to the bottom of the saved output.
    This footer will be commented out and applied directly at the bottom of the generated output of the FileConfiguration. It is not required to include a newline at the beginning of the footer 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.
    The default footer is no footer.
    
    Overrides:
    
    setFooter in class FileConfigurationOptions
    
    Parameters:
    
    footer - The new footer, where every entry represents one line.
    
    Returns:
    
    This FileConfigurationOptions, for chaining.
  - setParseComments
```
@NotNull
public @NotNull YamlConfigurationOptions setParseComments(boolean parseComments)
```
    Sets whether the comments in a FileConfiguration should be loaded and saved.
    If this is true, and if a default FileConfiguration is passed to Configuration.setDefaults(Configuration), then upon saving, the default comments will be parsed from the passed default FileConfiguration, instead of the ones provided in here.
    If no default is set on the Configuration, or the default is not a FileConfiguration, or that Configuration has no comments (FileConfigurationOptions.getHeader() returns an empty List), then the header specified in this Configuration will be used.
    The default value is true.
    
    Overrides:
    
    setParseComments in class FileConfigurationOptions
    
    Parameters:
    
    parseComments - true if the comments are to be parsed, false otherwise.
    
    Returns:
    
    This FileConfigurationOptions, for chaining.
  - copyHeader
```
@Deprecated
 @NotNull
public @NotNull YamlConfigurationOptions copyHeader(boolean copyHeader)
```
    Deprecated.
    
    This method only exists for backwards compatibility, and it will be removed in a future release.
    Please use FileConfigurationOptions.setParseComments(boolean) instead; it provides the same functionality.
    
    Overrides:
    
    copyHeader in class FileConfigurationOptions
    
    Parameters:
    
    copyHeader - true if the comments are to be parsed, false otherwise.
    
    Returns:
    
    This FileConfigurationOptions, for chaining.
    
    See Also:
    
    FileConfigurationOptions.setParseComments(boolean)
  - getIndent
```
public int getIndent()
```
    Gets the number of spaces used to represent an indent.
    The minimum value this may be is 2, and the maximum is 9.
    The default value is 2.
    
    Returns:
    
    The number of spaces used to represent an indent.
  - indent
```
@Deprecated
public int indent()
```
    Deprecated. This method exists for backwards compatibility. Please use getIndent() instead.
    
    This method exists for backwards compatibility, and it will be removed in a future release.
    Please use getIndent() instead; it provides the same functionality.
    
    Returns:
    
    The number of spaces used to represent an indent.
    
    See Also:
    
    getIndent()
  - setIndent
```
@NotNull
public @NotNull YamlConfigurationOptions setIndent(int indent)
                                                     throws IllegalArgumentException
```
    Sets the number of spaces used to represent an indent.
    The minimum value this may be is 2, and the maximum is 9.
    The default value is 2.
    
    Parameters:
    
    indent - The number of spaces used to represent an indent.
    
    Returns:
    
    This YamlConfigurationOptions, for chaining.
    
    Throws:
    
    IllegalArgumentException - If the given value is less than 2 or greater than 9.
  - indent
```
@Deprecated
 @NotNull
public @NotNull YamlConfigurationOptions indent(int indent)
                                                               throws IllegalArgumentException
```
    Deprecated. This method exists for backwards compatibility. Please use setIndent(int) instead.
    
    This method exists for backwards compatibility, and it will be removed in a future release.
    Please use setIndent(int) instead; it provides the same functionality.
    
    Parameters:
    
    indent - The number of spaces used to represent an indent.
    
    Returns:
    
    This YamlConfigurationOptions, for chaining.
    
    Throws:
    
    IllegalArgumentException - If the given value is less than 2 or greater than 9.
    
    See Also:
    
    setIndent(int)
  - getWidth
```
public int getWidth()
```
    Gets how long a line can be before it gets split.
    The minimum value this may be is 8, and the maximum is 1000.
    The default value is 80.
    
    Returns:
    
    The number of characters a line can be before it gets split.
  - setWidth
```
@NotNull
public @NotNull YamlConfigurationOptions setWidth(int width)
```
    Sets how long a line can be before it gets split.
    The minimum value this may be is 8, and the maximum is 1000.
    The default value is 80.
    
    Parameters:
    
    width - The number of characters a line can be before it gets split.
    
    Returns:
    
    This YamlConfigurationOptions, for chaining.
    
    Throws:
    
    IllegalArgumentException - If the given value is less than 8 or greater than 1000.
  - getMaxAliases
```
public int getMaxAliases()
```
    Gets the maximum number of aliases for collections.
    The minimum value this may be is 10, and the maximum is Integer.MAX_VALUE.
    The default value is 50. It is recommended to keep this value as low as possible for your use case as to prevent a Denial-of-Service known Billion Laughs Attack.
    
    Returns:
    
    The maximum number of aliases for collections.
  - setMaxAliases
```
@NotNull
public @NotNull YamlConfigurationOptions setMaxAliases(int maxAliases)
                                                         throws IllegalArgumentException
```
    Sets the maximum number of aliases for collections.
    The minimum value this may be is 10, and the maximum is Integer.MAX_VALUE (please use this wisely).
    A recommended value is 50. It is recommended to keep this value as low as possible for your use case as to prevent a Denial-of-Service known Billion Laughs Attack.
    
    Parameters:
    
    maxAliases - The maximum number of aliases for collections.
    
    Returns:
    
    This YamlConfigurationOptions, for chaining.
    
    Throws:
    
    IllegalArgumentException - If the given value is less than 10.
  - getCodePointLimit
```
public int getCodePointLimit()
```
    Gets the maximum number of code points that can be loaded in at one time.
    The minimum is 1kB (1024), and the maximum is Integer.MAX_VALUE (please use this wisely).
    A recommended value is 3 MB (1024 * 1024 * 3).
    
    Returns:
    
    The maximum number of code points.
  - setCodePointLimit
```
@NotNull
public @NotNull YamlConfigurationOptions setCodePointLimit(int codePointLimit)
                                                             throws IllegalArgumentException
```
    Sets the maximum number of code points that can be loaded in at one time.
    The minimum is 1kB (1024), and the maximum is Integer.MAX_VALUE (please use this wisely).
    A recommended value is 3 MB (1024 * 1024 * 3).
    
    Parameters:
    
    codePointLimit - The maximum number of code points for loading.
    
    Returns:
    
    This YamlConfigurationOptions, for chaining.
    
    Throws:
    
    IllegalArgumentException - If the given value is less than 1kB (1024).

Class YamlConfigurationOptions

Method Summary

Methods inherited from class org.bspfsystems.yamlconfiguration.file.FileConfigurationOptions

Methods inherited from class org.bspfsystems.yamlconfiguration.configuration.ConfigurationOptions

Methods inherited from class java.lang.Object

Method Detail

getConfiguration

configuration

setPathSeparator

pathSeparator

setCopyDefaults

copyDefaults

setHeader

header

setFooter

setParseComments

copyHeader

getIndent

indent

setIndent

indent

getWidth

setWidth

getMaxAliases

setMaxAliases

getCodePointLimit

setCodePointLimit