Package space.arim.dazzleconf.ext.snakeyaml

Class SnakeYamlOptions

java.lang.Object

space.arim.dazzleconf.ext.snakeyaml.SnakeYamlOptions

public final class SnakeYamlOptions
extends Object

Options for SnakeYAML configurations

Author:

A248

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SnakeYamlOptions.Builder	Builder of SnakeYamlOptions

Method Summary

Modifier and Type	Method	Description
Charset	charset()	Gets the charset used
CommentMode	commentMode()	Gets the comment mode used.
String	toString()
boolean	useCommentingWriter()	Deprecated. The choice of comments is no longer limited to whether the alternate writer is used.
Supplier<org.yaml.snakeyaml.Yaml>	yamlSupplier()	Gets the yaml supplier used

Methods inherited from class java.lang.Object

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

Method Details

yamlSupplier

public Supplier<org.yaml.snakeyaml.Yaml> yamlSupplier()

Gets the yaml supplier used

Returns:

the yaml supplier

commentMode

public CommentMode commentMode()

Gets the comment mode used. The mode exposes no data but may be used for comparison with other comment modes via equals

Returns:

the comment mode

useCommentingWriter

@Deprecated
public boolean useCommentingWriter()

Deprecated.

The choice of comments is no longer limited to whether the alternate writer is used. Use CommentMode instead

Whether the commenting alternative writer should be used. See SnakeYamlOptions.Builder.useCommentingWriter(boolean) for more details.

Returns:

whether the alternative yaml writer is enabled

charset

public Charset charset()

Gets the charset used

Returns:

the charset

toString

public String toString()

Overrides:

toString in class Object