Package org.apache.juneau.marshall.hocon

package org.apache.juneau.marshall.hocon

HOCON (Human-Optimized Config Object Notation) format serializer and parser for Apache Juneau.

HOCON is a superset of JSON used extensively in the JVM ecosystem (Akka, Play, sbt, Spark, Kafka) for configuration. It extends JSON with:

• Path expressions — a.b.c = value creates nested objects
• Equals sign separator — key = value (HOCON convention)
• Unquoted strings — keys and values without quotes when unambiguous
• Object merging — duplicate keys merge instead of overwrite
• Substitutions — ${var} and ${?var} references (parse only)
• Triple-quoted strings — """...""" with no escape processing
• Comments — # and //
• Optional root braces — top-level without {}

Bean mapping

Round-trip fidelity matches JSON: beans, maps, lists, primitives, dates (ISO 8601), and Duration all round-trip. Substitutions and value concatenation are resolved during parse; the serializer always writes concrete values.

Usage:

String hocon = HoconSerializer.DEFAULT.write(myBean); MyBean bean = HoconParser.DEFAULT.read(hocon, MyBean.class); // Or use the marshaller: String hocon = Hocon.of(myBean); MyBean bean = Hocon.to(hocon, MyBean.class);

See Also:

• HOCON
• HOCON Specification

Related Packages

Package	Description
org.apache.juneau.marshall	Marshalling API

Class	Description
Hocon	Annotation for customizing HOCON serialization and parsing behavior on classes, methods, and fields.
HoconAnnotation	Utility classes and methods for the @Hocon annotation.
HoconApply	Dynamically applies a @Hocon annotation to specified classes, methods, or fields.
HoconApply.Array	A collection of @HoconApply annotations.
HoconApplyAnnotation	Utility classes and methods for the @HoconApply annotation.
HoconApplyAnnotation.Applier	Applies targeted HoconApply annotations to a Context.Builder.
HoconApplyAnnotation.Builder	Builder class.
HoconBeanPropertyMeta	Metadata on bean properties specific to HOCON serializers and parsers.
HoconClassMeta	Metadata on classes specific to HOCON serializers and parsers.
HoconConfig	Annotation for specifying config properties defined in HoconSerializer and HoconParser.
HoconConfigAnnotation	Utility classes and methods for the @HoconConfig annotation.
HoconConfigAnnotation.ParserApply	Applies HoconConfig annotations to an HoconParser.Builder.
HoconConfigAnnotation.SerializerApply	Applies HoconConfig annotations to an HoconSerializer.Builder.
HoconMetaProvider	Interface for providing access to HoconClassMeta and HoconBeanPropertyMeta objects.
HoconParser	Parses HOCON (Human-Optimized Config Object Notation) text into POJO models.
HoconParser.Builder	Builder class.
HoconParserSession	Session for parsing HOCON format into POJOs.
HoconParserSession.Builder	Builder for HOCON parser session.
HoconResolver	Resolves ${var} and ${?
HoconSerializer	Serializes POJO models to HOCON (Human-Optimized Config Object Notation).
HoconSerializer.Builder	Builder class.
HoconSerializerSession	Session for serializing objects to HOCON format.
HoconSerializerSession.Builder	Builder for HOCON serializer session.
HoconTokenizer	Tokenizer for HOCON (Human-Optimized Config Object Notation) format.
HoconTokenizer.Token	A token with optional string or number value.
HoconTokenizer.TokenType	Token types produced by the tokenizer.
HoconValue	Intermediate representation for parsed HOCON data before conversion to Java beans.
HoconValue.HoconArray	HOCON array (maps to List or array).
HoconValue.HoconBoolean	HOCON boolean value.
HoconValue.HoconConcat	HOCON value concatenation (adjacent values concatenated).
HoconValue.HoconNull	HOCON null value.
HoconValue.HoconNumber	HOCON number value.
HoconValue.HoconObject	HOCON object (maps to Java bean or Map).
HoconValue.HoconString	HOCON string value.
HoconValue.HoconSubstitution	HOCON substitution reference (${var} or ${?
HoconValue.Type	Value type.
HoconWriter	Specialized writer for serializing HOCON format.