Package org.apache.juneau.marshall.hjson

package org.apache.juneau.marshall.hjson

Hjson (Human JSON) format serializer and parser for Apache Juneau.

Hjson extends JSON with human-friendly features designed for configuration files and hand-edited data:

• Quoteless strings — values without quotes when unambiguous (e.g. name: Alice)
• Multiline strings — triple single-quote ''' blocks with indentation stripping
• Comments — #, //, and block comments (/* ... */)
• Optional commas — newlines can separate object members and array elements
• Trailing commas — ignored
• Unquoted keys — object keys need not be quoted when safe
• Root-braceless objects — top-level content without wrapping {} (parse only)

Syntax summary

Strings: quoteless (to end of line), double-quoted, single-quoted, or multiline '''...'''. Numbers, booleans (true/false), and null follow JSON rules. Objects use {} with key: value pairs; arrays use [].

Java mapping

Objects → JsonMap; arrays → JsonList; strings → String; numbers → Number subclasses; booleans → Boolean; null → null. Beans are created when _type is present or when parsing to a specific bean class.

Usage:

String hjson = HjsonSerializer.DEFAULT.write(myBean); MyBean bean = HjsonParser.DEFAULT.read(hjson, MyBean.class); // Or use the marshaller: String hjson = Hjson.of(myBean); MyBean bean = Hjson.to(hjson, MyBean.class);

See Also:

• Hjson
• Hjson Specification

Related Packages

Package	Description
org.apache.juneau.marshall	Marshalling API

Class	Description
Hjson	Annotation for customizing Hjson serialization and parsing behavior on classes, methods, and fields.
HjsonAnnotation	Utility classes and methods for the @Hjson annotation.
HjsonApply	Dynamically applies a @Hjson annotation to specified classes, methods, or fields.
HjsonApply.Array	A collection of @HjsonApply annotations.
HjsonApplyAnnotation	Utility classes and methods for the @HjsonApply annotation.
HjsonApplyAnnotation.Applier	Applies targeted HjsonApply annotations to a Context.Builder.
HjsonApplyAnnotation.Builder	Builder class.
HjsonBeanPropertyMeta	Metadata on bean properties specific to Hjson serializers and parsers.
HjsonClassMeta	Metadata on classes specific to Hjson serializers and parsers.
HjsonConfig	Annotation for specifying config properties defined in HjsonSerializer and HjsonParser.
HjsonConfigAnnotation	Utility classes and methods for the @HjsonConfig annotation.
HjsonConfigAnnotation.ParserApply	Applies HjsonConfig annotations to an HjsonParser.Builder.
HjsonConfigAnnotation.SerializerApply	Applies HjsonConfig annotations to an HjsonSerializer.Builder.
HjsonMetaProvider	Interface for providing access to HjsonClassMeta and HjsonBeanPropertyMeta objects.
HjsonParser	Parses Hjson (Human JSON) text into POJO models.
HjsonParser.Builder	Builder class.
HjsonParserSession	Session for parsing Hjson format into POJOs.
HjsonParserSession.Builder	Builder for Hjson parser session.
HjsonSerializer	Serializes POJO models to Hjson (Human JSON).
HjsonSerializer.Builder	Builder class.
HjsonSerializerSession	Session for serializing objects to Hjson format.
HjsonSerializerSession.Builder	Builder for Hjson serializer session.
HjsonTokenizer	Tokenizer for Hjson format.
HjsonTokenizer.Token	A token with optional string or number value.
HjsonTokenizer.TokenType	Token types produced by the tokenizer.
HjsonWriter	Specialized writer for serializing Hjson format.