Package org.bson.codecs.pojo

Class Conventions

java.lang.Object

org.bson.codecs.pojo.Conventions

public final class Conventions
extends Object

The default Conventions

Since:

3.5

See Also:

• Convention

Field Summary

Fields

Modifier and Type	Field	Description
static final Convention	ANNOTATION_CONVENTION	The annotation convention.
static final Convention	CLASS_AND_PROPERTY_CONVENTION	The default class and property conventions Sets the discriminator key if not set to _t and the discriminator value if not set to the ClassModels simple type name. Configures the PropertyModels.
static final List<Convention>	DEFAULT_CONVENTIONS	The default conventions list
static final List<Convention>	NO_CONVENTIONS	An empty conventions list
static final Convention	OBJECT_ID_GENERATORS	A convention that sets the IdGenerator if the id property is either a ObjectId or BsonObjectId.
static final Convention	SET_PRIVATE_FIELDS_CONVENTION	A convention that enables private fields to be set using reflection.
static final Convention	USE_GETTERS_FOR_SETTERS	A convention that uses getter methods as setters for collections and maps if there is no setter.

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

CLASS_AND_PROPERTY_CONVENTION

public static final Convention CLASS_AND_PROPERTY_CONVENTION

The default class and property conventions

• Sets the discriminator key if not set to _t and the discriminator value if not set to the ClassModels simple type name.
• Configures the PropertyModels. If the idProperty isn't set and there is a property named getId(), id or _id it will be marked as the idProperty.

ANNOTATION_CONVENTION

public static final Convention ANNOTATION_CONVENTION

The annotation convention.

Applies all the conventions related to the default org.bson.codecs.pojo.annotations.

SET_PRIVATE_FIELDS_CONVENTION

public static final Convention SET_PRIVATE_FIELDS_CONVENTION

A convention that enables private fields to be set using reflection.

This convention mimics how some other JSON libraries directly set a private field when there is no setter.

Note: This convention is not part of the DEFAULT_CONVENTIONS list and must explicitly be set.

Since:

3.6

USE_GETTERS_FOR_SETTERS

public static final Convention USE_GETTERS_FOR_SETTERS

A convention that uses getter methods as setters for collections and maps if there is no setter.

This convention mimics how JAXB mutate collections and maps.

Note: This convention is not part of the DEFAULT_CONVENTIONS list and must explicitly be set.

Since:

3.6

OBJECT_ID_GENERATORS

public static final Convention OBJECT_ID_GENERATORS

A convention that sets the IdGenerator if the id property is either a ObjectId or BsonObjectId.

Since:

3.10

DEFAULT_CONVENTIONS

public static final List<Convention> DEFAULT_CONVENTIONS

The default conventions list

NO_CONVENTIONS

public static final List<Convention> NO_CONVENTIONS

An empty conventions list