org.bson.codecs.pojo

Class FieldModelBuilder<T>

java.lang.Object

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

Type Parameters:

T - the type of the field

public final class FieldModelBuilder<T>
extends Object

A builder for programmatically creating FieldModels.

Since:

3.5

See Also:

FieldModel

Method Summary

Modifier and Type	Method and Description
FieldModelBuilder<T>	annotations(List<Annotation> annotations) Sets the annotations
FieldModel<T>	build() Creates the FieldModel from the FieldModelBuilder.
FieldModelBuilder<T>	codec(Codec<T> codec) Sets a custom codec for the field
FieldModelBuilder<T>	discriminatorEnabled(boolean discriminatorEnabled) Enables or disables the use of a discriminator when serializing
FieldModelBuilder<T>	documentFieldName(String documentFieldName) Sets the document field name as it will be stored in the database.
FieldModelBuilder<T>	fieldAccessor(FieldAccessor<T> fieldAccessor) Sets the fieldAccessor
FieldModelBuilder<T>	fieldSerialization(FieldSerialization<T> fieldSerialization) Sets the FieldSerialization checker
List<Annotation>	getAnnotations() Returns the annotations
String	getDocumentFieldName()
FieldAccessor<T>	getFieldAccessor() Returns the fieldAccessor
String	getFieldName()
FieldSerialization<T>	getFieldSerialization()
Boolean	isDiscriminatorEnabled()
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

getFieldName

public String getFieldName()

Returns:

the field name

getDocumentFieldName

public String getDocumentFieldName()

Returns:

the field name

documentFieldName

public FieldModelBuilder<T> documentFieldName(String documentFieldName)

Sets the document field name as it will be stored in the database.

Parameters:

documentFieldName - the document field name

Returns:

this

codec

public FieldModelBuilder<T> codec(Codec<T> codec)

Sets a custom codec for the field

Parameters:

codec - the custom codec for the field

Returns:

this

fieldSerialization

public FieldModelBuilder<T> fieldSerialization(FieldSerialization<T> fieldSerialization)

Sets the FieldSerialization checker

Parameters:

fieldSerialization - checks if a field should be serialized

Returns:

this

getFieldSerialization

public FieldSerialization<T> getFieldSerialization()

Returns:

the FieldSerialization checker

getAnnotations

public List<Annotation> getAnnotations()

Returns the annotations

Returns:

the annotations

annotations

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

Sets the annotations

Parameters:

annotations - the annotations

Returns:

this

isDiscriminatorEnabled

public Boolean isDiscriminatorEnabled()

Returns:

true or false if a discriminator should be used when serializing or null if not set

discriminatorEnabled

public FieldModelBuilder<T> discriminatorEnabled(boolean discriminatorEnabled)

Enables or disables the use of a discriminator when serializing

Parameters:

discriminatorEnabled - the useDiscriminator value

Returns:

this

getFieldAccessor

public FieldAccessor<T> getFieldAccessor()

Returns the fieldAccessor

Returns:

the fieldAccessor

fieldAccessor

public FieldModelBuilder<T> fieldAccessor(FieldAccessor<T> fieldAccessor)

Sets the fieldAccessor

Parameters:

fieldAccessor - the fieldAccessor

Returns:

this

build

public FieldModel<T> build()

Creates the FieldModel from the FieldModelBuilder.

Returns:

the fieldModel

toString

public String toString()

Overrides:

toString in class Object