ch.rasc.bsoncodec.annotation

Annotation Type BsonDocument

@Target(value=TYPE)
 @Retention(value=SOURCE)
public @interface BsonDocument

Marks a class for the annotation processor to create a Codec implementation.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	codecProviderClassName Fully qualified classname of the CodecProvider that the generated Codec implementation should be added.
boolean	ignoreUnknown Controls the behavior of the decoder when he encounters fields that cannot be mapped to the pojo.
boolean	storeEmptyCollections Controls if empty collections and arrays should be stored in the database.
boolean	storeNullValues Controls if fields with null value should be stored in the database.

Element Detail

codecProviderClassName

public abstract String codecProviderClassName

Fully qualified classname of the CodecProvider that the generated Codec implementation should be added.

By default a class with name PojoCodecProvider is created in every package the processor finds classes with the BsonDocument annotation. The PojoCodecProvider contains a registry for every Codec from this package.

Default:

""

storeNullValues

public abstract boolean storeNullValues

Controls if fields with null value should be stored in the database.

Default behavior is not storing null values (false)

Default:

false

storeEmptyCollections

public abstract boolean storeEmptyCollections

Controls if empty collections and arrays should be stored in the database.

Default behavior is not storing empty collections and arrays (false)

Default:

false

ignoreUnknown

public abstract boolean ignoreUnknown

Controls the behavior of the decoder when he encounters fields that cannot be mapped to the pojo. true ignores these fields silently. false throw an exception.

Default is ignore unknown fields (true)

Default:

true