org.simpleyaml.configuration.implementation.snakeyaml

Class SnakeYamlImplementation

java.lang.Object

org.simpleyaml.configuration.implementation.api.YamlImplementationCommentable

org.simpleyaml.configuration.implementation.snakeyaml.SnakeYamlImplementation

All Implemented Interfaces:

Commentable, YamlImplementation

Direct Known Subclasses:

SimpleYamlImplementation

public class SnakeYamlImplementation
extends YamlImplementationCommentable

YAML implementation using snakeyaml low-level API and snakeyaml comment processing available if YamlConfigurationOptions.useComments() is enabled.

Field Summary

Fields

Modifier and Type	Field and Description
protected org.yaml.snakeyaml.DumperOptions	dumperOptions
protected org.yaml.snakeyaml.LoaderOptions	loaderOptions
protected org.yaml.snakeyaml.resolver.Resolver	resolver
protected org.yaml.snakeyaml.Yaml	yaml
protected SnakeYamlConstructor	yamlConstructor
protected SnakeYamlRepresenter	yamlRepresenter

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

options, yamlCommentMapper

Constructor Summary

Constructors

Constructor and Description
SnakeYamlImplementation()
SnakeYamlImplementation(org.yaml.snakeyaml.LoaderOptions loaderOptions, org.yaml.snakeyaml.DumperOptions dumperOptions)
SnakeYamlImplementation(SnakeYamlConstructor yamlConstructor, SnakeYamlRepresenter yamlRepresenter)
SnakeYamlImplementation(SnakeYamlConstructor yamlConstructor, SnakeYamlRepresenter yamlRepresenter, org.yaml.snakeyaml.resolver.Resolver resolver)
SnakeYamlImplementation(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.
protected void	dumpYaml(Writer writer, ConfigurationSection section)
SnakeYamlConstructor	getConstructor()
org.yaml.snakeyaml.DumperOptions	getDumperOptions()
org.yaml.snakeyaml.LoaderOptions	getLoaderOptions()
protected String	getName(org.yaml.snakeyaml.nodes.Node node, boolean key)
SnakeYamlRepresenter	getRepresenter()
org.yaml.snakeyaml.resolver.Resolver	getResolver()
org.yaml.snakeyaml.Yaml	getYaml()
protected boolean	hasContent(Writer writer, ConfigurationSection section)
void	load(Reader reader, ConfigurationSection section) Load Yaml to a configuration section.
protected static org.yaml.snakeyaml.nodes.Node	resolveAnchor(org.yaml.snakeyaml.nodes.Node node)
protected org.yaml.snakeyaml.nodes.MappingNode	sectionToMapping(ConfigurationSection section, KeyTree.Node node, SnakeYamlCommentMapper yamlCommentMapper)
void	setComment(String path, String comment, CommentType type) Set a comment to the section or value selected by path.
protected void	setCommentsMapping(org.yaml.snakeyaml.nodes.MappingNode mapping, KeyTree.Node node, SnakeYamlCommentMapper yamlCommentMapper)
protected void	setCommentsSequence(org.yaml.snakeyaml.nodes.SequenceNode sequence, KeyTree.Node node, SnakeYamlCommentMapper yamlCommentMapper)
protected void	trackMapping(org.yaml.snakeyaml.nodes.MappingNode node, ConfigurationSection section, KeyTree.Node parent, SnakeYamlCommentMapper yamlCommentMapper)
protected void	trackSequence(org.yaml.snakeyaml.nodes.SequenceNode node, KeyTree.Node parent, SnakeYamlCommentMapper yamlCommentMapper)

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, load

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

getComment, setComment

Field Detail

yamlConstructor

protected final SnakeYamlConstructor yamlConstructor

yamlRepresenter

protected final SnakeYamlRepresenter yamlRepresenter

dumperOptions

protected final org.yaml.snakeyaml.DumperOptions dumperOptions

loaderOptions

protected final org.yaml.snakeyaml.LoaderOptions loaderOptions

resolver

protected final org.yaml.snakeyaml.resolver.Resolver resolver

yaml

protected final org.yaml.snakeyaml.Yaml yaml

Constructor Detail

SnakeYamlImplementation

public SnakeYamlImplementation()

SnakeYamlImplementation

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

SnakeYamlImplementation

public SnakeYamlImplementation(SnakeYamlRepresenter yamlRepresenter)

SnakeYamlImplementation

public SnakeYamlImplementation(SnakeYamlConstructor yamlConstructor,
                               SnakeYamlRepresenter yamlRepresenter)

SnakeYamlImplementation

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

Method Detail

getYaml

public org.yaml.snakeyaml.Yaml getYaml()

getConstructor

public SnakeYamlConstructor getConstructor()

getRepresenter

public SnakeYamlRepresenter getRepresenter()

getDumperOptions

public org.yaml.snakeyaml.DumperOptions getDumperOptions()

getLoaderOptions

public org.yaml.snakeyaml.LoaderOptions getLoaderOptions()

getResolver

public org.yaml.snakeyaml.resolver.Resolver getResolver()

load

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

Description copied from interface: YamlImplementation

Load Yaml to a configuration section.

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.

Parameters:

writer - writer to dump values

section - section with values to dump

Throws:

IOException

dumpYaml

protected void dumpYaml(Writer writer,
                        ConfigurationSection section)
                 throws IOException

Throws:

IOException

hasContent

protected boolean hasContent(Writer writer,
                             ConfigurationSection section)
                      throws IOException

Throws:

IOException

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 YamlImplementationCommentable

Parameters:

options - yaml options

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 YamlImplementationCommentable

Parameters:

path - path of desired section or key

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

type - either above (BLOCK) or SIDE

trackMapping

protected void trackMapping(org.yaml.snakeyaml.nodes.MappingNode node,
                            ConfigurationSection section,
                            KeyTree.Node parent,
                            SnakeYamlCommentMapper yamlCommentMapper)

trackSequence

protected void trackSequence(org.yaml.snakeyaml.nodes.SequenceNode node,
                             KeyTree.Node parent,
                             SnakeYamlCommentMapper yamlCommentMapper)

sectionToMapping

protected org.yaml.snakeyaml.nodes.MappingNode sectionToMapping(ConfigurationSection section,
                                                                KeyTree.Node node,
                                                                SnakeYamlCommentMapper yamlCommentMapper)

setCommentsSequence

protected void setCommentsSequence(org.yaml.snakeyaml.nodes.SequenceNode sequence,
                                   KeyTree.Node node,
                                   SnakeYamlCommentMapper yamlCommentMapper)

setCommentsMapping

protected void setCommentsMapping(org.yaml.snakeyaml.nodes.MappingNode mapping,
                                  KeyTree.Node node,
                                  SnakeYamlCommentMapper yamlCommentMapper)

getName

protected String getName(org.yaml.snakeyaml.nodes.Node node,
                         boolean key)

resolveAnchor

protected static org.yaml.snakeyaml.nodes.Node resolveAnchor(org.yaml.snakeyaml.nodes.Node node)