Module tcconfig.yaml

Package xyz.tozymc.configuration.yaml.option

Class YamlConfigOptions

java.lang.Object

xyz.tozymc.configuration.option.TcConfigOptions

xyz.tozymc.configuration.file.option.FileConfigOptions

xyz.tozymc.configuration.yaml.option.YamlConfigOptions

public class YamlConfigOptions
extends xyz.tozymc.configuration.file.option.FileConfigOptions

Various options for YamlConfig.

Since:

1.0

Field Summary

Fields inherited from class xyz.tozymc.configuration.option.TcConfigOptions

DEFAULT_PATH_SEPARATOR

Constructor Summary

Constructors

Constructor	Description
YamlConfigOptions(@NotNull xyz.tozymc.configuration.file.FileConfig config)	Creates new YamlConfigOptions for YamlConfig.

Method Summary

Modifier and Type	Method	Description
@NotNull YamlConfig	config()
@NotNull org.yaml.snakeyaml.DumperOptions	dumperOptions()
org.yaml.snakeyaml.DumperOptions.FlowStyle	flowStyle()	Gets flow style for YAML document, default is DumperOptions.FlowStyle.BLOCK.
@NotNull YamlConfigOptions	flowStyle(org.yaml.snakeyaml.DumperOptions.FlowStyle flowStyle)	Sets flow style for YAML document, default is DumperOptions.FlowStyle.BLOCK.
int	indent()	Gets the indent of between parent and child element.
@NotNull YamlConfigOptions	indent(int indent)	Sets the indent of between parent and child element.
boolean	prettyFlow()	Checks if YAML document using pretty flow style.
@NotNull YamlConfigOptions	prettyFlow(boolean prettyFlow)	Force the emitter to produce a pretty YAML document when using the flow style.

Methods inherited from class xyz.tozymc.configuration.file.option.FileConfigOptions

reloadType, reloadType

Methods inherited from class xyz.tozymc.configuration.option.TcConfigOptions

pathSeparator, pathSeparator

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

YamlConfigOptions

public YamlConfigOptions(@NotNull
                         @NotNull xyz.tozymc.configuration.file.FileConfig config)

Creates new YamlConfigOptions for YamlConfig.

Parameters:

config - Configuration that owned this options.

Method Detail

indent

public int indent()

Gets the indent of between parent and child element.

Returns:

The indent of between parent and child element.

indent

@NotNull
public @NotNull YamlConfigOptions indent(int indent)

Sets the indent of between parent and child element.

Parameters:

indent - indent of between parent and child element.

Returns:

This object, for chaining.

prettyFlow

public boolean prettyFlow()

Checks if YAML document using pretty flow style.

Returns:

True if YAML document using pretty flow style.

prettyFlow

@NotNull
public @NotNull YamlConfigOptions prettyFlow(boolean prettyFlow)

Force the emitter to produce a pretty YAML document when using the flow style.

Parameters:

prettyFlow - True produce pretty flow YAML document.

Returns:

This object, for chaining.

flowStyle

public org.yaml.snakeyaml.DumperOptions.FlowStyle flowStyle()

Gets flow style for YAML document, default is DumperOptions.FlowStyle.BLOCK.

Returns:

Flow style for YAML document.

flowStyle

@NotNull
public @NotNull YamlConfigOptions flowStyle(org.yaml.snakeyaml.DumperOptions.FlowStyle flowStyle)

Sets flow style for YAML document, default is DumperOptions.FlowStyle.BLOCK.

Parameters:

flowStyle - Flow style for YAML document.

Returns:

This object, for chaining.

dumperOptions

@NotNull
public @NotNull org.yaml.snakeyaml.DumperOptions dumperOptions()

config

@NotNull
public @NotNull YamlConfig config()

Overrides:

config in class xyz.tozymc.configuration.file.option.FileConfigOptions