Package org.apache.juneau.marshall.ini

Class IniSerializer.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<IniSerializer.Builder>

org.apache.juneau.marshall.ini.IniSerializer.Builder

Enclosing class:

IniSerializer

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

Builder class.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
IniSerializer	build()	Build the object.
IniSerializer.Builder	copy()	Copy creator.
HashKey	hashKey()	Returns the hashkey of this builder.
IniSerializer.Builder	kvSeparator(char value)	Key-value separator character.
IniSerializer.Builder	spacedSeparator(boolean value)	Whether to add spaces around the separator.
IniSerializer.Builder	useComments()	Emit # comments from bean property descriptions.
IniSerializer.Builder	useComments(boolean value)	Whether to emit # comments from bean property descriptions.
IniSerializer.Builder	useWhitespace()	Use whitespace.
IniSerializer.Builder	useWhitespace(boolean value)	Same as WriterSerializer.Builder.useWhitespace() but allows you to explicitly specify the value.
IniSerializer.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(IniSerializer.Builder copyFrom)

Builder

protected Builder(IniSerializer copyFrom)

Method Details

kvSeparator

public IniSerializer.Builder kvSeparator(char value)

Key-value separator character.

Parameters:

value - = (default) or :.

Returns:

This object.

spacedSeparator

public IniSerializer.Builder spacedSeparator(boolean value)

Whether to add spaces around the separator.

Parameters:

value - true for key = value, false for key=value.

Returns:

This object.

useComments

public IniSerializer.Builder useComments(boolean value)

Whether to emit # comments from bean property descriptions.

Parameters:

value - The flag.

Returns:

This object.

useComments

public IniSerializer.Builder useComments()

Emit # comments from bean property descriptions.

Returns:

This object.

useWhitespace

public IniSerializer.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<IniSerializer.Builder>

Returns:

This object.

useWhitespace

public IniSerializer.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<IniSerializer.Builder>

Parameters:

value - The value for this setting.

Returns:

This object.

ws

public IniSerializer.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<IniSerializer.Builder>

Returns:

This object.

build

public IniSerializer build()

Description copied from class: Context.Builder

Build the object.

Overrides:

build in class WriterSerializer.Builder<IniSerializer.Builder>

Returns:

The built object.

copy

public IniSerializer.Builder copy()

Description copied from class: Context.Builder

Copy creator.

Specified by:

copy in class WriterSerializer.Builder<IniSerializer.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<IniSerializer.Builder>

Returns:

The hashkey of this builder.