org.bson.codecs.pojo

Class FieldModel<T>

java.lang.Object

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

Type Parameters:

T - the type of the field that the FieldModel represents.

public final class FieldModel<T>
extends Object

Represents a field on a class and stores various metadata such as generic parameters

Since:

3.5

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
Codec<T>	getCodec()
String	getDocumentFieldName()
FieldAccessor<T>	getFieldAccessor()
String	getFieldName()
org.bson.codecs.pojo.TypeData<T>	getTypeData()
int	hashCode()
boolean	shouldSerialize(T value) Returns true if the value should be serialized.
String	toString()
Boolean	useDiscriminator()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

shouldSerialize

public boolean shouldSerialize(T value)

Returns true if the value should be serialized.

Parameters:

value - the value to check

Returns:

true if the value should be serialized.

getFieldAccessor

public FieldAccessor<T> getFieldAccessor()

Returns:

the field accessor

getFieldName

public String getFieldName()

Returns:

the unmapped field name as defined in the source file.

getDocumentFieldName

public String getDocumentFieldName()

Returns:

the name of the mapped field

getTypeData

public org.bson.codecs.pojo.TypeData<T> getTypeData()

Returns:

the type data for the field

getCodec

public Codec<T> getCodec()

Returns:

the custom codec to use if set or null

useDiscriminator

public Boolean useDiscriminator()

Returns:

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

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object