Package org.apache.juneau.marshall.hocon

Class HoconSerializer.Builder

java.lang.Object

org.apache.juneau.marshall.Context.Builder<SELF>

org.apache.juneau.marshall.MarshallingContextable.Builder<SELF>

org.apache.juneau.marshall.MarshallingTraverseContext.Builder<SELF>

org.apache.juneau.marshall.serializer.Serializer.Builder<SELF>

org.apache.juneau.marshall.serializer.WriterSerializer.Builder<HoconSerializer.Builder>

org.apache.juneau.marshall.hocon.HoconSerializer.Builder

Enclosing class:

HoconSerializer

public static class HoconSerializer.Builder
extends WriterSerializer.Builder<HoconSerializer.Builder>

Builder class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Builder()
protected	Builder(HoconSerializer copyFrom)
protected	Builder(HoconSerializer.Builder copyFrom)

Method Summary

Modifier and Type	Method	Description
HoconSerializer	build()	Build the object.
HoconSerializer.Builder	compact()	Creates compact output (comma-separated, single line).
HoconSerializer.Builder	copy()	Copy creator.
HashKey	hashKey()	Returns the hashkey of this builder.
HoconSerializer.Builder	omitRootBraces(boolean value)	Omits root-level object braces {} in output.
HoconSerializer.Builder	useEqualsSign(boolean value)	Uses = for key-value separator (HOCON convention).
HoconSerializer.Builder	useMultilineStrings(boolean value)	Enables triple-quoted strings for values containing newlines.
HoconSerializer.Builder	useNewlineSeparators(boolean value)	Uses newlines instead of commas between object members.
HoconSerializer.Builder	useUnquotedKeys(boolean value)	Enables unquoted object keys when safe.
HoconSerializer.Builder	useUnquotedStrings(boolean value)	Enables unquoted string output when values are unambiguous.
HoconSerializer.Builder	useWhitespace()	Use whitespace.
HoconSerializer.Builder	useWhitespace(boolean value)	Same as WriterSerializer.Builder.useWhitespace() but allows you to explicitly specify the value.
HoconSerializer.Builder	ws()	Use whitespace.

Methods inherited from class org.apache.juneau.marshall.serializer.WriterSerializer.Builder

maxIndent, quoteChar, quoteCharOverride, sq, streamCharset

Methods inherited from class org.apache.juneau.marshall.serializer.Serializer.Builder

accept, addBeanTypes, addBeanTypes, addRootType, addRootType, getAccept, getProduces, keepNullProperties, keepNullProperties, listener, nonDefault, nonDefault, produces, sortCollections, sortCollections, sortMaps, sortMaps, trimEmptyCollections, trimEmptyCollections, trimEmptyMaps, trimEmptyMaps, trimStrings, trimStrings, uriContext, uriRelativity, uriResolution

Methods inherited from class org.apache.juneau.marshall.MarshallingTraverseContext.Builder

detectRecursions, detectRecursions, ignoreRecursions, ignoreRecursions, initialDepth, maxDepth

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

activeView, annotations, beanClassVisibility, beanConstructorVisibility, beanDictionary, beanFieldVisibility, beanInterceptor, beanMapPutReturnsOldValue, beanMethodVisibility, beanProperties, beanProperties, beanProperties, beanPropertiesExcludes, beanPropertiesExcludes, beanPropertiesExcludes, beanPropertiesReadOnly, beanPropertiesReadOnly, beanPropertiesReadOnly, beanPropertiesWriteOnly, beanPropertiesWriteOnly, beanPropertiesWriteOnly, beansRequireDefaultConstructor, beansRequireSerializable, beansRequireSettersForGetters, bigNumberFormat, binaryFormat, bitSetFormat, booleanFormat, calendarFormat, classFormat, classLoader, currencyFormat, dateFormat, debug, dictionaryOn, disableBeansRequireSomeProperties, disableDefaultViewInclusion, disableIgnoreMissingSetters, disableIgnoreTransientFields, disableIgnoreUnknownNullBeanProperties, disableInterfaceProxies, durationFormat, enumFormat, example, example, findFluentSetters, findFluentSetters, floatFormat, ignoreInvocationExceptionsOnGetters, ignoreInvocationExceptionsOnSetters, ignoreUnknownBeanProperties, ignoreUnknownEnumValues, implClass, implClasses, interfaceClass, interfaces, locale, localeFormat, marshallingContext, marshallingContext, marshallingContext, marshallingContext, mediaType, notBeanClasses, notBeanPackages, periodFormat, propertyNamer, propertyNamer, recordComponentOrder, stopClass, swap, swap, swaps, swaps, temporalFormat, timeZone, timeZoneFormat, typeName, typePropertyName, typePropertyName, unsortedProperties, unsortedProperties, useJavaBeanIntrospector, uuidFormat, validateSchema, validateSchema

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

annotations, apply, applyAnnotations, applyAnnotations, asSubtype, build, cache, canApply, copyOrNull, debug, getApplied, getType, impl, isDebug, registerBuilders, self, type

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

protected Builder()

Builder

protected Builder(HoconSerializer.Builder copyFrom)

Builder

protected Builder(HoconSerializer copyFrom)

Method Details

useEqualsSign

public HoconSerializer.Builder useEqualsSign(boolean value)

Uses = for key-value separator (HOCON convention).

Parameters:

value - true for =, false for :.

Returns:

This object.

useUnquotedStrings

public HoconSerializer.Builder useUnquotedStrings(boolean value)

Enables unquoted string output when values are unambiguous.

Parameters:

value - true to emit unquoted strings when safe.

Returns:

This object.

useUnquotedKeys

public HoconSerializer.Builder useUnquotedKeys(boolean value)

Enables unquoted object keys when safe.

Parameters:

value - true to emit unquoted keys when safe.

Returns:

This object.

omitRootBraces

public HoconSerializer.Builder omitRootBraces(boolean value)

Omits root-level object braces {} in output.

Parameters:

value - true to omit root braces.

Returns:

This object.

useMultilineStrings

public HoconSerializer.Builder useMultilineStrings(boolean value)

Enables triple-quoted strings for values containing newlines.

Parameters:

value - true to use """ blocks for newline-containing strings.

Returns:

This object.

useNewlineSeparators

public HoconSerializer.Builder useNewlineSeparators(boolean value)

Uses newlines instead of commas between object members.

Parameters:

value - true for newline-separated members.

Returns:

This object.

compact

public HoconSerializer.Builder compact()

Creates compact output (comma-separated, single line).

Returns:

This object.

useWhitespace

public HoconSerializer.Builder useWhitespace()

Description copied from class: WriterSerializer.Builder

Use whitespace.

When enabled, whitespace is added to the output to improve readability.

Example:

// Create a serializer with whitespace enabled. WriterSerializer serializer = JsonSerializer .create() .useWhitespace() .build(); // A bean with a single property public class MyBean { public String foo = "bar"; } // Produces "\{\n\t"foo": "bar"\n\}\n" String json = serializer.write(new MyBean());

Overrides:

useWhitespace in class WriterSerializer.Builder<HoconSerializer.Builder>

Returns:

This object.

useWhitespace

public HoconSerializer.Builder useWhitespace(boolean value)

Description copied from class: WriterSerializer.Builder

Same as WriterSerializer.Builder.useWhitespace() but allows you to explicitly specify the value.

Overrides:

useWhitespace in class WriterSerializer.Builder<HoconSerializer.Builder>

Parameters:

value - The value for this setting.

Returns:

This object.

ws

public HoconSerializer.Builder ws()

Description copied from class: WriterSerializer.Builder

Use whitespace.

When enabled, whitespace is added to the output to improve readability.

Example:

// Create a serializer with whitespace enabled. WriterSerializer serializer = JsonSerializer .create() .ws() .build(); // A bean with a single property public class MyBean { public String foo = "bar"; } // Produces "\{\n\t"foo": "bar"\n\}\n" String json = serializer.write(new MyBean());

Overrides:

ws in class WriterSerializer.Builder<HoconSerializer.Builder>

Returns:

This object.

build

public HoconSerializer build()

Description copied from class: Context.Builder

Build the object.

Overrides:

build in class WriterSerializer.Builder<HoconSerializer.Builder>

Returns:

The built object.

copy

public HoconSerializer.Builder copy()

Description copied from class: Context.Builder

Copy creator.

Specified by:

copy in class WriterSerializer.Builder<HoconSerializer.Builder>

Returns:

A new mutable copy of this builder.

hashKey

public HashKey hashKey()

Description copied from class: Context.Builder

Returns the hashkey of this builder.

Used to return previously instantiated context beans that have matching hashkeys. The HashKey object is suitable for use as a hashmap key of a map of context beans. A context bean is considered equivalent if the HashKey.equals(Object) method is the same.

Overrides:

hashKey in class WriterSerializer.Builder<HoconSerializer.Builder>

Returns:

The hashkey of this builder.