Package org.apache.juneau.marshall.bson

Class BsonParser.Builder

java.lang.Object

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

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

org.apache.juneau.marshall.parser.Parser.Builder<SELF>

org.apache.juneau.marshall.parser.InputStreamParser.Builder<BsonParser.Builder>

org.apache.juneau.marshall.bson.BsonParser.Builder

Enclosing class:

BsonParser

public static class BsonParser.Builder
extends InputStreamParser.Builder<BsonParser.Builder>

Builder class.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
BsonParser.Builder	binaryFormat(BinaryFormat value)	Binary wire format.
BsonParser	build()	Build the object.
BsonParser.Builder	copy()	Copy creator.
HashKey	hashKey()	Returns the hashkey of this builder.
BsonParser.Builder	maxLength(int value)	The maximum allowed wire-declared length (in bytes) for BSON strings, binary payloads, and document/array size prefixes.
BsonParser.Builder	nullKeyString(String value)	The string used to represent null map keys in BSON documents.
BsonParser.Builder	trimStrings()	Trim parsed strings.
BsonParser.Builder	trimStrings(boolean value)	Same as Parser.Builder.trimStrings() but allows you to explicitly specify the value.

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

autoCloseStreams, autoCloseStreams, consumes, debugOutputLines, getConsumes, getNulls, listener, nulls, unbuffered, unbuffered

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(BsonParser.Builder copyFrom)

Copy constructor.

Parameters:

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

Builder

protected Builder(BsonParser copyFrom)

Copy constructor.

Parameters:

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

Method Details

binaryFormat

public BsonParser.Builder binaryFormat(BinaryFormat value)

Description copied from class: MarshallingContextable.Builder

Binary wire format.

Overrides:

binaryFormat in class MarshallingContextable.Builder<BsonParser.Builder>

Parameters:

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

Returns:

This object.

nullKeyString

public BsonParser.Builder nullKeyString(String value)

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

BSON document field names cannot be null. When parsing a field with this name, it is stored with null as the key in the target map.

Parameters:

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

Returns:

This object.

maxLength

public BsonParser.Builder maxLength(int value)

The maximum allowed wire-declared length (in bytes) for BSON strings, binary payloads, and document/array size prefixes.

Guards against malformed or adversarial input where a small payload declares a huge or negative length, which would otherwise trigger OutOfMemoryError or NegativeArraySizeException. Malformed lengths are reported as a clean parse error instead.

Parameters:

value - The maximum length in bytes. Default is 16 MiB (the conventional BSON document-size limit). Values ≤ 0 disable the cap (only the negative-length check remains).

Returns:

This object.

trimStrings

public BsonParser.Builder trimStrings()

Description copied from class: Parser.Builder

Trim parsed strings.

When enabled, string values will be trimmed of whitespace using String.trim() before being added to the POJO.

Example:

// Create a parser with trim-strings enabled. ReaderParser parser = JsonParser .create() .trimStrings() .build(); // Use it. String json = "{' foo ':' bar '}"; Map<String,String> myMap = parser.read(json, HashMap.class, String.class, String.class); // Make sure strings are parsed. assertEquals("bar", myMap.get("foo"));

Overrides:

trimStrings in class Parser.Builder<BsonParser.Builder>

Returns:

This object.

trimStrings

public BsonParser.Builder trimStrings(boolean value)

Description copied from class: Parser.Builder

Same as Parser.Builder.trimStrings() but allows you to explicitly specify the value.

Overrides:

trimStrings in class Parser.Builder<BsonParser.Builder>

Parameters:

value - The value for this setting.

Returns:

This object.

build

public BsonParser build()

Description copied from class: Context.Builder

Build the object.

Overrides:

build in class InputStreamParser.Builder<BsonParser.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 Parser.Builder<BsonParser.Builder>

Returns:

The hashkey of this builder.

copy

public BsonParser.Builder copy()

Description copied from class: Context.Builder

Copy creator.

Specified by:

copy in class InputStreamParser.Builder<BsonParser.Builder>

Returns:

A new mutable copy of this builder.