Package org.apache.juneau.marshall.hocon

Class HoconParser

java.lang.Object

org.apache.juneau.marshall.Context

org.apache.juneau.marshall.MarshallingContextable

org.apache.juneau.marshall.parser.Parser

org.apache.juneau.marshall.parser.ReaderParser

org.apache.juneau.marshall.hocon.HoconParser

All Implemented Interfaces:

HoconMetaProvider, RecordReadable

public class HoconParser
extends ReaderParser
implements HoconMetaProvider, RecordReadable

Parses HOCON (Human-Optimized Config Object Notation) text into POJO models.

Media types

Handles Content-Type types: application/hocon

Description

Multi-pass parsing strategy: tokenize → build intermediate tree → resolve substitutions → convert to bean.

Accepts all three key-value separators: = (HOCON convention), : (JSON style), and whitespace before { (for object values).

Supports unquoted string keys and values, path expressions (a.b.c = value), object merging, substitution resolution, triple-quoted strings, both // and # comments, and optional root braces.

Example input (bean):

name = myapp port = 8080 debug = true database { host = localhost port = 5432 } tags = [web, api, rest]

Limitations:

• include directives are not supported — they are ignored with a warning during parsing.
• Duration/size unit suffixes (10s, 5m, 512K, 2G) are treated as unquoted strings.
• Substitutions are resolved before bean conversion; the resolved (concrete) values are what Juneau sees.

See Also:

• HOCON

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	HoconParser.Builder	Builder class.

Nested classes/interfaces inherited from class org.apache.juneau.marshall.parser.ReaderParser

ReaderParser.DefaultBuilder

Nested classes/interfaces inherited from class org.apache.juneau.marshall.parser.Parser

Parser.Null

Field Summary

Fields

Modifier and Type	Field	Description
static final HoconParser	DEFAULT	Default parser.
protected final boolean	resolveSubstitutions	Whether to resolve ${var} substitutions.

Fields inherited from class org.apache.juneau.marshall.parser.Parser

autoCloseStreams, consumes, debugOutputLines, listener, nulls, trimStrings, unbuffered

Fields inherited from class org.apache.juneau.marshall.MarshallingContextable

marshallingContext

Fields inherited from class org.apache.juneau.marshall.Context

CONTEXT_APPLY_FILTER

Constructor Summary

Constructors

Constructor	Description
HoconParser(HoconParser.Builder builder)	Constructor.

Method Summary

Modifier and Type	Method	Description
HoconParser.Builder	copy()	Creates a builder from this context object.
static HoconParser.Builder	create()	Creates a new builder.
HoconParserSession.Builder	createSession()	Create a session builder based on the properties defined on this context.
HoconBeanPropertyMeta	getHoconBeanPropertyMeta(BeanPropertyMeta bpm)	Returns the HOCON-specific metadata on the specified bean property.
HoconClassMeta	getHoconClassMeta(ClassMeta<?> cm)	Returns the HOCON-specific metadata on the specified class.
boolean	isRecordStreaming()	Streaming-quality signal queryable before opening a cursor.
RecordReader	readRecords(Object input)	Convenience delegator that opens a RecordReader over the input using default session arguments (mirrors Parser.read(Object, Class)).

Methods inherited from class org.apache.juneau.marshall.parser.ReaderParser

getSession, getStreamCharset, isReaderParser, properties

Methods inherited from class org.apache.juneau.marshall.parser.Parser

canHandle, createParserBuilder, doRead, getDebugOutputLines, getListener, getMediaTypes, getNulls, getPrimaryMediaType, isAutoCloseStreams, isTrimStrings, isUnbuffered, read, read, read, read, read, read, readArgs, readIntoCollection, readIntoMap, readWithOuter

Methods inherited from class org.apache.juneau.marshall.MarshallingContextable

getDurationFormat, getMarshallingContext, getPeriodFormat

Methods inherited from class org.apache.juneau.marshall.Context

createBuilder, getAnnotationProvider, init, isDebug, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

resolveSubstitutions

protected final boolean resolveSubstitutions

Whether to resolve ${var} substitutions.

DEFAULT

public static final HoconParser DEFAULT

Default parser.

Constructor Details

HoconParser

public HoconParser(HoconParser.Builder builder)

Constructor.

Parameters:

builder - The builder.

Method Details

create

public static HoconParser.Builder create()

Creates a new builder.

Returns:

A new builder.

createSession

public HoconParserSession.Builder createSession()

Description copied from class: Context

Create a session builder based on the properties defined on this context.

Use this method for creating sessions where you want to override basic settings. Otherwise, use Context.getSession() directly.

Overrides:

createSession in class ReaderParser

Returns:

A new session builder.

copy

public HoconParser.Builder copy()

Description copied from class: Context

Creates a builder from this context object.

Builders are used to define new contexts (e.g. serializers, parsers) based on existing configurations.

Overrides:

copy in class Parser

Returns:

A new Builder object.

getHoconBeanPropertyMeta

public HoconBeanPropertyMeta getHoconBeanPropertyMeta(BeanPropertyMeta bpm)

Description copied from interface: HoconMetaProvider

Returns the HOCON-specific metadata on the specified bean property.

Specified by:

getHoconBeanPropertyMeta in interface HoconMetaProvider

Parameters:

bpm - The bean property to return the metadata on.

Returns:

The metadata.

getHoconClassMeta

public HoconClassMeta getHoconClassMeta(ClassMeta<?> cm)

Description copied from interface: HoconMetaProvider

Returns the HOCON-specific metadata on the specified class.

Specified by:

getHoconClassMeta in interface HoconMetaProvider

Parameters:

cm - The class to return the metadata on.

Returns:

The metadata.

readRecords

public RecordReader readRecords(Object input)
                         throws IOException

Convenience delegator that opens a RecordReader over the input using default session arguments (mirrors Parser.read(Object, Class)).

The real implementation lives on HoconParserSession.readRecords(Object). Callers that need request-derived configuration (locale, timezone, schema, swaps) should call createSession() and invoke HoconParserSession.readRecords(Object) on the built session instead.

Specified by:

readRecords in interface RecordReadable

Parameters:

input - The input.

Returns:

A new RecordReader cursor.

Throws:

IOException - If a problem occurred opening the underlying input.

isRecordStreaming

public boolean isRecordStreaming()

Description copied from interface: RecordReadable

Streaming-quality signal queryable before opening a cursor.

Specified by:

isRecordStreaming in interface RecordReadable

Returns:

true if RecordReadable.readRecords(Object) returns an O(1)-memory streaming cursor; false for buffered (whole-value) formats backed by RecordAdapter.