Package org.apache.juneau.marshall.bson

package org.apache.juneau.marshall.bson

BSON (Binary JSON) marshalling support.

BSON is a binary serialization format used by MongoDB. It extends JSON with additional types (datetime, binary, 32-bit/64-bit integers, decimal128) and uses little-endian byte order.

Juneau provides BsonSerializer and BsonParser for serialization and parsing, plus Bson for a combined API.

Type mapping (summary)

• Beans/maps → BSON document (0x03)
• Collections/arrays → BSON array (0x04)
• Strings/enums → BSON string (0x02)
• Numbers → int32 (0x10), int64 (0x12), double (0x01), or decimal128 (0x13)
• Dates → BSON datetime (0x09) or ISO 8601 string
• byte[] → BSON binary (0x05)

Compared to MsgPack: BSON is length-prefixed and little-endian; supports typed integers (int32/int64), native datetime, and decimal128. Compared to JSON: BSON is binary and more compact for typed data.

See Also:

• BSON
• BSON Specification

Related Packages

Package	Description
org.apache.juneau.marshall	Marshalling API

Class	Description
Bson	Annotation that can be applied to classes, fields, and methods to tweak how they are handled by BsonSerializer and BsonParser.
BsonAnnotation	Utility classes and methods for the @Bson annotation.
BsonAnnotation.Builder	Builder class.
BsonApply	Dynamically applies a @Bson annotation to specified classes, methods, or fields.
BsonApply.Array	A collection of @BsonApply annotations.
BsonApplyAnnotation	Utility classes and methods for the @BsonApply annotation.
BsonApplyAnnotation.Applier	Applies targeted BsonApply annotations to a Context.Builder.
BsonApplyAnnotation.Builder	Builder class.
BsonBeanPropertyMeta	Metadata on bean properties specific to the BSON serializers and parsers pulled from the @Bson annotation on the bean property.
BsonClassMeta	Metadata on classes specific to the BSON serializers and parsers pulled from the @Bson annotation on the class.
BsonConfig	Annotation for specifying config properties defined in BsonSerializer and BsonParser.
BsonConfigAnnotation	Utility classes and methods for the @BsonConfig annotation.
BsonConfigAnnotation.ParserApply	Applies BsonConfig annotations to a BsonParser.Builder.
BsonConfigAnnotation.SerializerApply	Applies BsonConfig annotations to a BsonSerializer.Builder.
BsonDecimal128	IEEE 754-2008 Decimal128 BID (Binary Integer Decimal) encoding for BSON.
BsonInputStream	Specialized input stream for parsing BSON (Binary JSON) streams.
BsonMetaProvider	Interface for providing access to BsonClassMeta and BsonBeanPropertyMeta objects.
BsonOutputStream	Specialized output stream for serializing BSON (Binary JSON) streams.
BsonParser	Parses BSON (Binary JSON) into POJO models.
BsonParser.Base64	Default parser, string input encoded as BASE64.
BsonParser.Builder	Builder class.
BsonParser.SpacedHex	Default parser, string input encoded as spaced-hex.
BsonParserSession	Session object that lives for the duration of a single use of BsonParser.
BsonParserSession.Builder	Builder class.
BsonSerializer	Serializes POJO models to BSON (Binary JSON).
BsonSerializer.Base64	Default serializer, BASE64 string output.
BsonSerializer.Builder	Builder class.
BsonSerializer.SpacedHex	Default serializer, spaced-hex string output.
BsonSerializerSession	Session object that lives for the duration of a single use of BsonSerializer.
BsonSerializerSession.Builder	Builder class.
DataType	BSON element type codes per the BSON Specification 1.1.