org.bson.codecs.pojo

Class ClassModelBuilder<T>

java.lang.Object

org.bson.codecs.pojo.ClassModelBuilder<T>

Type Parameters:

T - The type of the class the ClassModel represents

public class ClassModelBuilder<T>
extends Object

A builder for programmatically creating ClassModels.

Since:

3.5

See Also:

ClassModel

Method Summary

Modifier and Type	Method and Description
ClassModelBuilder<T>	annotations(List<Annotation> annotations) Sets the annotations for the model
ClassModel<T>	build() Creates a new ClassModel instance based on the mapping data provided.
ClassModelBuilder<T>	conventions(List<Convention> conventions) Sets the conventions to apply to the model
ClassModelBuilder<T>	discriminator(String discriminator) Sets the discriminator to be used when storing instances of the modeled type
ClassModelBuilder<T>	discriminatorKey(String discriminatorKey) Sets the discriminator key to be used when storing instances of the modeled type
ClassModelBuilder<T>	enableDiscriminator(boolean discriminatorEnabled) Enables or disables the use of a discriminator when serializing
List<Annotation>	getAnnotations()
List<Convention>	getConventions()
String	getDiscriminator()
String	getDiscriminatorKey()
FieldModelBuilder<?>	getField(String name) Gets a field by the given name.
List<FieldModelBuilder<?>>	getFields()
String	getIdField()
InstanceCreatorFactory<T>	getInstanceCreatorFactory()
Class<T>	getType()
ClassModelBuilder<T>	idField(String idField) Designates a field as the _id field for this type.
ClassModelBuilder<T>	instanceCreatorFactory(InstanceCreatorFactory<T> instanceCreatorFactory) Sets the InstanceCreatorFactory for the ClassModel
boolean	removeField(String name) Remove a field from the builder
String	toString()
ClassModelBuilder<T>	type(Class<T> type) Sets the type of the model
Boolean	useDiscriminator()

Methods inherited from class java.lang.Object

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

Method Detail

instanceCreatorFactory

public ClassModelBuilder<T> instanceCreatorFactory(InstanceCreatorFactory<T> instanceCreatorFactory)

Sets the InstanceCreatorFactory for the ClassModel

Parameters:

instanceCreatorFactory - the InstanceCreatorFactory

Returns:

this

getInstanceCreatorFactory

public InstanceCreatorFactory<T> getInstanceCreatorFactory()

Returns:

the InstanceCreatorFactory for the ClassModel

type

public ClassModelBuilder<T> type(Class<T> type)

Sets the type of the model

Parameters:

type - the type of the class

Returns:

the builder to configure the class being modeled

getType

public Class<T> getType()

Returns:

the type if set or null

conventions

public ClassModelBuilder<T> conventions(List<Convention> conventions)

Sets the conventions to apply to the model

Parameters:

conventions - a list of conventions

Returns:

this

getConventions

public List<Convention> getConventions()

Returns:

the conventions o apply to the model

annotations

public ClassModelBuilder<T> annotations(List<Annotation> annotations)

Sets the annotations for the model

Parameters:

annotations - a list of annotations

Returns:

this

getAnnotations

public List<Annotation> getAnnotations()

Returns:

the annotations on the modeled type if set or null

discriminator

public ClassModelBuilder<T> discriminator(String discriminator)

Sets the discriminator to be used when storing instances of the modeled type

Parameters:

discriminator - the discriminator value

Returns:

this

getDiscriminator

public String getDiscriminator()

Returns:

the discriminator to be used when storing instances of the modeled type or null if not set

discriminatorKey

public ClassModelBuilder<T> discriminatorKey(String discriminatorKey)

Sets the discriminator key to be used when storing instances of the modeled type

Parameters:

discriminatorKey - the discriminator key value

Returns:

this

getDiscriminatorKey

public String getDiscriminatorKey()

Returns:

the discriminator key to be used when storing instances of the modeled type or null if not set

enableDiscriminator

public ClassModelBuilder<T> enableDiscriminator(boolean discriminatorEnabled)

Enables or disables the use of a discriminator when serializing

Parameters:

discriminatorEnabled - true to enable the use of a discriminator

Returns:

this

useDiscriminator

public Boolean useDiscriminator()

Returns:

true if a discriminator should be used when serializing, otherwise false

idField

public ClassModelBuilder<T> idField(String idField)

Designates a field as the _id field for this type. If another field is currently marked as the _id field, that setting is cleared in favor of the named field.

Parameters:

idField - the FieldModel field name to use for the _id field

Returns:

this

getIdField

public String getIdField()

Returns:

the designated _id field for this type or null if not set

removeField

public boolean removeField(String name)

Remove a field from the builder

Parameters:

name - the actual field name in the POJO and not the documentFieldName.

Returns:

returns true if the field matched and was removed

getField

public FieldModelBuilder<?> getField(String name)

Gets a field by the given name.

Note: Searches against the actual field name in the POJO and not the documentFieldName.

Parameters:

name - the name of the field to find.

Returns:

the field or null if the field is not found

getFields

public List<FieldModelBuilder<?>> getFields()

Returns:

the fields on the modeled type

build

public ClassModel<T> build()

Creates a new ClassModel instance based on the mapping data provided.

Returns:

the new instance

toString

public String toString()

Overrides:

toString in class Object