Module tcconfig.yaml

Package xyz.tozymc.configuration.yaml.builder

Class YamlConfigBuilder

java.lang.Object

xyz.tozymc.configuration.builder.AbstractConfigBuilder<T>

xyz.tozymc.configuration.file.builder.AbstractFileConfigBuilder<YamlConfig>

xyz.tozymc.configuration.yaml.builder.YamlConfigBuilder

public class YamlConfigBuilder
extends xyz.tozymc.configuration.file.builder.AbstractFileConfigBuilder<YamlConfig>

Builder class to create a new YamlConfig.

Since:

1.0

See Also:

YamlConfig, YamlConfigOptions

Constructor Summary

Constructors

Constructor	Description
YamlConfigBuilder(Path configPath)	Constructs new file configuration builder with config Path.

Method Summary

Modifier and Type	Method	Description
protected YamlConfig	buildConfig()
org.yaml.snakeyaml.DumperOptions.FlowStyle	flowStyle()	Gets flow style for YAML document, default is DumperOptions.FlowStyle.BLOCK.
@NotNull YamlConfigBuilder	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 YamlConfigBuilder	indent(int indent)	Sets the indent of between parent and child element.
boolean	prettyFlow()	Checks if YAML document using pretty flow style.
@NotNull YamlConfigBuilder	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.builder.AbstractFileConfigBuilder

configPath, createConfig, defaultResource, defaultStream, defaultStream, reloadType, reloadType

Methods inherited from class xyz.tozymc.configuration.builder.AbstractConfigBuilder

pathSeparator, pathSeparator

Methods inherited from class java.lang.Object

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

Constructor Detail

YamlConfigBuilder

public YamlConfigBuilder(Path configPath)

Constructs new file configuration builder with config Path.

Parameters:

configPath - The configuration file.

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 YamlConfigBuilder indent(int indent)

Sets the indent of between parent and child element.

Parameters:

indent - indent of between parent and child element.

Returns:

This builder, 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 YamlConfigBuilder 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 builder, 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 YamlConfigBuilder 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 build, for chaining.

buildConfig

protected YamlConfig buildConfig()

Specified by:

buildConfig in class xyz.tozymc.configuration.file.builder.AbstractFileConfigBuilder<YamlConfig>