-
Class Summary
| Class |
Description |
| HoconProcessor |
A processor using Typesafe Conf to read Hocon files.
|
Package io.vertx.config.hocon Description
=== Hocon Configuration Format
The Hocon Configuration Format extends the Vert.x Configuration Retriever and provides the
support for the HOCON(https://github.com/typesafehub/config/blob/master/HOCON.md) format.
It supports includes, json, properties, macros...
==== Using the Hocon Configuration Format
To use the Hocon Configuration Format, add the following dependency to the
_dependencies_ section of your build descriptor:
* Maven (in your `pom.xml`):
[source,xml,subs="+attributes"]
----
${maven.groupId}
${maven.artifactId}
${maven.version}
${maven.groupId}
vertx-config
${maven.version}
----
* Gradle (in your `build.gradle` file):
[source,groovy,subs="+attributes"]
----
compile '${maven.groupId}:vertx-config:${maven.version}'
compile '${maven.groupId}:${maven.artifactId}:${maven.version}'
----
==== Configuring the store to use HOCON
Once added to your classpath or dependencies, you need to configure the
ConfigRetriever to use this format:
[source, $lang]
----
examples.Examples#example1(io.vertx.core.Vertx)
----
You just need to set `format` to `hocon`.