Package de.clickism.configured.format

Class YamlFormat

java.lang.Object

de.clickism.configured.format.ConfigFormat

de.clickism.configured.format.BaseFormat

de.clickism.configured.format.YamlFormat

public class YamlFormat
extends de.clickism.configured.format.BaseFormat

YAML format for configuration files.

Field Summary

Fields inherited from class de.clickism.configured.format.ConfigFormat

separateConfigOptions, writeComments

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	YamlFormat()	Creates a new YamlFormat instance.

Method Summary

Modifier and Type	Method	Description
String	formatComment(String comment)
@NotNull Map<String,Object>	read(File file)
protected void	writeFormatFooter(StringBuilder sb)
protected void	writeFormatHeader(StringBuilder sb)
protected void	writeKeyValue(StringBuilder sb, String key, Object value, boolean hasNext)
static YamlFormat	yaml()	Creates a new YamlFormat instance.

Methods inherited from class de.clickism.configured.format.BaseFormat

write, writeConfigOption, writeData, writeDescription, writeFooter, writeHeader

Methods inherited from class de.clickism.configured.format.ConfigFormat

separateConfigOptions, writeComments

Methods inherited from class java.lang.Object

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

Constructor Details

YamlFormat

protected YamlFormat()

Creates a new YamlFormat instance.

Method Details

yaml

public static YamlFormat yaml()

Creates a new YamlFormat instance.

Returns:

a new instance of YamlFormat.

read

@NotNull
public @NotNull Map<String,Object> read(File file)
                                 throws Exception

Specified by:

read in class de.clickism.configured.format.ConfigFormat

Throws:

Exception

formatComment

public String formatComment(String comment)

Specified by:

formatComment in class de.clickism.configured.format.BaseFormat

writeKeyValue

protected void writeKeyValue(StringBuilder sb,
 String key,
 Object value,
 boolean hasNext)

Specified by:

writeKeyValue in class de.clickism.configured.format.BaseFormat

writeFormatHeader

protected void writeFormatHeader(StringBuilder sb)

Specified by:

writeFormatHeader in class de.clickism.configured.format.BaseFormat

writeFormatFooter

protected void writeFormatFooter(StringBuilder sb)

Specified by:

writeFormatFooter in class de.clickism.configured.format.BaseFormat