# Overview This project contains [Jackson](http://wiki.fasterxml.com/JacksonHome) extension component for reading and writing [YAML](http://en.wikipedia.org/wiki/YAML) encoded data. [SnakeYAML](https://bitbucket.org/asomov/snakeyaml/) library is used for low-level YAML parsing. This project adds necessary abstractions on top to make things work with other Jackson functionality. Project is licensed under [Apache License 2.0](http://www.apache.org/licenses/LICENSE-2.0.txt). # Status [![Build Status](https://travis-ci.org/FasterXML/jackson-dataformat-yaml.svg?branch=master)](https://travis-ci.org/FasterXML/jackson-dataformat-yaml) [![Maven Central](https://maven-badges.herokuapp.com/maven-central/com.fasterxml.jackson.dataformat/jackson-dataformat-yaml/badge.svg)](https://maven-badges.herokuapp.com/maven-central/com.fasterxml.jackson.dataformat/jackson-dataformat-yaml/) [![Javadoc](https://javadoc-emblem.rhcloud.com/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-yaml/badge.svg)](http://www.javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-yaml) Module has been production ready since version 2.5. ## Maven dependency To use this extension on Maven-based projects, use following dependency: ```xml <dependency> <groupId>com.fasterxml.jackson.dataformat</groupId> <artifactId>jackson-dataformat-yaml</artifactId> <version>2.8.3</version> </dependency> ``` # Usage ## Simple usage Usage is as with basic `JsonFactory`; most commonly you will just construct a standard `ObjectMapper` with `com.fasterxml.jackson.dataformat.yaml.YAMLFactory`, like so: ```java ObjectMapper mapper = new ObjectMapper(new YAMLFactory()); User user = mapper.readValue(yamlSource, User.class); ``` but you can also just use underlying `YAMLFactory` and parser it produces, for event-based processing: ```java YAMLFactory factory = new YAMLFactory(); JsonParser parser = factory.createJsonParser(yamlString); // don't be fooled by method name... while (parser.nextToken() != null) { // do something! } ``` # Documentation * [Wiki](../../../wiki) contains links to Javadocs, external documentation