org.simpleyaml.configuration.implementation

Class SimpleYamlImplementation

java.lang.Object

org.simpleyaml.configuration.implementation.api.YamlImplementationCommentable

org.simpleyaml.configuration.implementation.snakeyaml.SnakeYamlImplementation

org.simpleyaml.configuration.implementation.SimpleYamlImplementation

All Implemented Interfaces:

Commentable, YamlImplementation

public class SimpleYamlImplementation
extends SnakeYamlImplementation

Default YAML implementation using snakeyaml high-level API and a custom comment parser / dumper.

Field Summary

Fields inherited from class org.simpleyaml.configuration.implementation.snakeyaml.SnakeYamlImplementation

dumperOptions, loaderOptions, resolver, yaml, yamlConstructor, yamlRepresenter

Fields inherited from class org.simpleyaml.configuration.implementation.api.YamlImplementationCommentable

options, yamlCommentMapper

Constructor Summary

Constructors

Constructor and Description
SimpleYamlImplementation()
SimpleYamlImplementation(org.yaml.snakeyaml.LoaderOptions loaderOptions, org.yaml.snakeyaml.DumperOptions dumperOptions)
SimpleYamlImplementation(SnakeYamlConstructor yamlConstructor, SnakeYamlRepresenter yamlRepresenter)
SimpleYamlImplementation(SnakeYamlConstructor yamlConstructor, SnakeYamlRepresenter yamlRepresenter, org.yaml.snakeyaml.resolver.Resolver resolver)
SimpleYamlImplementation(SnakeYamlRepresenter yamlRepresenter)

Method Summary

Modifier and Type	Method and Description
void	configure(YamlConfigurationOptions options) Apply the configuration options to this implementation.
void	dump(Writer writer, ConfigurationSection section) Dump section values to Yaml.
void	load(Reader reader, ConfigurationSection section) Load Yaml to a configuration section.
void	load(SupplierIO.Reader readerSupplier, ConfigurationSection section) Load Yaml to a configuration section.
YamlCommentMapper	parseComments(Reader reader) Parse comments from a reader.
void	setComment(String path, String comment, CommentType type) Set a comment to the section or value selected by path.

Methods inherited from class org.simpleyaml.configuration.implementation.snakeyaml.SnakeYamlImplementation

dumpYaml, getConstructor, getDumperOptions, getLoaderOptions, getName, getRepresenter, getResolver, getYaml, hasContent, resolveAnchor, sectionToMapping, setCommentsMapping, setCommentsSequence, trackMapping, trackSequence

Methods inherited from class org.simpleyaml.configuration.implementation.api.YamlImplementationCommentable

getComment, getCommentMapper

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.simpleyaml.configuration.implementation.api.YamlImplementation

dump, load

Methods inherited from interface org.simpleyaml.configuration.comments.Commentable

getComment, setComment

Constructor Detail

SimpleYamlImplementation

public SimpleYamlImplementation()

SimpleYamlImplementation

public SimpleYamlImplementation(org.yaml.snakeyaml.LoaderOptions loaderOptions,
                                org.yaml.snakeyaml.DumperOptions dumperOptions)

SimpleYamlImplementation

public SimpleYamlImplementation(SnakeYamlRepresenter yamlRepresenter)

SimpleYamlImplementation

public SimpleYamlImplementation(SnakeYamlConstructor yamlConstructor,
                                SnakeYamlRepresenter yamlRepresenter)

SimpleYamlImplementation

public SimpleYamlImplementation(SnakeYamlConstructor yamlConstructor,
                                SnakeYamlRepresenter yamlRepresenter,
                                org.yaml.snakeyaml.resolver.Resolver resolver)

Method Detail

setComment

public void setComment(String path,
                       String comment,
                       CommentType type)

Description copied from interface: Commentable

Set a comment to the section or value selected by path. Comment will be indented automatically. Multi-line comments can be provided using \n character.

Specified by:

setComment in interface Commentable

Overrides:

setComment in class SnakeYamlImplementation

Parameters:

path - path of desired section or key

comment - the comment to add, # symbol is not needed

type - either above (BLOCK) or SIDE

load

public void load(SupplierIO.Reader readerSupplier,
                 ConfigurationSection section)
          throws IOException,
                 InvalidConfigurationException

Description copied from interface: YamlImplementation

Load Yaml to a configuration section.

Parameters:

readerSupplier - a function providing a reader of Yaml contents to load

section - the configuration to fill with the contents

Throws:

IOException - if cannot read contents.

InvalidConfigurationException - if contents is not a valid Yaml configuration

load

public void load(Reader reader,
                 ConfigurationSection section)
          throws IOException,
                 InvalidConfigurationException

Description copied from interface: YamlImplementation

Load Yaml to a configuration section.

Specified by:

load in interface YamlImplementation

Overrides:

load in class SnakeYamlImplementation

Parameters:

reader - a reader of Yaml contents to load

section - the configuration to fill with the contents

Throws:

IOException - if cannot read contents.

InvalidConfigurationException - if contents is not a valid Yaml configuration

dump

public void dump(Writer writer,
                 ConfigurationSection section)
          throws IOException

Description copied from interface: YamlImplementation

Dump section values to Yaml.

Specified by:

dump in interface YamlImplementation

Overrides:

dump in class SnakeYamlImplementation

Parameters:

writer - writer to dump values

section - section with values to dump

Throws:

IOException

parseComments

public YamlCommentMapper parseComments(Reader reader)
                                throws InvalidConfigurationException

Parse comments from a reader.

Parameters:

reader - Reader of a Configuration to parse.

Returns:

a comment mapper with comments parsed

Throws:

InvalidConfigurationException - if it hasn't been possible to read the contents

configure

public void configure(YamlConfigurationOptions options)

Description copied from interface: YamlImplementation

Apply the configuration options to this implementation.

Specified by:

configure in interface YamlImplementation

Overrides:

configure in class SnakeYamlImplementation

Parameters:

options - yaml options