xref: /aosp_15_r20/external/snakeyaml/README.md (revision ac2a7c1bf4e14d82f3bd566dcc2d76d5b42faf34)
1*ac2a7c1bSSadaf Ebrahimi***The art of simplicity is a puzzle of complexity.***
2*ac2a7c1bSSadaf Ebrahimi
3*ac2a7c1bSSadaf Ebrahimi## Overview ##
4*ac2a7c1bSSadaf Ebrahimi[YAML](http://yaml.org) is a data serialization format designed for human readability and interaction with scripting languages.
5*ac2a7c1bSSadaf Ebrahimi
6*ac2a7c1bSSadaf EbrahimiSnakeYAML is a YAML 1.1 processor for the Java Virtual Machine version 7.
7*ac2a7c1bSSadaf EbrahimiFor YAML 1.2 (which is a superset of JSON) you may have a look at [SnakeYAML Engine](https://bitbucket.org/snakeyaml/snakeyaml-engine)
8*ac2a7c1bSSadaf Ebrahimi
9*ac2a7c1bSSadaf Ebrahimi## SnakeYAML features ##
10*ac2a7c1bSSadaf Ebrahimi
11*ac2a7c1bSSadaf Ebrahimi* a **complete** [YAML 1.1 processor](http://yaml.org/spec/1.1/current.html). (If you need YAML **1.2** support have a look [here](https://bitbucket.org/snakeyaml/snakeyaml-engine)). In particular, SnakeYAML can parse all examples from the specification.
12*ac2a7c1bSSadaf Ebrahimi* Unicode support including UTF-8/UTF-16 input/output.
13*ac2a7c1bSSadaf Ebrahimi* high-level API for serializing and deserializing native Java objects.
14*ac2a7c1bSSadaf Ebrahimi* support for all types from the [YAML types repository](http://yaml.org/type/index.html).
15*ac2a7c1bSSadaf Ebrahimi* relatively sensible error messages.
16*ac2a7c1bSSadaf Ebrahimi* when you plan to feed the parser with untrusted data please study the settings which allow to restrict incoming data.
17*ac2a7c1bSSadaf Ebrahimi
18*ac2a7c1bSSadaf Ebrahimi
19*ac2a7c1bSSadaf Ebrahimi## Info ##
20*ac2a7c1bSSadaf Ebrahimi * [Changes](https://bitbucket.org/snakeyaml/snakeyaml/wiki/Changes)
21*ac2a7c1bSSadaf Ebrahimi * [Documentation](https://bitbucket.org/snakeyaml/snakeyaml/wiki/Documentation)
22*ac2a7c1bSSadaf Ebrahimi * [CVE and untrusted data](https://bitbucket.org/snakeyaml/snakeyaml/wiki/CVE%20&%20NIST.md)
23*ac2a7c1bSSadaf Ebrahimi
24*ac2a7c1bSSadaf Ebrahimi## Contribute ##
25*ac2a7c1bSSadaf Ebrahimi* GIT [is now used](https://bitbucket.org/snakeyaml/snakeyaml/wiki/Migration%20to%20Git) to dance with the [source code](https://bitbucket.org/snakeyaml/snakeyaml/src).
26*ac2a7c1bSSadaf Ebrahimi* If you find a bug in SnakeYAML, please [file a bug report](https://bitbucket.org/snakeyaml/snakeyaml/issues?status=new&status=open).
27*ac2a7c1bSSadaf Ebrahimi* You may discuss SnakeYAML at
28*ac2a7c1bSSadaf Ebrahimi[the mailing list](http://groups.google.com/group/snakeyaml-core).
29*ac2a7c1bSSadaf Ebrahimi* Telegram group is removed because of the spam
30*ac2a7c1bSSadaf Ebrahimi* [YAML community](https://matrix.to/#/%23chat:yaml.io)
31