org.bson.codecs.pojo.annotations

Annotation Type BsonProperty

@Documented
 @Target(value={METHOD,FIELD,PARAMETER})
 @Retention(value=RUNTIME)
public @interface BsonProperty

An annotation that configures a property.

Note: Requires the Conventions.ANNOTATION_CONVENTION

Since:

3.5

See Also:

Conventions.ANNOTATION_CONVENTION

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	useDiscriminator
String	value The value to use for the mapped property when storing the property in the database.

Element Detail

value

public abstract String value

The value to use for the mapped property when storing the property in the database.

Returns:

the name to use for the property

See Also:

PropertyModel.getWriteName()

Default:

""

useDiscriminator

public abstract boolean useDiscriminator

Returns:

whether to include a discriminator when serializing nested Pojos.

Default:

false