Package org.apache.juneau.marshall.bson

Class BsonSerializer.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.OutputStreamSerializer.Builder<BsonSerializer.Builder>

org.apache.juneau.marshall.bson.BsonSerializer.Builder

Enclosing class:

BsonSerializer

public static class BsonSerializer.Builder
extends OutputStreamSerializer.Builder<BsonSerializer.Builder>

Builder class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Builder()	Constructor, default settings.
protected	Builder(BsonSerializer copyFrom)	Copy constructor.
protected	Builder(BsonSerializer.Builder copyFrom)	Copy constructor.

Method Summary

Modifier and Type	Method	Description
BsonSerializer.Builder	addBeanTypesBson(boolean value)	Add "_type" properties when needed.
BsonSerializer.Builder	addRootType()	Add type attribute to root nodes.
BsonSerializer.Builder	addRootType(boolean value)	Same as Serializer.Builder.addRootType() but allows you to explicitly specify the value.
BsonSerializer.Builder	binaryFormat(BinaryFormat value)	Binary wire format.
BsonSerializer	build()	Build the object.
BsonSerializer.Builder	copy()	Copy creator.
HashKey	hashKey()	Returns the hashkey of this builder.
BsonSerializer.Builder	keepNullProperties()	Don't trim null bean property values.
BsonSerializer.Builder	keepNullProperties(boolean value)	Same as Serializer.Builder.keepNullProperties() but allows you to explicitly specify the value.
BsonSerializer.Builder	nullKeyString(String value)	The string used to represent null map keys in BSON documents.
BsonSerializer.Builder	writeDatesAsDatetime(boolean value)	Use BSON datetime type for dates.

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

accept, addBeanTypes, addBeanTypes, getAccept, getProduces, 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, 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()

Constructor, default settings.

Builder

protected Builder(BsonSerializer.Builder copyFrom)

Copy constructor.

Parameters:

copyFrom - The builder to copy from.
Cannot be null.

Builder

protected Builder(BsonSerializer copyFrom)

Copy constructor.

Parameters:

copyFrom - The bean to copy from.
Cannot be null.

Method Details

addBeanTypesBson

public BsonSerializer.Builder addBeanTypesBson(boolean value)

Add "_type" properties when needed.

Parameters:

value - The value for this setting.

Returns:

This object.

nullKeyString

public BsonSerializer.Builder nullKeyString(String value)

The string used to represent null map keys in BSON documents.

BSON document field names cannot be null. When serializing a Map with a null key, this string is used as the field name. When parsing, a field with this name is stored with null as the key.

Parameters:

value - The placeholder string for null keys. Default is "<NULL>".

Returns:

This object.

writeDatesAsDatetime

public BsonSerializer.Builder writeDatesAsDatetime(boolean value)

Use BSON datetime type for dates. When false, dates are serialized as ISO-8601 strings.

Parameters:

value - The value for this setting.

Returns:

This object.

binaryFormat

public BsonSerializer.Builder binaryFormat(BinaryFormat value)

Description copied from class: MarshallingContextable.Builder

Binary wire format.

Overrides:

binaryFormat in class MarshallingContextable.Builder<BsonSerializer.Builder>

Parameters:

value - The new value for this property.
Can be null (defaults to BinaryFormat.NOT_SET).

Returns:

This object.

keepNullProperties

public BsonSerializer.Builder keepNullProperties()

Description copied from class: Serializer.Builder

Don't trim null bean property values.

When enabled, null bean values will be serialized to the output.

Notes:

• Not enabling this setting will cause Maps with null values to be lost during parsing.

Example:

// Create a serializer that serializes null properties. WriterSerializer serializer = JsonSerializer .create() .keepNullProperties() .build(); // Our bean to serialize. public class MyBean { public String foo = null; } // Will contain "{foo:null}". String json = serializer.write(new MyBean());

Token streams: the cursor's raw structural methods always emit what the caller asks for; however this setting IS honored by TokenWriter.object(Object) during a bean walk.

Overrides:

keepNullProperties in class Serializer.Builder<BsonSerializer.Builder>

Returns:

This object.

keepNullProperties

public BsonSerializer.Builder keepNullProperties(boolean value)

Description copied from class: Serializer.Builder

Same as Serializer.Builder.keepNullProperties() but allows you to explicitly specify the value.

Overrides:

keepNullProperties in class Serializer.Builder<BsonSerializer.Builder>

Parameters:

value - The value for this setting.

Returns:

This object.

addRootType

public BsonSerializer.Builder addRootType()

Description copied from class: Serializer.Builder

Add type attribute to root nodes.

When enabled, "_type" properties will be added to top-level beans.

When disabled, it is assumed that the parser knows the exact Java POJO type being parsed, and therefore top-level type information that might normally be included to determine the data type will not be serialized.

For example, when serializing a top-level POJO with a @Marshalled(typeName) value, a '_type' attribute will only be added when this setting is enabled.

Note the differences between the following settings:

• Serializer.Builder.addRootType() - Affects whether '_type' is added to root node.
• Serializer.Builder.addBeanTypes() - Affects whether '_type' is added to any nodes.

Example:

// Create a serializer that adds _type to root node. WriterSerializer serializer= JsonSerializer .create() .addRootType() .build(); // Our bean to serialize. @Marshalled(typeName="mybean") public class MyBean { public String foo = "bar"; } // Will contain: {"_type":"mybean","foo":"bar"} String json = serializer.write(new MyBean());

Token streams: the cursor's raw structural methods do not emit "_type"; however this setting IS honored by TokenWriter.object(Object) for the root value.

Overrides:

addRootType in class Serializer.Builder<BsonSerializer.Builder>

Returns:

This object.

addRootType

public BsonSerializer.Builder addRootType(boolean value)

Description copied from class: Serializer.Builder

Same as Serializer.Builder.addRootType() but allows you to explicitly specify the value.

Overrides:

addRootType in class Serializer.Builder<BsonSerializer.Builder>

Parameters:

value - The value for this setting.

Returns:

This object.

build

public BsonSerializer build()

Description copied from class: Context.Builder

Build the object.

Overrides:

build in class OutputStreamSerializer.Builder<BsonSerializer.Builder>

Returns:

The built object.

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 Serializer.Builder<BsonSerializer.Builder>

Returns:

The hashkey of this builder.

copy

public BsonSerializer.Builder copy()

Description copied from class: Context.Builder

Copy creator.

Specified by:

copy in class OutputStreamSerializer.Builder<BsonSerializer.Builder>

Returns:

A new mutable copy of this builder.